MediaWiki  REL1_24
Public Member Functions
IJobSpecification Interface Reference
JobQueue

Job queue task description interface. More...

Inheritance diagram for IJobSpecification:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 getDeduplicationInfo ()
 Subclasses may need to override this to make duplication detection work.
 getParams ()
 getReleaseTimestamp ()
 getTitle ()
 getType ()
 ignoreDuplicates ()

Detailed Description

Job queue task description interface.

Since:
1.23

Definition at line 30 of file JobSpecification.php.

Member Function Documentation

IJobSpecification::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.

Returns:
array Map of key/values

Implemented in Job, RefreshLinksJob, JobSpecification, PublishStashedFileJob, RefreshLinksJob2, and AssembleUploadChunksJob.

Referenced by JobQueueRedis\getNewJobFields().

IJobSpecification::getParams ( )
Returns:
array

Implemented in Job, and JobSpecification.

Referenced by JobQueueRedis\getNewJobFields().

IJobSpecification::getReleaseTimestamp ( )
Returns:
int|null UNIX timestamp to delay running this job until, otherwise null

Implemented in Job, and JobSpecification.

Referenced by JobQueueRedis\getNewJobFields().

IJobSpecification::getTitle ( )
Returns:
Title Descriptive title (this can simply be informative)

Implemented in Job, and JobSpecification.

Referenced by JobQueueRedis\getNewJobFields().

IJobSpecification::getType ( )
Returns:
string Job type

Implemented in Job, and JobSpecification.

Referenced by JobQueueRedis\getNewJobFields().

IJobSpecification::ignoreDuplicates ( )
Returns:
bool Whether only one of each identical set of jobs should be run

Implemented in Job, and JobSpecification.

Referenced by JobQueueRedis\getNewJobFields().

The documentation for this interface was generated from the following file: