ApiQueryGeneratorBase.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Api;
 
abstract class ApiQueryGeneratorBase extends ApiQueryBase {
 
    private $mGeneratorPageSet = null;
 
    public function setGeneratorMode( ApiPageSet $generatorPageSet ) {
        $this->mGeneratorPageSet = $generatorPageSet;
    }
 
    public function isInGeneratorMode() {
        return $this->mGeneratorPageSet !== null;
    }
 
    protected function getPageSet() {
        return $this->mGeneratorPageSet ?? 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() {
        // Corresponding messages: api-help-flag-generator
        $flags = parent::getHelpFlags();
        $flags[] = 'generator';
        return $flags;
    }
 
    abstract public function executeGenerator( $resultPageSet );
}
 
class_alias( ApiQueryGeneratorBase::class, 'ApiQueryGeneratorBase' );