JobSpecification.php

Go to the documentation of this file.

<?php
interface IJobSpecification {
    public function getType();

    public function getParams();

    public function getReleaseTimestamp();

    public function ignoreDuplicates();

    public function getDeduplicationInfo();

    public function getTitle();
}

class JobSpecification implements IJobSpecification {
    protected $type;

    protected $params;

    protected $title;

    protected $ignoreDuplicates;

    public function __construct(
        $type, array $params, array $opts = array(), Title $title = null
    ) {
        $this->validateParams( $params );

        $this->type = $type;
        $this->params = $params;
        $this->title = $title ?: Title::newMainPage();
        $this->ignoreDuplicates = !empty( $opts['removeDuplicates'] );
    }

    protected function validateParams( array $params ) {
        foreach ( $params as $p => $v ) {
            if ( is_array( $v ) ) {
                $this->validateParams( $v );
            } elseif ( !is_scalar( $v ) && $v !== null ) {
                throw new UnexpectedValueException( "Job parameter $p is not JSON serializable." );
            }
        }
    }

    public function getType() {
        return $this->type;
    }

    public function getTitle() {
        return $this->title;
    }

    public function getParams() {
        return $this->params;
    }

    public function getReleaseTimestamp() {
        return isset( $this->params['jobReleaseTimestamp'] )
            ? wfTimestampOrNull( TS_UNIX, $this->params['jobReleaseTimestamp'] )
            : null;
    }

    public function ignoreDuplicates() {
        return $this->ignoreDuplicates;
    }

    public function getDeduplicationInfo() {
        $info = array(
            'type' => $this->getType(),
            'namespace' => $this->getTitle()->getNamespace(),
            'title' => $this->getTitle()->getDBkey(),
            'params' => $this->getParams()
        );
        if ( is_array( $info['params'] ) ) {
            // Identical jobs with different "root" jobs should count as duplicates
            unset( $info['params']['rootJobSignature'] );
            unset( $info['params']['rootJobTimestamp'] );
            // Likewise for jobs with different delay times
            unset( $info['params']['jobReleaseTimestamp'] );
        }

        return $info;
    }
}