ApiQueryGeneratorBase.php

Go to the documentation of this file.

<?php
abstract class ApiQueryGeneratorBase extends ApiQueryBase {

    private $mGeneratorPageSet = null;

    public function setGeneratorMode( ApiPageSet $generatorPageSet ) {
        if ( $generatorPageSet === null ) {
            ApiBase::dieDebug( __METHOD__, 'Required parameter missing - $generatorPageSet' );
        }
        $this->mGeneratorPageSet = $generatorPageSet;
    }

    public function isInGeneratorMode() {
        return $this->mGeneratorPageSet !== null;
    }

    protected function getPageSet() {
        if ( $this->mGeneratorPageSet !== null ) {
            return $this->mGeneratorPageSet;
        }

        return parent::getPageSet();
    }

    public function encodeParamName( $paramName ) {
        if ( $this->mGeneratorPageSet !== null ) {
            return 'g' . parent::encodeParamName( $paramName );
        } else {
            return parent::encodeParamName( $paramName );
        }
    }

    protected function setContinueEnumParameter( $paramName, $paramValue ) {
        if ( $this->mGeneratorPageSet !== null ) {
            $this->getContinuationManager()->addGeneratorContinueParam( $this, $paramName, $paramValue );
        } else {
            parent::setContinueEnumParameter( $paramName, $paramValue );
        }
    }

    protected function getHelpFlags() {
        $flags = parent::getHelpFlags();
        $flags[] = 'generator';
        return $flags;
    }

    abstract public function executeGenerator( $resultPageSet );
}