MediaWiki  master
Job Class Reference

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

Inheritance diagram for Job:
Collaboration diagram for Job:

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 ()
 
 setMetadata ( $field, $value)
 
 teardown ( $status)
 Do any final cleanup after run(), deferred updates, and all DB commits happen. More...
 
 toString ()
 
 workItemCount ()
 
- Public Member Functions inherited from RunnableJob
 run ()
 Run the job. More...
 

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

Definition at line 117 of file Job.php.

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

Member Function Documentation

◆ addTeardownCallback()

Job::addTeardownCallback (   $callback)
protected
Parameters
callable$callbackA 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 377 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

Definition at line 272 of file Job.php.

◆ factory()

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

Create the appropriate object to handle a specific job.

Parameters
string$commandJob command
array | Title$paramsJob parameters
Exceptions
InvalidArgumentException
Returns
Job

Definition at line 66 of file Job.php.

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

Referenced by JobQueue\factoryJob(), JobQueueTest\newDedupedJob(), JobQueueTest\newJob(), JobTest\newNullJob(), JobTest\provideTestJobFactory(), JobTest\staticNullJob(), JobTest\testJobFactory(), SiteStatsTest\testJobsCountGetCached(), JobTest\testJobSignatureGeneric(), and JobTest\testJobSignatureTitleBased().

◆ 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.

Definition at line 294 of file Job.php.

References getParams(), and getType().

◆ getLastError()

Job::getLastError ( )

Definition at line 455 of file Job.php.

References $error.

Referenced by JobRunner\executeJob().

◆ getMetadata()

Job::getMetadata (   $field = null)
Parameters
string | null$fieldMetadata field or null to get all the metadata
Returns
mixed|null Value; null if missing
Since
1.33

Implements RunnableJob.

Definition at line 190 of file Job.php.

References $metadata, and null.

Referenced by setMetadata().

◆ getParams()

Job::getParams ( )

◆ getQueuedTimestamp()

Job::getQueuedTimestamp ( )
Returns
int|null UNIX timestamp of when the job was queued, or null
Since
1.26

Definition at line 229 of file Job.php.

References null, and 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 249 of file Job.php.

References getQueuedTimestamp(), and getReleaseTimestamp().

Referenced by JobRunner\executeJob().

◆ getReleaseTimestamp()

Job::getReleaseTimestamp ( )
Returns
int|null UNIX timestamp to delay running this job until, otherwise null
Since
1.22

Implements IJobSpecification.

Definition at line 219 of file Job.php.

References null, and 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 241 of file Job.php.

References null.

Referenced by DeletePageJob\run().

◆ getRootJobParams()

Job::getRootJobParams ( )
See also
JobQueue::deduplicateRootJob()
Returns
array
Since
1.21

Implements IJobSpecification.

Definition at line 346 of file Job.php.

References null.

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

◆ getTitle()

Job::getTitle ( )
final
Returns
Title

Definition at line 174 of file Job.php.

References $title.

Referenced by BacklinkJobUtils\partitionBacklinkJob(), and WatchedItemStoreUnitTest\verifyCallbackJob().

◆ getType()

◆ hasExecutionFlag()

Job::hasExecutionFlag (   $flag)
Parameters
int$flagJOB_* class constant
Returns
bool
Since
1.31

Definition at line 160 of file Job.php.

Referenced by JobRunner\executeJob().

◆ hasRootJobParams()

Job::hasRootJobParams ( )
See also
JobQueue::deduplicateRootJob()
Returns
bool
Since
1.22

Implements IJobSpecification.

Definition at line 358 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 264 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 367 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$keyA 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 333 of file Job.php.

References wfTimestampNow().

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

◆ setLastError()

◆ setMetadata()

Job::setMetadata (   $field,
  $value 
)
Parameters
string$fieldKey name to set the value for
mixed$valueThe value to set the field for
Returns
mixed|null The prior field value; null if missing
Since
1.33

Implements RunnableJob.

Definition at line 204 of file Job.php.

References $value, getMetadata(), and null.

◆ teardown()

Job::teardown (   $status)

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

Parameters
bool$statusWhether the job, its deferred updates, and DB commit all succeeded
Since
1.27

Definition at line 386 of file Job.php.

References as.

Referenced by JobRunner\executeJob().

◆ toString()

Job::toString ( )
Returns
string

Definition at line 395 of file Job.php.

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

Referenced by JobRunner\commitMasterChanges(), and JobRunner\executeJob().

◆ workItemCount()

Job::workItemCount ( )
Returns
int Number of actually "work items" handled in this job
See also
$wgJobBackoffThrottling
Since
1.23

Definition at line 281 of file Job.php.

Referenced by JobRunner\getBackoffTimeToWait().

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().

◆ $params

◆ $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


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