1. class
  2. Symbiote
  3. \
  4. QueuedJobs
  5. \
  6. Tasks
  7. \
  8. Engines
  9. \
  10. DoormanRunner

DoormanRunner

class DoormanRunner extends BaseRunner implements TaskRunnerEngine (View source)

Runs all jobs through the doorman engine

Traits

Configurable

Provides extensions to this object to integrate it with standard config API methods.

Config options

max_ticks int

How many ticks are executed per one runQueue method call set 0 for unlimited ticks
tick_interval int

How many seconds between ticks
child_runner string

Name of the dev task used to run the child process

Properties

protected string[] $defaultRules

Methods

public
QueuedJobService
getService()

Returns an instance of the QueuedJobService.

from  BaseRunner
protected
writeLogLine(string $line, null|string $prefix = null)

Write in a format expected by the output medium (CLI/HTML).

from  BaseRunner
protected
logDescriptorStatus(bool|null|QueuedJobDescriptor $descriptor, string $queue)

Logs the status of the queued job descriptor.

from  BaseRunner
public
listJobs()

Logs the number of current jobs per queue

from  BaseRunner
public static 
Config_ForClass
config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

from  Configurable
public
mixed
stat(string $name) deprecated

Get inherited config value

from  Configurable
public
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

from  Configurable
public
$this
set_stat(string $name, mixed $value) deprecated

Update the config value for a given property

from  Configurable
public
$this
setDefaultRules(array $rules)

Assign default rules for this task

public
array
getDefaultRules()

No description

public
runQueue(string $queue)

Run tasks on the given queue

protected
int
getMaxTicks()

Override this method if you need a dynamic value for the configuration, for example CMS setting

protected
int
getTickInterval()

Override this method if you need a dynamic value for the configuration, for example CMS setting

protected
string
getChildRunner()

Override this method if you need a dynamic value for the configuration, for example CMS setting

protected
QueuedJobDescriptor|null
getNextJobDescriptorWithoutMutex(string $queue) deprecated

No description

Details

in BaseRunner at line 23
QueuedJobService getService()

Returns an instance of the QueuedJobService.

Return Value

QueuedJobService

in BaseRunner at line 34
protected writeLogLine(string $line, null|string $prefix = null)

Write in a format expected by the output medium (CLI/HTML).

Parameters

string $line

Line to be written out, without the newline character.
null|string $prefix

in BaseRunner at line 53
protected logDescriptorStatus(bool|null|QueuedJobDescriptor $descriptor, string $queue)

Logs the status of the queued job descriptor.

Parameters

bool|null|QueuedJobDescriptor $descriptor
string $queue

in BaseRunner at line 71
listJobs()

Logs the number of current jobs per queue

in Configurable at line 20
static Config_ForClass config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

Return Value

Config_ForClass

in Configurable at line 32
mixed stat(string $name) deprecated

deprecated 5.0 Use ->config()->get() instead

Get inherited config value

Parameters

string $name

Return Value

mixed

in Configurable at line 44
mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

in Configurable at line 57
$this set_stat(string $name, mixed $value) deprecated

deprecated 5.0 Use ->config()->set() instead

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

at line 59
$this setDefaultRules(array $rules)

Assign default rules for this task

Parameters

array $rules

Return Value

$this

at line 68
array getDefaultRules()

No description

Return Value

array

List of rules

at line 78
runQueue(string $queue)

Run tasks on the given queue

Parameters

string $queue

at line 174
protected int getMaxTicks()

Override this method if you need a dynamic value for the configuration, for example CMS setting

Return Value

int

at line 184
protected int getTickInterval()

Override this method if you need a dynamic value for the configuration, for example CMS setting

Return Value

int

at line 194
protected string getChildRunner()

Override this method if you need a dynamic value for the configuration, for example CMS setting

Return Value

string

at line 204
protected QueuedJobDescriptor|null getNextJobDescriptorWithoutMutex(string $queue) deprecated

deprecated 4.11.0 Use QueuedJobService::getNextPendingJob() instead

No description

Parameters

string $queue

Return Value

QueuedJobDescriptor|null