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 ()
	getRootJobParams ()
	getTitle ()
	getType ()
	hasRootJobParams ()
	ignoreDuplicates ()
	isRootJob ()

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 RefreshLinksJob, CategoryMembershipChangeJob, Job, JobSpecification, PublishStashedFileJob, and AssembleUploadChunksJob.

Referenced by JobQueueRedis\getNewJobFields(), and JobQueueDB\insertFields().

IJobSpecification::getParams

(

)

Returns

array

Implemented in JobSpecification, and Job.

Referenced by JobQueueDB\doDeduplicateRootJob(), JobQueueRedis\getNewJobFields(), JobQueueDB\insertFields(), and JobQueueMemory\jobFromSpecInternal().

IJobSpecification::getReleaseTimestamp

(

)

Returns

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

Implemented in JobSpecification, and Job.

Referenced by JobQueueRedis\getNewJobFields().

IJobSpecification::getRootJobParams

(

)

See also

JobQueue::deduplicateRootJob()

Returns

array

Since

1.26

Implemented in Job, and JobSpecification.

Referenced by JobQueueFederated\doDeduplicateRootJob(), JobQueueRedis\doDeduplicateRootJob(), and JobQueue\doDeduplicateRootJob().

IJobSpecification::getTitle

(

)

Returns

Title Descriptive title (this can simply be informative)

Implemented in JobSpecification, and Job.

Referenced by JobQueueRedis\getNewJobFields(), JobQueueDB\insertFields(), and JobQueueMemory\jobFromSpecInternal().

IJobSpecification::getType

(

)

Returns

string Job type

Implemented in JobSpecification, and Job.

Referenced by JobQueue\deduplicateRootJob(), JobQueueRedis\getNewJobFields(), JobQueueDB\insertFields(), and JobQueueMemory\jobFromSpecInternal().

IJobSpecification::hasRootJobParams

(

)

See also

JobQueue::deduplicateRootJob()

Returns

bool

Since

1.22

Implemented in Job, and JobSpecification.

Referenced by JobQueueRedis\doDeduplicateRootJob(), and JobQueue\doDeduplicateRootJob().

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().

IJobSpecification::isRootJob

(

)

See also

JobQueue::deduplicateRootJob()

Returns

bool Whether this is job is a root job

Implemented in Job, and JobSpecification.

---

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

• includes/jobqueue/JobSpecification.php