EnqueueJob.php

Go to the documentation of this file.

<?php
final class EnqueueJob extends Job {
    function __construct( Title $title, array $params ) {
        parent::__construct( 'enqueue', $title, $params );
    }

    public static function newFromLocalJobs( $jobs ) {
        $jobs = is_array( $jobs ) ? $jobs : [ $jobs ];

        return self::newFromJobsByWiki( [ wfWikiID() => $jobs ] );
    }

    public static function newFromJobsByWiki( array $jobsByWiki ) {
        $deduplicate = true;

        $jobMapsByWiki = [];
        foreach ( $jobsByWiki as $wiki => $jobs ) {
            $jobMapsByWiki[$wiki] = [];
            foreach ( $jobs as $job ) {
                if ( $job instanceof JobSpecification ) {
                    $jobMapsByWiki[$wiki][] = $job->toSerializableArray();
                } else {
                    throw new InvalidArgumentException( "Jobs must be of type JobSpecification." );
                }
                $deduplicate = $deduplicate && $job->ignoreDuplicates();
            }
        }

        $eJob = new self(
            Title::makeTitle( NS_SPECIAL, 'Badtitle/' . __CLASS__ ),
            [ 'jobsByWiki' => $jobMapsByWiki ]
        );
        // 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 function run() {
        foreach ( $this->params['jobsByWiki'] as $wiki => $jobMaps ) {
            $jobSpecs = [];
            foreach ( $jobMaps as $jobMap ) {
                $jobSpecs[] = JobSpecification::newFromArray( $jobMap );
            }
            JobQueueGroup::singleton( $wiki )->push( $jobSpecs );
        }

        return true;
    }
}