Router job that takes jobs and enqueues them to their proper queues. More...
Public Member Functions | |
| __construct (Title $title, array $params) | |
| Callers should use the factory methods instead. | |
| run () | |
| Run the job. | |
 Public Member Functions inherited from Job | |
| __construct ( $command, $params=null) | |
| allowRetries () | |
| getDeduplicationInfo () | |
| Subclasses may need to override this to make duplication detection work. | |
| 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. | |
| isRootJob () | |
| setMetadata ( $field, $value) | |
| teardown ( $status) | |
| Do any final cleanup after run(), deferred updates, and all DB commits happen. | |
| toString () | |
| workItemCount () | |
Static Public Member Functions | |
| static | newFromJobsByDomain (array $jobsByDomain) |
| static | newFromJobsByWiki (array $jobsByWiki) |
| static | newFromLocalJobs ( $jobs) |
| Static Public Member Functions inherited from Job | |
| static | factory ( $command, $params=[]) |
| Create the appropriate object to handle a specific job. | |
| static | newRootJobParams ( $key) |
| Get "root job" parameters for a task. | |
Additional Inherited Members | |
| Public Attributes inherited from Job | |
| string | $command |
| array | $metadata = [] |
| Additional queue metadata. | |
| array | $params |
| Array of job parameters. | |
| Protected Member Functions inherited from Job | |
| addTeardownCallback ( $callback) | |
| setLastError ( $error) | |
| Protected Attributes inherited from Job | |
| string | $error |
| Text for error that occurred last. | |
| int | $executionFlags = 0 |
| Bitfield of JOB_* class constants. | |
| bool | $removeDuplicates = false |
| Expensive jobs may set this to true. | |
| callable[] | $teardownCallbacks = [] |
| Title | $title |
Detailed Description
Router job that takes jobs and enqueues them to their proper queues.
This can be used for getting sets of multiple jobs or sets of jobs intended for multiple queues to be inserted more robustly. This is a single job that, upon running, enqueues the wrapped jobs. If some of those fail to enqueue then the EnqueueJob will be retried. Due to the possibility of duplicate enqueues, the wrapped jobs should be idempotent.
- Since
- 1.25
Definition at line 35 of file EnqueueJob.php.
Constructor & Destructor Documentation
◆ __construct()
Callers should use the factory methods instead.
Definition at line 42 of file EnqueueJob.php.
References Job\$params.
Member Function Documentation
◆ newFromJobsByDomain()
|
static |
- Parameters
-
array $jobsByDomain Map of (wiki => JobSpecification list)
- Returns
- EnqueueJob
Definition at line 62 of file EnqueueJob.php.
References $job, and(), and NS_SPECIAL.
Referenced by newFromJobsByWiki(), and newFromLocalJobs().
◆ newFromJobsByWiki()
|
static |
- Parameters
-
array $jobsByWiki
- Returns
- EnqueueJob
- Deprecated
- Since 1.33; use newFromJobsByDomain()
Definition at line 94 of file EnqueueJob.php.
References newFromJobsByDomain().
◆ newFromLocalJobs()
|
static |
- Parameters
-
JobSpecification | JobSpecification[] $jobs
- Returns
- EnqueueJob
Definition at line 50 of file EnqueueJob.php.
References and(), and newFromJobsByDomain().
◆ run()
| EnqueueJob::run | ( | ) |
Run the job.
- Returns
- bool Success
Reimplemented from Job.
Definition at line 98 of file EnqueueJob.php.
References JobSpecification\newFromArray().
The documentation for this class was generated from the following file:
- includes/jobqueue/jobs/EnqueueJob.php
