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

Inheritance diagram for Job:

[legend]

Collaboration diagram for Job:

[legend]

Public Member Functions
	__construct ( $command, $params=null)

	allowRetries ()

	getDeduplicationInfo ()
	Subclasses may need to override this to make duplication detection work. More...

	getLastError ()

	getMetadata ( $field=null)

	getParams ()

	getQueuedTimestamp ()

	getReadyTimestamp ()

	getReleaseTimestamp ()

	getRequestId ()

	getRootJobParams ()

	getTitle ()

	getType ()

	hasExecutionFlag ( $flag)

	hasRootJobParams ()

	ignoreDuplicates ()
	Whether the queue should reject insertion of this job if a duplicate exists. More...

	isRootJob ()

	run ()
	Run the job. More...

	setMetadata ( $field, $value)

	teardown ( $status)
	Do any final cleanup after run(), deferred updates, and all DB commits happen. More...

	toString ()

	workItemCount ()

Static Public Member Functions
static	factory ( $command, $params=[])
	Create the appropriate object to handle a specific job. More...

static	newRootJobParams ( $key)
	Get "root job" parameters for a task. More...

Public Attributes
string	$command

array	$metadata = []
	Additional queue metadata. More...

array	$params
	Array of job parameters. More...

Protected Member Functions
	addTeardownCallback ( $callback)

	setLastError ( $error)

Protected Attributes
string	$error
	Text for error that occurred last. More...

int	$executionFlags = 0
	Bitfield of JOB_* class constants. More...

bool	$removeDuplicates = false
	Expensive jobs may set this to true. More...

callable[]	$teardownCallbacks = []

Title	$title

Detailed Description

Class to both describe a background job and handle jobs.

To push jobs onto queues, use JobQueueGroup::singleton()->push();

Definition at line 30 of file Job.php.

Constructor & Destructor Documentation

◆ __construct()

Job::__construct	(	$command,
		$params = `null`
	)

Parameters

string	$command
array \| Title \| null	$params

Reimplemented in DeletePageJob, ReplaceTextJob, and CreatePdfThumbnailsJob.

Definition at line 113 of file Job.php.

References $command, $params, $title, WebRequest\getRequestId(), Title\makeTitle(), NS_SPECIAL, and title.

Member Function Documentation

◆ addTeardownCallback()

Job::addTeardownCallback ( $callback )

protected

Parameters

callable $callback A function with one parameter, the success status, which will be false if the job failed or it succeeded but the DB changes could not be committed or any deferred updates threw an exception. (This parameter was added in 1.28.)

Since: 1.27

Definition at line 355 of file Job.php.

Referenced by AssembleUploadChunksJob\run(), PublishStashedFileJob\run(), and ReplaceTextJob\run().

◆ allowRetries()

Job::allowRetries ( )

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

Since: 1.21

Reimplemented in PublishStashedFileJob, ThumbnailRenderJob, and AssembleUploadChunksJob.

Definition at line 248 of file Job.php.

◆ factory()

static Job::factory	(	$command,
		$params = `[]`
	)

static

Create the appropriate object to handle a specific job.

Parameters

string	$command	Job command
array \| Title	$params	Job parameters

Exceptions

InvalidArgumentException

Returns: Job

Definition at line 72 of file Job.php.

References $command, $handler, $job, $params, $title, $wgJobClasses, Title\makeTitle(), and NS_SPECIAL.

Referenced by JobQueueDB\doPop(), JobQueueRedis\getJobFromFields(), JobQueueRedis\getJobFromUidInternal(), JobQueueDB\getJobIterator(), JobQueueMemory\jobFromSpecInternal(), RenameuserSQL\rename(), and JobTest\testJobFactory().

◆ getDeduplicationInfo()

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

Implements IJobSpecification.

Reimplemented in RefreshLinksJob, CategoryMembershipChangeJob, HTMLCacheUpdateJob, PublishStashedFileJob, AssembleUploadChunksJob, and ClearUserWatchlistJob.

Definition at line 270 of file Job.php.

References getParams(), getTitle(), and getType().

◆ getLastError()

Job::getLastError ( )

Definition at line 433 of file Job.php.

References $error.

◆ getMetadata()

Job::getMetadata ( $field = null )

Parameters

string | null $field Metadata field or null to get all the metadata

Returns: mixed|null Value; null if missing

Since: 1.33

Definition at line 166 of file Job.php.

References $metadata.

Referenced by setMetadata().

◆ getParams()

Job::getParams ( )

Returns: array

Implements IJobSpecification.

Definition at line 157 of file Job.php.

References $params.

Referenced by getDeduplicationInfo(), and ClearUserWatchlistJob\run().

◆ getQueuedTimestamp()

Job::getQueuedTimestamp ( )

Returns: int|null UNIX timestamp of when the job was queued, or null

Since: 1.26

Definition at line 205 of file Job.php.

References wfTimestampOrNull().

Referenced by getReadyTimestamp().

◆ getReadyTimestamp()

Job::getReadyTimestamp ( )

Returns: int|null UNIX timestamp of when the job was runnable, or null

Since: 1.26

Definition at line 225 of file Job.php.

References getQueuedTimestamp(), and getReleaseTimestamp().

◆ getReleaseTimestamp()

Job::getReleaseTimestamp ( )

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

Since: 1.22

Implements IJobSpecification.

Definition at line 195 of file Job.php.

References wfTimestampOrNull().

Referenced by getReadyTimestamp().

◆ getRequestId()

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

Definition at line 217 of file Job.php.

Referenced by DeletePageJob\run().

◆ getRootJobParams()

Job::getRootJobParams ( )

See also: JobQueue::deduplicateRootJob()

Returns: array

Since: 1.21

Implements IJobSpecification.

Definition at line 324 of file Job.php.

References null.

Referenced by HTMLCacheUpdateJob\run(), and RefreshLinksJob\run().

◆ getTitle()

Job::getTitle ( )

Returns: Title

Implements IJobSpecification.

Definition at line 150 of file Job.php.

References $title.

Referenced by getDeduplicationInfo(), and ClearUserWatchlistJob\run().

◆ getType()

Job::getType ( )

Returns: string

Implements IJobSpecification.

Definition at line 143 of file Job.php.

References $command.

Referenced by JobQueueGroup\ack(), JobQueue\ack(), JobQueueGroup\deduplicateRootJob(), and getDeduplicationInfo().

◆ hasExecutionFlag()

Job::hasExecutionFlag ( $flag )

Parameters

int $flag JOB_* class constant

Returns: bool

Since: 1.31

Definition at line 136 of file Job.php.

◆ hasRootJobParams()

Job::hasRootJobParams ( )

See also: JobQueue::deduplicateRootJob()

Returns: bool

Since: 1.22

Implements IJobSpecification.

Definition at line 336 of file Job.php.

Referenced by isRootJob().

◆ ignoreDuplicates()

Job::ignoreDuplicates ( )

Whether the queue should reject insertion of this job if a duplicate exists.

This can be used to avoid duplicated effort or combined with delayed jobs to coalesce updates into larger batches. Claimed jobs are never treated as duplicates of new jobs, and some queues may allow a few duplicates due to network partitions and fail-over. Thus, additional locking is needed to enforce mutual exclusion if this is really needed.

Returns: bool

Implements IJobSpecification.

Definition at line 240 of file Job.php.

References $removeDuplicates.

◆ isRootJob()

Job::isRootJob ( )

See also: JobQueue::deduplicateRootJob()

Returns: bool Whether this is job is a root job

Implements IJobSpecification.

Definition at line 345 of file Job.php.

References hasRootJobParams().

◆ newRootJobParams()

static Job::newRootJobParams ( $key )

static

Get "root job" parameters for a task.

This is used to no-op redundant jobs, including child jobs of jobs, as long as the children inherit the root job parameters. When a job with root job parameters and "rootJobIsSelf" set is pushed, the deduplicateRootJob() method is automatically called on it. If the root job is only virtual and not actually pushed (e.g. the sub-jobs are inserted directly), then call deduplicateRootJob() directly.

See also: JobQueue::deduplicateRootJob()

Parameters

string $key A key that identifies the task

Returns

array Map of:

rootJobIsSelf : true
rootJobSignature : hash (e.g. SHA1) that identifies the task
rootJobTimestamp : TS_MW timestamp of this instance of the task

Since: 1.21

Definition at line 311 of file Job.php.

References wfTimestampNow().

Referenced by HTMLCacheUpdateJob\newForBacklinks(), LinksUpdate\queueRecursiveJobsForTable(), RefreshLinksPartitionTest\testRefreshLinks(), and JobQueueTest\testRootDeduplication().

◆ run()

Job::run ( )

abstract

Run the job.

Returns: bool Success

Reimplemented in DoubleRedirectJob, EnqueueJob, RefreshLinksJob, CategoryMembershipChangeJob, HTMLCacheUpdateJob, NullJob, RecentChangesUpdateJob, DuplicateJob, ClearWatchlistNotificationsJob, ActivityUpdateJob, RenameUserJob, ClearUserWatchlistJob, ReplaceTextJob, CdnPurgeJob, DeleteLinksJob, PublishStashedFileJob, AssembleUploadChunksJob, EmaillingJob, EnotifNotifyJob, ThumbnailRenderJob, UserGroupExpiryJob, CreatePdfThumbnailsJob, and DeletePageJob.

◆ setLastError()

Job::setLastError ( $error )

protected

Definition at line 429 of file Job.php.

References $error, and error.

Referenced by ThumbnailRenderJob\hitThumbUrl(), ThumbnailRenderJob\run(), AssembleUploadChunksJob\run(), PublishStashedFileJob\run(), DeleteLinksJob\run(), ClearUserWatchlistJob\run(), CategoryMembershipChangeJob\run(), RefreshLinksJob\run(), DoubleRedirectJob\run(), and RefreshLinksJob\runForTitle().

◆ setMetadata()

Job::setMetadata	(	$field,
		$value
	)

Parameters

string	$field	Key name to set the value for
mixed	$value	The value to set the field for

Returns: mixed|null The prior field value; null if missing

Since: 1.33

Definition at line 180 of file Job.php.

References $value, and getMetadata().

◆ teardown()

Job::teardown ( $status )

Do any final cleanup after run(), deferred updates, and all DB commits happen.

Parameters

bool $status Whether the job, its deferred updates, and DB commit all succeeded

Since: 1.27

Definition at line 364 of file Job.php.

References as.

◆ toString()

Job::toString ( )

Returns: string

Definition at line 373 of file Job.php.

References $command, $s, $value, as, captcha-old\count, FormatJson\encode(), string, and title.

◆ workItemCount()

Job::workItemCount ( )

Returns: int Number of actually "work items" handled in this job

See also: $wgJobBackoffThrottling

Since: 1.23

Reimplemented in RefreshLinksJob, and HTMLCacheUpdateJob.

Definition at line 257 of file Job.php.

Member Data Documentation

◆ $command

string Job::$command

Definition at line 32 of file Job.php.

Referenced by __construct(), factory(), getType(), and toString().

◆ $error

string Job::$error

protected

Text for error that occurred last.

Definition at line 47 of file Job.php.

Referenced by getLastError(), and setLastError().

◆ $executionFlags

int Job::$executionFlags = 0

protected

Bitfield of JOB_* class constants.

Definition at line 53 of file Job.php.

◆ $metadata

array Job::$metadata = []

Additional queue metadata.

Definition at line 38 of file Job.php.

Referenced by getMetadata(), and CreatePdfThumbnailsJob\insertJobs().

◆ $params

array Job::$params

Array of job parameters.

Definition at line 35 of file Job.php.

Referenced by DeletePageJob\__construct(), CreatePdfThumbnailsJob\__construct(), UserGroupExpiryJob\__construct(), EnotifNotifyJob\__construct(), RecentChangesUpdateJob\__construct(), ThumbnailRenderJob\__construct(), AssembleUploadChunksJob\__construct(), EmaillingJob\__construct(), PublishStashedFileJob\__construct(), ClearUserWatchlistJob\__construct(), CdnPurgeJob\__construct(), ActivityUpdateJob\__construct(), DeleteLinksJob\__construct(), ReplaceTextJob\__construct(), DuplicateJob\__construct(), ClearWatchlistNotificationsJob\__construct(), HTMLCacheUpdateJob\__construct(), RenameUserJob\__construct(), EnqueueJob\__construct(), RefreshLinksJob\__construct(), DoubleRedirectJob\__construct(), NullJob\__construct(), CategoryMembershipChangeJob\__construct(), __construct(), factory(), getParams(), RefreshLinksJob\newDynamic(), HTMLCacheUpdateJob\newForBacklinks(), RefreshLinksJob\newPrioritized(), and NullJob\run().

◆ $removeDuplicates

bool Job::$removeDuplicates = false

protected

Expensive jobs may set this to true.

Definition at line 44 of file Job.php.

Referenced by ignoreDuplicates().

◆ $teardownCallbacks

callable [] Job::$teardownCallbacks = []

protected

Definition at line 50 of file Job.php.

◆ $title

Title Job::$title

protected

Definition at line 41 of file Job.php.

Referenced by DeletePageJob\__construct(), CreatePdfThumbnailsJob\__construct(), ThumbnailRenderJob\__construct(), EnotifNotifyJob\__construct(), RecentChangesUpdateJob\__construct(), AssembleUploadChunksJob\__construct(), PublishStashedFileJob\__construct(), ReplaceTextJob\__construct(), ActivityUpdateJob\__construct(), DeleteLinksJob\__construct(), CdnPurgeJob\__construct(), DuplicateJob\__construct(), ClearWatchlistNotificationsJob\__construct(), HTMLCacheUpdateJob\__construct(), RenameUserJob\__construct(), EnqueueJob\__construct(), RefreshLinksJob\__construct(), DoubleRedirectJob\__construct(), NullJob\__construct(), CategoryMembershipChangeJob\__construct(), __construct(), factory(), DoubleRedirectJob\fixRedirects(), DoubleRedirectJob\getFinalDestination(), getTitle(), CreatePdfThumbnailsJob\insertJobs(), HTMLCacheUpdateJob\invalidateTitles(), RefreshLinksJob\newDynamic(), HTMLCacheUpdateJob\newForBacklinks(), RefreshLinksJob\newPrioritized(), CategoryMembershipChangeJob\newSpec(), CategoryMembershipChangeJob\notifyUpdatesForRevision(), NullJob\run(), HTMLCacheUpdateJob\run(), RefreshLinksJob\run(), and RefreshLinksJob\runForTitle().

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

includes/jobqueue/Job.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addTeardownCallback()

◆ allowRetries()

◆ factory()

◆ getDeduplicationInfo()

◆ getLastError()

◆ getMetadata()

◆ getParams()

◆ getQueuedTimestamp()

◆ getReadyTimestamp()

◆ getReleaseTimestamp()

◆ getRequestId()

◆ getRootJobParams()

◆ getTitle()

◆ getType()

◆ hasExecutionFlag()

◆ hasRootJobParams()

◆ ignoreDuplicates()

◆ isRootJob()

◆ newRootJobParams()

◆ run()

◆ setLastError()

◆ setMetadata()

◆ teardown()

◆ toString()

◆ workItemCount()

Member Data Documentation

◆ $command

◆ $error

◆ $executionFlags

◆ $metadata

◆ $params

◆ $removeDuplicates

◆ $teardownCallbacks

◆ $title