IJobSpecification Interface Reference

Job queue task description interface. More...

Inheritance diagram for IJobSpecification:

Public Member Functions
	getDeduplicationInfo ()
	Subclasses may need to override this to make duplication detection work. More...
	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

getDeduplicationInfo()

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.

getParams()

IJobSpecification::getParams

(

)

Returns

array

Implemented in Job, and JobSpecification.

getReleaseTimestamp()

IJobSpecification::getReleaseTimestamp

(

)

Returns

int|null UNIX timestamp to delay running this job until, otherwise null

Implemented in Job, and JobSpecification.

getTitle()

IJobSpecification::getTitle

(

)

Returns

Title Descriptive title (this can simply be informative)

Implemented in Job, and JobSpecification.

getType()

IJobSpecification::getType

(

)

Returns

string Job type

Implemented in Job, and JobSpecification.

Referenced by JobQueueDB\insertFields().

ignoreDuplicates()

IJobSpecification::ignoreDuplicates

(

)

Returns

bool Whether only one of each identical set of jobs should be run

Implemented in Job, and JobSpecification.

---

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

• includes/jobqueue/JobSpecification.php