1. class
  2. phpbb
  3. \
  4. cron
  5. \
  6. task
  7. \
  8. core
  9. \
  10. queue

queue

class queue extends base

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

Properties

protected $config

var config
protected $queue

var \phpbb\messenger\queue
protected $queue_cache_file

var string

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(config $config, queue $queue, string $queue_cache_file)

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 63
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 76
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 39
__construct(config $config, queue $queue, string $queue_cache_file)

Constructor.

Parameters

config $config

The config
queue $queue

The messenger file queue object
string $queue_cache_file

The messenger file queue cache filename

at line 51
null run()

Runs this cron task.

Return Value

null