EnqueueJob Class Reference

Router job that takes jobs and enqueues them to their proper queues. More...

Inheritance diagram for EnqueueJob:

Collaboration diagram for EnqueueJob:

Public Member Functions
	__construct (array $params)
	Callers should use the factory methods instead.
	run ()
	Run the job.
Public Member Functions inherited from Job
	__construct ( $command, $params=null)
	allowRetries ()
	Returns bool Whether this job can be retried on failure by job runners Since 1.21
	getDeduplicationInfo ()
	Subclasses may need to override this to make duplication detection work.
	getLastError ()
	Returns string
	getMetadata ( $field=null)
	getParams ()
	Returns array Parameters that specify sources, targets, and options for execution
	getQueuedTimestamp ()
	getReadyTimestamp ()
	Returns int|null UNIX timestamp of when the job was runnable, or null Since 1.26
	getReleaseTimestamp ()
	getRequestId ()
	Returns string|null Id of the request that created this job. Follows jobs recursively, allowing to track the id of the request that started a job when jobs insert jobs which insert other jobs. Since 1.27
	getRootJobParams ()
	getTitle ()
	getType ()
	Returns string Job type that defines what sort of changes this job makes
	hasExecutionFlag ( $flag)
	Parameters int $flag JOB_* class constant Returns bool Since 1.31
	hasRootJobParams ()
	ignoreDuplicates ()
	Whether the queue should reject insertion of this job if a duplicate exists.
	isRootJob ()
	setMetadata ( $field, $value)
	teardown ( $status)
	toString ()
	Returns string Debugging string describing the job
	workItemCount ()
Public Member Functions inherited from RunnableJob
	tearDown ( $status)
	Do any final cleanup after run(), deferred updates, and all DB commits happen.

Static Public Member Functions
static	newFromJobsByDomain (array $jobsByDomain)
static	newFromJobsByWiki (array $jobsByWiki)
static	newFromLocalJobs ( $jobs)
Static Public Member Functions inherited from Job
static	factory ( $command, $params=[])
	Create the appropriate object to handle a specific job.
static	newRootJobParams ( $key)
	Get "root job" parameters for a task.

Additional Inherited Members
Public Attributes inherited from Job
string	$command
array	$metadata = []
	Additional queue metadata.
array	$params
	Array of job parameters.
Protected Member Functions inherited from Job
	addTeardownCallback ( $callback)
	setLastError ( $error)
Protected Attributes inherited from Job
string	$error
	Text for error that occurred last.
int	$executionFlags = 0
	Bitfield of JOB_* class constants.
bool	$removeDuplicates = false
	Expensive jobs may set this to true.
callable[]	$teardownCallbacks = []
Title	$title

Detailed Description

Router job that takes jobs and enqueues them to their proper queues.

This can be used for getting sets of multiple jobs or sets of jobs intended for multiple queues to be inserted more robustly. This is a single job that, upon running, enqueues the wrapped jobs. If some of those fail to enqueue then the EnqueueJob will be retried. Due to the possibility of duplicate enqueues, the wrapped jobs should be idempotent.

Since

1.25

Definition at line 37 of file EnqueueJob.php.

Constructor & Destructor Documentation

__construct()

EnqueueJob::__construct

(

array

$params

)

Callers should use the factory methods instead.

Parameters

array

$params

Job parameters

Implements GenericParameterJob.

Definition at line 43 of file EnqueueJob.php.

Member Function Documentation

newFromJobsByDomain()

static EnqueueJob::newFromJobsByDomain ( array $jobsByDomain )

static

Parameters

array

$jobsByDomain

Map of (wiki => JobSpecification list)

Returns

EnqueueJob

Definition at line 63 of file EnqueueJob.php.

References $job.

newFromJobsByWiki()

static EnqueueJob::newFromJobsByWiki ( array $jobsByWiki )

static

Parameters

array

$jobsByWiki

Returns

EnqueueJob

Deprecated

Since 1.33; use newFromJobsByDomain(). Hard deprecated since 1.39.

Definition at line 92 of file EnqueueJob.php.

References wfDeprecated().

newFromLocalJobs()

static EnqueueJob::newFromLocalJobs ( $jobs )

static

Parameters

JobSpecification | JobSpecification[]

$jobs

Returns

EnqueueJob

Definition at line 51 of file EnqueueJob.php.

run()

EnqueueJob::run

(

)

Run the job.

Returns

bool Success

Implements RunnableJob.

Definition at line 97 of file EnqueueJob.php.

---

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

• includes/jobqueue/jobs/EnqueueJob.php