MediaWiki REL1_34
EnqueueJob.php
Go to the documentation of this file.
1<?php
35final class EnqueueJob extends Job implements GenericParameterJob {
41 public function __construct( array $params ) {
42 parent::__construct( 'enqueue', $params );
43 }
44
49 public static function newFromLocalJobs( $jobs ) {
50 $jobs = is_array( $jobs ) ? $jobs : [ $jobs ];
51
53 WikiMap::getCurrentWikiDbDomain()->getId() => $jobs
54 ] );
55 }
56
61 public static function newFromJobsByDomain( array $jobsByDomain ) {
62 $deduplicate = true;
63
64 $jobMapsByDomain = [];
65 foreach ( $jobsByDomain as $domain => $jobs ) {
66 $jobMapsByDomain[$domain] = [];
67 foreach ( $jobs as $job ) {
68 if ( $job instanceof JobSpecification ) {
69 $jobMapsByDomain[$domain][] = $job->toSerializableArray();
70 } else {
71 throw new InvalidArgumentException( "Jobs must be of type JobSpecification." );
72 }
73 $deduplicate = $deduplicate && $job->ignoreDuplicates();
74 }
75 }
76
77 $eJob = new self( [ 'jobsByDomain' => $jobMapsByDomain ] );
78 // If *all* jobs to be pushed are to be de-duplicated (a common case), then
79 // de-duplicate this whole job itself to avoid build up in high traffic cases
80 $eJob->removeDuplicates = $deduplicate;
81
82 return $eJob;
83 }
84
90 public static function newFromJobsByWiki( array $jobsByWiki ) {
91 return self::newFromJobsByDomain( $jobsByWiki );
92 }
93
94 public function run() {
95 $jobsByDomain = $this->params['jobsByDomain'] ?? $this->params['jobsByWiki']; // b/c
96
97 foreach ( $jobsByDomain as $domain => $jobMaps ) {
98 $jobSpecs = [];
99 foreach ( $jobMaps as $jobMap ) {
100 $jobSpecs[] = JobSpecification::newFromArray( $jobMap );
101 }
102 JobQueueGroup::singleton( $domain )->push( $jobSpecs );
103 }
104
105 return true;
106 }
107}
Router job that takes jobs and enqueues them to their proper queues.
static newFromJobsByWiki(array $jobsByWiki)
run()
Run the job.
static newFromLocalJobs( $jobs)
__construct(array $params)
Callers should use the factory methods instead.
static newFromJobsByDomain(array $jobsByDomain)
Job queue task description base code.
static newFromArray(array $map)
Class to both describe a background job and handle jobs.
Definition Job.php:30
array $params
Array of job parameters.
Definition Job.php:35
Interface for generic jobs only uses the parameters field and are JSON serializable.
if(count( $args)< 1) $job