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)
	getId ()
	getLastError ()
	getParams ()
	getTitle ()
	getType ()
	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	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
	$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 136 of file Job.php.

Member Function Documentation

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:

$jobs array of Job objects

Deprecated:: 1.21

Definition at line 84 of file Job.php.

Referenced by DoubleRedirectJob\fixRedirects(), FixDoubleRedirects\queueJobs(), LinksUpdate\queueRecursiveJobs(), and RefreshLinksJob2\run().

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

Create the appropriate object to handle a specific job.

Parameters:

$command	String: Job command
$title	Title: Associated title
$params	Array\|bool: Job parameters
$id	Int: Job identifier

Exceptions:

MWException

Returns:: Job

Definition at line 65 of file Job.php.

Referenced by DoubleRedirectJob\run().

Job::getId ( )

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

Definition at line 148 of file Job.php.

Referenced by JobQueueDB\doAck().

Job::getLastError ( )

Definition at line 218 of file Job.php.

Job::getParams ( )

Returns:: array

Definition at line 169 of file Job.php.

Referenced by JobQueueDB\insertFields().

Job::getTitle ( )

Returns:: Title

Definition at line 162 of file Job.php.

Referenced by JobQueueDB\insertFields().

Job::getType ( )

Returns:: string

Definition at line 155 of file Job.php.

Referenced by JobQueueGroup\ack(), JobQueue\ack(), and JobQueueDB\insertFields().

Job::ignoreDuplicates ( )

Returns:: bool

Definition at line 176 of file Job.php.

Job::insert ( )

Insert a single job into the queue.

Returns:: bool true on success

Deprecated:: 1.21

Definition at line 185 of file Job.php.

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

Definition at line 122 of file Job.php.

Referenced by UploadFromUrlTest\doAsyncUpload(), UploadFromUrlTest\testClearQueue(), UploadFromUrlTest\testLeaveMessage(), UploadFromUrlTest\testSetupUrlDownload(), and UploadFromUrlTest\testSyncDownload().

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

Deprecated:: 1.21

Definition at line 111 of file Job.php.

Job::run ( ) [abstract]

Run the job.

Returns:: boolean success

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

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:

$jobs array of Job objects