MediaWiki  1.33.0
DuplicateJob Class Reference

No-op job that does nothing. More...

Inheritance diagram for DuplicateJob:
Collaboration diagram for DuplicateJob:

Public Member Functions

 __construct (Title $title, array $params)
 Callers should use DuplicateJob::newFromJob() instead. More...
 run ()
 Run the job. More...
- Public Member Functions inherited from Job
 __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 ()

Static Public Member Functions

static newFromJob (Job $job)
 Get a duplicate no-op version of a job. More...
- Static Public Member Functions inherited from Job
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...

Additional Inherited Members

- Public Attributes inherited from Job
string $command
array $metadata = []
 Additional queue metadata. More...
array $params
 Array of job parameters. More...
- Protected Member Functions inherited from Job
 addTeardownCallback ( $callback)
 setLastError ( $error)
- Protected Attributes inherited from Job
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

No-op job that does nothing.

Used to represent duplicates.

Definition at line 29 of file DuplicateJob.php.

Constructor & Destructor Documentation

◆ __construct()

DuplicateJob::__construct ( Title  $title,
array  $params 

Callers should use DuplicateJob::newFromJob() instead.

array$paramsJob parameters

Definition at line 36 of file DuplicateJob.php.

References Job\$params, and Job\$title.

Member Function Documentation

◆ newFromJob()

static DuplicateJob::newFromJob ( Job  $job)

Get a duplicate no-op version of a job.


Definition at line 46 of file DuplicateJob.php.

References $job, and true.

Referenced by JobQueue\pop().

◆ run()

DuplicateJob::run ( )

Run the job.

bool Success

Reimplemented from Job.

Definition at line 56 of file DuplicateJob.php.

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