phpBB API Documentation
Class

phpbb\cron\task\core\queue

class queue extends base

Queue cron task.

Sends email and jabber messages queued by other scripts.

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

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

Queue task is only run if the email queue (file) exists.

Return Value

bool

at line 74
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 queue runs is specified in board configuration.

Return Value

bool

at line 32
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 44
public null run()

Runs this cron task.

Return Value

null