phpBB API Documentation
Class

phpbb\cron\task\core\tidy_search

class tidy_search extends base

Tidy search cron task.

Will only run when the currently selected search backend supports tidying.

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, auth $auth, config $config, driver_interface $db, user $user, dispatcher_interface $phpbb_dispatcher)

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 115
public bool is_runnable()

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

Search cron task is runnable in all normal use. It may not be runnable if the search backend implementation selected in board configuration does not exist.

Return Value

bool

at line 129
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 search tidying is specified in board configuration.

Return Value

bool

at line 76
public __construct(string $phpbb_root_path, string $php_ext, auth $auth, config $config, driver_interface $db, user $user, dispatcher_interface $phpbb_dispatcher)

Constructor.

Parameters

string $phpbb_root_path The phpBB root path
string $php_ext The PHP file extension
auth $auth The auth object
config $config The config object
driver_interface $db The database object
user $user The user object
dispatcher_interface $phpbb_dispatcher The event dispatcher object

at line 92
public null run()

Runs this cron task.

Return Value

null