class queue extends base

Queue cron task. Sends email and jabber messages queued by other scripts.

Properties

protected $phpbb_root_path
protected $php_ext
protected $cache_dir
protected $config

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, string $cache_dir)

Constructor.

null
run()

Runs this cron task.

Details

in base at line 34
string get_name()

Returns the name of the task.

Return Value

string

Name of wrapped task.

in base at line 44
set_name(string $name)

Sets the name of the task.

Parameters

string $name

The task name

at line 64
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 77
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 34
__construct(string $phpbb_root_path, string $php_ext, config $config, string $cache_dir)

Constructor.

Parameters

string $phpbb_root_path

The root path

string $php_ext

PHP file extension

config $config

The config

string $cache_dir

phpBB cache directory

at line 47
null run()

Runs this cron task.

Return Value

null