MediaWiki  REL1_31
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, $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 ()
 
 hasExecutionFlag ( $flag)
 
 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...
 
int $executionFlags = 0
 Bitfield of JOB_* class constants. 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$paramsCan not be === true

Definition at line 104 of file Job.php.

References $command, $params, $title, WebRequest\getRequestId(), 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 334 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 223 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[]$jobsArray of Job objects
Returns
bool
Deprecated:
since 1.21

Definition at line 137 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$commandJob command
Title$titleAssociated title
array$paramsJob parameters
Exceptions
MWException
Returns
Job

Definition at line 74 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(), 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 245 of file Job.php.

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

◆ getLastError()

Job::getLastError ( )

Definition at line 423 of file Job.php.

References $error.

◆ getParams()

Job::getParams ( )
Returns
array

Implements IJobSpecification.

Definition at line 160 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 178 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 200 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 168 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 190 of file Job.php.

◆ getRootJobParams()

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

Implements IJobSpecification.

Definition at line 299 of file Job.php.

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

◆ getTitle()

Job::getTitle ( )
Returns
Title

Implements IJobSpecification.

Definition at line 153 of file Job.php.

References $title.

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

◆ getType()

Job::getType ( )
Returns
string

Implements IJobSpecification.

Definition at line 146 of file Job.php.

References $command.

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

◆ hasExecutionFlag()

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

Definition at line 122 of file Job.php.

◆ hasRootJobParams()

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

Implements IJobSpecification.

Definition at line 315 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 215 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 354 of file Job.php.

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

◆ isRootJob()

Job::isRootJob ( )
See also
JobQueue::deduplicateRootJob()
Returns
bool Whether this is job is a root job

Implements IJobSpecification.

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

References wfTimestampNow().

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

◆ run()

◆ setLastError()

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

References as.

◆ toString()

Job::toString ( )
Returns
string

Definition at line 363 of file Job.php.

References $command, $s, $value, as, 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 232 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().

◆ $executionFlags

int Job::$executionFlags = 0
protected

Bitfield of JOB_* class constants.

Definition at line 54 of file Job.php.

◆ $metadata

array Job::$metadata = []

Additional queue metadata.

Definition at line 39 of file Job.php.

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


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