MediaWiki
master
|
Job queue task description base code. More...
Public Member Functions | |
__construct ( $type, array $params, array $opts=[], PageReference $page=null) | |
getDeduplicationInfo () | |
Subclasses may need to override this to make duplication detection work. More... | |
getParams () | |
getReleaseTimestamp () | |
getRootJobParams () | |
getType () | |
hasRootJobParams () | |
ignoreDuplicates () | |
isRootJob () | |
toSerializableArray () | |
Static Public Member Functions | |
static | newFromArray (array $map) |
Protected Member Functions | |
validateParams (array $params) | |
Protected Attributes | |
array | $opts |
PageReference | $page |
array | $params |
Array of job parameters or false if none. More... | |
string | $type |
Job queue task description base code.
Example usage:
Definition at line 42 of file JobSpecification.php.
JobSpecification::__construct | ( | $type, | |
array | $params, | ||
array | $opts = [] , |
||
PageReference | $page = null |
||
) |
string | $type | |
array | $params | Map of key/values |
array | $opts | Map of key/values 'removeDuplicates' key - whether to remove duplicate jobs 'removeDuplicatesIgnoreParams' key - array with parameters to ignore for deduplication |
PageReference | null | $page |
Definition at line 63 of file JobSpecification.php.
References $opts, $page, $params, $type, MediaWiki\Page\PageReference\getDBkey(), MediaWiki\Page\PageReference\getNamespace(), NS_SPECIAL, and validateParams().
JobSpecification::getDeduplicationInfo | ( | ) |
Subclasses may need to override this to make duplication detection work.
The resulting map conveys everything that makes the job unique. This is only checked if ignoreDuplicates() returns true, meaning that duplicate jobs are supposed to be ignored.
Implements IJobSpecification.
Definition at line 119 of file JobSpecification.php.
References getParams(), and getType().
JobSpecification::getParams | ( | ) |
Implements IJobSpecification.
Definition at line 105 of file JobSpecification.php.
References $params.
Referenced by getDeduplicationInfo().
JobSpecification::getReleaseTimestamp | ( | ) |
Implements IJobSpecification.
Definition at line 109 of file JobSpecification.php.
References wfTimestampOrNull().
JobSpecification::getRootJobParams | ( | ) |
Implements IJobSpecification.
Definition at line 140 of file JobSpecification.php.
JobSpecification::getType | ( | ) |
Implements IJobSpecification.
Definition at line 101 of file JobSpecification.php.
References $type.
Referenced by getDeduplicationInfo().
JobSpecification::hasRootJobParams | ( | ) |
Implements IJobSpecification.
Definition at line 147 of file JobSpecification.php.
Referenced by isRootJob().
JobSpecification::ignoreDuplicates | ( | ) |
Implements IJobSpecification.
Definition at line 115 of file JobSpecification.php.
JobSpecification::isRootJob | ( | ) |
Implements IJobSpecification.
Definition at line 152 of file JobSpecification.php.
References hasRootJobParams().
|
static |
array | $map | Field/value map |
Definition at line 179 of file JobSpecification.php.
JobSpecification::toSerializableArray | ( | ) |
Definition at line 161 of file JobSpecification.php.
References $opts, $params, $type, and wfDeprecated().
|
protected |
array | $params |
Definition at line 91 of file JobSpecification.php.
References $params.
Referenced by __construct().
|
protected |
Definition at line 53 of file JobSpecification.php.
Referenced by __construct(), and toSerializableArray().
|
protected |
Definition at line 50 of file JobSpecification.php.
Referenced by __construct().
|
protected |
Array of job parameters or false if none.
Definition at line 47 of file JobSpecification.php.
Referenced by __construct(), getParams(), toSerializableArray(), and validateParams().
|
protected |
Definition at line 44 of file JobSpecification.php.
Referenced by __construct(), getType(), and toSerializableArray().