EnqueueJob.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;
 
final class EnqueueJob extends Job implements GenericParameterJob {
    public function __construct( array $params ) {
        parent::__construct( 'enqueue', $params );
    }
 
    public static function newFromLocalJobs( $jobs ) {
        $jobs = is_array( $jobs ) ? $jobs : [ $jobs ];
 
        return self::newFromJobsByDomain( [
            WikiMap::getCurrentWikiDbDomain()->getId() => $jobs
        ] );
    }
 
    public static function newFromJobsByDomain( array $jobsByDomain ) {
        $deduplicate = true;
 
        $jobMapsByDomain = [];
        foreach ( $jobsByDomain as $domain => $jobs ) {
            $jobMapsByDomain[$domain] = [];
            foreach ( $jobs as $job ) {
                if ( $job instanceof JobSpecification ) {
                    $jobMapsByDomain[$domain][] = $job->toSerializableArray();
                } else {
                    throw new InvalidArgumentException( "Jobs must be of type JobSpecification." );
                }
                $deduplicate = $deduplicate && $job->ignoreDuplicates();
            }
        }
 
        $eJob = new self( [ 'jobsByDomain' => $jobMapsByDomain ] );
        // If *all* jobs to be pushed are to be de-duplicated (a common case), then
        // de-duplicate this whole job itself to avoid build up in high traffic cases
        $eJob->removeDuplicates = $deduplicate;
 
        return $eJob;
    }
 
    public static function newFromJobsByWiki( array $jobsByWiki ) {
        wfDeprecated( __METHOD__, '1.33' );
        return self::newFromJobsByDomain( $jobsByWiki );
    }
 
    public function run() {
        $jobsByDomain = $this->params['jobsByDomain'] ?? $this->params['jobsByWiki']; // b/c
 
        $jobQueueGroupFactory = MediaWikiServices::getInstance()->getJobQueueGroupFactory();
        foreach ( $jobsByDomain as $domain => $jobMaps ) {
            $jobSpecs = [];
            foreach ( $jobMaps as $jobMap ) {
                $jobSpecs[] = JobSpecification::newFromArray( $jobMap );
            }
            $jobQueueGroupFactory->makeJobQueueGroup( $domain )->push( $jobSpecs );
        }
 
        return true;
    }
}