MediaWiki  master
EnqueueJob.php
Go to the documentation of this file.
1 <?php
35 final 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 
52  return self::newFromJobsByDomain( [
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.
Definition: EnqueueJob.php:35
__construct(array $params)
Callers should use the factory methods instead.
Definition: EnqueueJob.php:41
Class to both describe a background job and handle jobs.
Definition: Job.php:30
run()
Run the job.
Definition: EnqueueJob.php:94
static newFromJobsByDomain(array $jobsByDomain)
Definition: EnqueueJob.php:61
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
static newFromJobsByWiki(array $jobsByWiki)
Definition: EnqueueJob.php:90
static getCurrentWikiDbDomain()
Definition: WikiMap.php:293
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
if(count( $args)< 1) $job
static singleton( $domain=false)
array $params
Array of job parameters.
Definition: Job.php:35
static newFromLocalJobs( $jobs)
Definition: EnqueueJob.php:49
static newFromArray(array $map)
Job queue task description base code.
Interface for generic jobs only uses the parameters field and are JSON serializable.