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, $title, $params=false)

	allowRetries ()

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

	getLastError ()

	getParams ()

	getQueuedTimestamp ()

	getReadyTimestamp ()

	getReleaseTimestamp ()

	getRequestId ()

	getRootJobParams ()

	getTitle ()

	getType ()

	hasRootJobParams ()

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

	insert ()
	Insert a single job into the queue. More...

	isRootJob ()

	run ()
	Run the job. More...

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

	toString ()

	workItemCount ()

Static Public Member Functions
static	batchInsert ( $jobs)
	Batch-insert a group of jobs into the queue. More...

static	factory ( $command, Title $title, $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...

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

callable[]	$teardownCallbacks = []

Title	$title

Detailed Description

Class to both describe a background job and handle jobs.

The queue aspects of this class are now deprecated. Using the class to push jobs onto queues is deprecated (use JobSpecification).

Definition at line 31 of file Job.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

string	$command
Title	$title
array \| bool	$params	Can not be === true

Definition at line 98 of file Job.php.

References $command, $params, $title, WebRequest\getRequestId(), 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 319 of file Job.php.

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

◆ allowRetries()

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 208 of file Job.php.

◆ batchInsert()

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

Job[] $jobs Array of Job objects

Returns: bool

Deprecated:: since 1.21

Definition at line 122 of file Job.php.

References JobQueueGroup\singleton(), and wfDeprecated().

◆ factory()

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

static

Create the appropriate object to handle a specific job.

Parameters

string	$command	Job command
Title	$title	Associated title
array	$params	Job parameters

Exceptions

MWException

Returns: Job

Definition at line 68 of file Job.php.

References $command, $handler, $job, $params, $title, $wgJobClasses, and global.

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, PublishStashedFileJob, and AssembleUploadChunksJob.

Definition at line 230 of file Job.php.

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

◆ getLastError()

Job::getLastError ( )

Definition at line 407 of file Job.php.

References $error.

◆ getParams()

Job::getParams ( )

Returns: array

Implements IJobSpecification.

Definition at line 145 of file Job.php.

References $params.

Referenced by getDeduplicationInfo().

◆ getQueuedTimestamp()

Job::getQueuedTimestamp ( )

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

Since: 1.26

Definition at line 163 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 185 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 153 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 175 of file Job.php.

◆ getRootJobParams()

Job::getRootJobParams ( )

See also: JobQueue::deduplicateRootJob()

Returns: array

Since: 1.21

Implements IJobSpecification.

Definition at line 284 of file Job.php.

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

◆ getTitle()

Job::getTitle ( )

Returns: Title

Implements IJobSpecification.

Definition at line 138 of file Job.php.

References $title.

Referenced by getDeduplicationInfo().

◆ getType()

Job::getType ( )

Returns: string

Implements IJobSpecification.

Definition at line 131 of file Job.php.

References $command.

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

◆ hasRootJobParams()

Job::hasRootJobParams ( )

See also: JobQueue::deduplicateRootJob()

Returns: bool

Since: 1.22

Implements IJobSpecification.

Definition at line 300 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 200 of file Job.php.

References $removeDuplicates.

◆ insert()

Job::insert ( )

Insert a single job into the queue.

Returns: bool True on success

Deprecated:: since 1.21

Definition at line 339 of file Job.php.

References JobQueueGroup\singleton().

◆ isRootJob()

Job::isRootJob ( )

See also: JobQueue::deduplicateRootJob()

Returns: bool Whether this is job is a root job

Implements IJobSpecification.

Definition at line 309 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 271 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, HTMLCacheUpdateJob, NullJob, RecentChangesUpdateJob, DuplicateJob, CategoryMembershipChangeJob, CdnPurgeJob, ActivityUpdateJob, DeleteLinksJob, PublishStashedFileJob, AssembleUploadChunksJob, EmaillingJob, EnotifNotifyJob, ThumbnailRenderJob, RenameUserJob, and CreatePdfThumbnailsJob.

◆ setLastError()

Job::setLastError ( $error )

protected

Definition at line 403 of file Job.php.

References $error, and error.

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

◆ 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 328 of file Job.php.

References as.

◆ toString()

Job::toString ( )

Returns: string

Definition at line 347 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 217 of file Job.php.

Member Data Documentation

◆ $command

string Job::$command

Definition at line 33 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 48 of file Job.php.

Referenced by getLastError(), and setLastError().

◆ $metadata

array Job::$metadata = []

Additional queue metadata.

Definition at line 39 of file Job.php.

Referenced by CreatePdfThumbnailsJob\insertJobs().

◆ $params

array Job::$params

◆ $removeDuplicates

bool Job::$removeDuplicates

protected

Expensive jobs may set this to true.

Definition at line 45 of file Job.php.

Referenced by ignoreDuplicates().

◆ $teardownCallbacks

callable [] Job::$teardownCallbacks = []

protected

Definition at line 51 of file Job.php.

◆ $title

Title Job::$title

protected

Definition at line 42 of file Job.php.

Referenced by CreatePdfThumbnailsJob\__construct(), RenameUserJob\__construct(), ActivityUpdateJob\__construct(), EnotifNotifyJob\__construct(), ThumbnailRenderJob\__construct(), AssembleUploadChunksJob\__construct(), RecentChangesUpdateJob\__construct(), PublishStashedFileJob\__construct(), DeleteLinksJob\__construct(), CdnPurgeJob\__construct(), DuplicateJob\__construct(), HTMLCacheUpdateJob\__construct(), CategoryMembershipChangeJob\__construct(), EnqueueJob\__construct(), DoubleRedirectJob\__construct(), RefreshLinksJob\__construct(), NullJob\__construct(), __construct(), factory(), DoubleRedirectJob\fixRedirects(), CategoryMembershipChangeJob\getCategoriesAtRev(), DoubleRedirectJob\getFinalDestination(), getTitle(), CreatePdfThumbnailsJob\insertJobs(), HTMLCacheUpdateJob\invalidateTitles(), RefreshLinksJob\newDynamic(), HTMLCacheUpdateJob\newForBacklinks(), RefreshLinksJob\newPrioritized(), CategoryMembershipChangeJob\notifyUpdatesForRevision(), NullJob\run(), HTMLCacheUpdateJob\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()

◆ batchInsert()

◆ factory()

◆ getDeduplicationInfo()

◆ getLastError()

◆ getParams()

◆ getQueuedTimestamp()

◆ getReadyTimestamp()

◆ getReleaseTimestamp()

◆ getRequestId()

◆ getRootJobParams()

◆ getTitle()

◆ getType()

◆ hasRootJobParams()

◆ ignoreDuplicates()

◆ insert()

◆ isRootJob()

◆ newRootJobParams()

◆ run()

◆ setLastError()

◆ teardown()

◆ toString()

◆ workItemCount()

Member Data Documentation

◆ $command

◆ $error

◆ $metadata

◆ $params

◆ $removeDuplicates

◆ $teardownCallbacks

◆ $title