MediaWiki master
|
Job queue task description base code. More...
Inherits IJobSpecification.
Public Member Functions | |
__construct ( $type, array $params, array $opts=[], PageReference $page=null) | |
getDeduplicationInfo () | |
Subclasses may need to override this to make duplication detection work. | |
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. | |
string | $type |
Job queue task description base code.
Example usage:
Definition at line 41 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 62 of file JobSpecification.php.
References $params, 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 121 of file JobSpecification.php.
References getParams(), and getType().
JobSpecification::getParams | ( | ) |
Implements IJobSpecification.
Definition at line 107 of file JobSpecification.php.
References $params.
Referenced by getDeduplicationInfo().
JobSpecification::getReleaseTimestamp | ( | ) |
Implements IJobSpecification.
Definition at line 111 of file JobSpecification.php.
References wfTimestampOrNull().
JobSpecification::getRootJobParams | ( | ) |
Implements IJobSpecification.
Definition at line 144 of file JobSpecification.php.
JobSpecification::getType | ( | ) |
Implements IJobSpecification.
Definition at line 103 of file JobSpecification.php.
Referenced by getDeduplicationInfo().
JobSpecification::hasRootJobParams | ( | ) |
Implements IJobSpecification.
Definition at line 151 of file JobSpecification.php.
Referenced by isRootJob().
JobSpecification::ignoreDuplicates | ( | ) |
Implements IJobSpecification.
Definition at line 117 of file JobSpecification.php.
JobSpecification::isRootJob | ( | ) |
Implements IJobSpecification.
Definition at line 156 of file JobSpecification.php.
References hasRootJobParams().
|
static |
array | $map | Field/value map |
Definition at line 183 of file JobSpecification.php.
JobSpecification::toSerializableArray | ( | ) |
Definition at line 165 of file JobSpecification.php.
References $params, and wfDeprecated().
|
protected |
array | $params |
Definition at line 93 of file JobSpecification.php.
References $params, and validateParams().
Referenced by __construct(), and validateParams().
|
protected |
Definition at line 52 of file JobSpecification.php.
|
protected |
Definition at line 49 of file JobSpecification.php.
|
protected |
Array of job parameters or false if none.
Definition at line 46 of file JobSpecification.php.
|
protected |
Definition at line 43 of file JobSpecification.php.