ApiQueryPageProps.php

Go to the documentation of this file.

<?php
class ApiQueryPageProps extends ApiQueryBase {
 
    private $params;
 
    public function __construct( ApiQuery $query, $moduleName ) {
        parent::__construct( $query, $moduleName, 'pp' );
    }
 
    public function execute() {
        # Only operate on existing pages
        $pages = $this->getPageSet()->getGoodTitles();
 
        $this->params = $this->extractRequestParams();
        if ( $this->params['continue'] ) {
            $continueValue = (int)$this->params['continue'];
            $this->dieContinueUsageIf( strval( $continueValue ) !== $this->params['continue'] );
            $filteredPages = [];
            foreach ( $pages as $id => $page ) {
                if ( $id >= $continueValue ) {
                    $filteredPages[$id] = $page;
                }
            }
            $pages = $filteredPages;
        }
 
        if ( $pages === [] ) {
            # Nothing to do
            return;
        }
 
        $pageProps = PageProps::getInstance();
        $result = $this->getResult();
        if ( $this->params['prop'] ) {
            $propnames = $this->params['prop'];
            $properties = $pageProps->getProperties( $pages, $propnames );
        } else {
            $properties = $pageProps->getAllProperties( $pages );
        }
 
        ksort( $properties );
 
        foreach ( $properties as $page => $props ) {
            if ( !$this->addPageProps( $result, $page, $props ) ) {
                break;
            }
        }
    }
 
    private function addPageProps( $result, $page, $props ) {
        ApiResult::setArrayType( $props, 'assoc' );
        $fit = $result->addValue( [ 'query', 'pages', $page ], 'pageprops', $props );
 
        if ( !$fit ) {
            $this->setContinueEnumParameter( 'continue', $page );
        }
 
        return $fit;
    }
 
    public function getCacheMode( $params ) {
        return 'public';
    }
 
    public function getAllowedParams() {
        return [
            'continue' => [
                ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
            ],
            'prop' => [
                ApiBase::PARAM_ISMULTI => true,
            ],
        ];
    }
 
    protected function getExamplesMessages() {
        return [
            'action=query&prop=pageprops&titles=Main%20Page|MediaWiki'
                => 'apihelp-query+pageprops-example-simple',
        ];
    }
 
    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Pageprops';
    }
}