Class to both describe a background job and handle jobs. More...

Inheritance diagram for Job:

Collaboration diagram for Job:

Public Member Functions
	__construct ($command, $title, $params=false, $id=0)
	allowRetries ()
	getDeduplicationInfo ()
	Subclasses may need to override this to make duplication detection work.
	getId ()
	getLastError ()
	getParams ()
	getReleaseTimestamp ()
	getRootJobParams ()
	getTitle ()
	getType ()
	hasRootJobParams ()
	ignoreDuplicates ()
	insert ()
	Insert a single job into the queue.
	run ()
	Run the job.
	toString ()
Static Public Member Functions
static	batchInsert ($jobs)
	Batch-insert a group of jobs into the queue.
static	factory ($command, Title $title, $params=false, $id=0)
	Create the appropriate object to handle a specific job.
static	newRootJobParams ($key)
static	pop ()
	Pop a job off the front of the queue.
static	pop_type ($type)
	Pop a job of a certain type.
static	safeBatchInsert ($jobs)
	Insert a group of jobs into the queue.
Public Attributes
	$command
	$error
	$id
Array	$metadata = array()
	Additional queue metadata *.
	$params
	$removeDuplicates
Title	$title
Protected Member Functions
	setLastError ($error)

Detailed Description

Class to both describe a background job and handle jobs.

The queue aspects of this class are now deprecated.

Definition at line 30 of file Job.php.

Constructor & Destructor Documentation

Job::__construct	(	$	command,
		$	title,
		$	params = `false`,
		$	id = `0`
	)

Parameters:

$command
$title
$params	array\|bool
$id	int

Definition at line 140 of file Job.php.

Member Function Documentation

Job::allowRetries ( )

Returns:: bool Whether this job can be retried on failure by job runners

Since:: 1.21

Reimplemented in PublishStashedFileJob, and AssembleUploadChunksJob.

Definition at line 199 of file Job.php.

static Job::batchInsert ( $ jobs ) [static]

Batch-insert a group of jobs into the queue.

This will be wrapped in a transaction with a forced commit.

This may add duplicate at insert time, but they will be removed later on, when the first one is popped.

Parameters:

array $jobs of Job objects

Returns:: bool

Deprecated:: since 1.21

Definition at line 87 of file Job.php.

static Job::factory	(	$	command,
		Title $	title,
		$	params = `false`,
		$	id = `0`
	)		`[static]`

Create the appropriate object to handle a specific job.

Parameters:

string	$command	Job command
	$title	Title: Associated title
array \| bool	$params	Job parameters
int	$id	Job identifier

Exceptions:

MWException

Returns:: Job

Definition at line 67 of file Job.php.

Referenced by DoubleRedirectJob\run().

Job::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

Since:: 1.21

Reimplemented in RefreshLinksJob2, PublishStashedFileJob, AssembleUploadChunksJob, and RefreshLinksJob.

Definition at line 212 of file Job.php.

Job::getId ( )

Returns:: integer May be 0 for jobs stored outside the DB

Deprecated:: since 1.22

Definition at line 153 of file Job.php.

Job::getLastError ( )

Definition at line 316 of file Job.php.

Job::getParams ( )

Returns:: array

Definition at line 174 of file Job.php.

Referenced by DuplicateJob\newFromJob().

Job::getReleaseTimestamp ( )

Returns:: integer|null UNIX timestamp to delay running this job until, otherwise null

Since:: 1.22

Definition at line 182 of file Job.php.

Job::getRootJobParams ( )

See also:: JobQueue::deduplicateRootJob()

Returns:: Array

Since:: 1.21

Definition at line 247 of file Job.php.

Referenced by RefreshLinksJob2\getSingleTitleJobs(), and RefreshLinksJob2\run().

Job::getTitle ( )

Returns:: Title

Definition at line 167 of file Job.php.

Referenced by DuplicateJob\newFromJob().

Job::getType ( )

Returns:: string

Definition at line 160 of file Job.php.

Referenced by DuplicateJob\newFromJob().

Job::hasRootJobParams ( )

See also:: JobQueue::deduplicateRootJob()

Returns:: bool

Since:: 1.22

Definition at line 263 of file Job.php.

Job::ignoreDuplicates ( )

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

Definition at line 191 of file Job.php.

Job::insert ( )

Insert a single job into the queue.

Returns:: bool true on success

Deprecated:: since 1.21

Definition at line 273 of file Job.php.

static Job::newRootJobParams ( $ key ) [static]

See also:: JobQueue::deduplicateRootJob()

Parameters:

string $key A key that identifies the task

Returns:: Array

Since:: 1.21

Definition at line 235 of file Job.php.

Referenced by HTMLCacheUpdate\doUpdate(), and JobQueueTest\testRootDeduplication().

static Job::pop ( ) [static]

Pop a job off the front of the queue.

This is subject to $wgJobTypesExcludedFromDefaultQueue.

Returns:: Job or false if there's no jobs

Deprecated:: since 1.21

Definition at line 126 of file Job.php.

static Job::pop_type ( $ type ) [static]

Pop a job of a certain type.

This tries less hard than pop() to actually find a job; it may be adversely affected by concurrent job runners.

Parameters:

$type string

Returns:: Job|bool Returns false if there are no jobs

Deprecated:: since 1.21

Definition at line 115 of file Job.php.

Job::run ( ) [abstract]

Run the job.

Returns:: boolean success

Reimplemented in RefreshLinksJob2, DoubleRedirectJob, HTMLCacheUpdateJob, NullJob, DuplicateJob, UploadFromUrlJob, RefreshLinksJob, AssembleUploadChunksJob, EmaillingJob, EnotifNotifyJob, and PublishStashedFileJob.

static Job::safeBatchInsert ( $ jobs ) [static]

Insert a group of jobs into the queue.

Same as batchInsert() but does not commit and can thus be rolled-back as part of a larger transaction. However, large batches of jobs can cause slave lag.

Parameters:

array $jobs of Job objects