phpBB API Documentation
Class

phpbb\cron\task\core\prune_all_forums

class prune_all_forums extends base

Prune all forums cron task.

It is intended to be invoked from system cron. This task will find all forums for which pruning is enabled, and will prune all forums as necessary.

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.

from base
__construct(string $phpbb_root_path, string $php_ext, config $config, driver_interface $db)

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

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

This cron task will only run when system cron is utilised.

Return Value

bool

in base at line 68
public bool should_run()

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

Return Value

bool

at line 38
public __construct(string $phpbb_root_path, string $php_ext, config $config, driver_interface $db)

Constructor.

Parameters

string $phpbb_root_path The root path
string $php_ext The PHP file extension
config $config The config
driver_interface $db The db connection

at line 51
public null run()

Runs this cron task.

Return Value

null