phpBB API Documentation
Class

phpbb\cron\task\core\tidy_warnings

class tidy_warnings extends base

Tidy warnings cron task.

Will only run when warnings are configured to expire.

Methods

string get_name()

Returns the name of the task.

from base
set_name(string $name)

Sets the name of the task.

from base
bool is_runnable()

Returns whether this cron task can run, given current board configuration.

bool should_run()

Returns whether this cron task should run now, because enough time has passed since it was last run.

__construct(string $phpbb_root_path, string $php_ext, config $config)

Constructor.

null run()

Runs this cron task.

Details

in base at line 34
public string get_name()

Returns the name of the task.

Return Value

string Name of wrapped task.

in base at line 44
public set_name(string $name)

Sets the name of the task.

Parameters

string $name The task name

at line 62
public bool is_runnable()

Returns whether this cron task can run, given current board configuration.

If warnings are set to never expire, this cron task will not run.

Return Value

bool

at line 76
public bool should_run()

Returns whether this cron task should run now, because enough time has passed since it was last run.

The interval between warnings tidying is specified in board configuration.

Return Value

bool

at line 34
public __construct(string $phpbb_root_path, string $php_ext, config $config)

Constructor.

Parameters

string $phpbb_root_path The root path
string $php_ext PHP file extension
config $config The config

at line 46
public null run()

Runs this cron task.

Return Value

null