ApiQueryPageProps.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Api;
 
use MediaWiki\Page\PageProps;
use MediaWiki\Title\Title;
use Wikimedia\ParamValidator\ParamValidator;
 
class ApiQueryPageProps extends ApiQueryBase {
 
    public function __construct(
        ApiQuery $query,
        string $moduleName,
        private readonly PageProps $pageProps,
    ) {
        parent::__construct( $query, $moduleName, 'pp' );
    }
 
    public function execute() {
        # Only operate on existing pages
        $pages = $this->getPageSet()->getGoodPages();
 
        $params = $this->extractRequestParams();
        if ( $params['continue'] ) {
            $cont = $this->parseContinueParamOrDie( $params['continue'], [ 'int' ] );
            $continueValue = $cont[0];
            $filteredPages = [];
            foreach ( $pages as $id => $page ) {
                if ( $id >= $continueValue ) {
                    $filteredPages[$id] = $page;
                }
            }
            $pages = $filteredPages;
        }
 
        if ( $pages === [] ) {
            # Nothing to do
            return;
        }
 
        if ( $params['prop'] ) {
            $properties = $this->pageProps->getProperties( $pages, $params['prop'] );
        } else {
            $properties = $this->pageProps->getAllProperties( $pages );
        }
 
        ksort( $properties );
 
        $result = $this->getResult();
        foreach ( $properties as $pageid => $props ) {
            if ( !$this->addPageProps( $result, $pageid, $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' => [
                ParamValidator::PARAM_ISMULTI => true,
            ],
        ];
    }
 
    protected function getExamplesMessages() {
        $title = Title::newMainPage()->getPrefixedText();
        $mp = rawurlencode( $title );
 
        return [
            "action=query&prop=pageprops&titles={$mp}|MediaWiki"
                => 'apihelp-query+pageprops-example-simple',
        ];
    }
 
    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Pageprops';
    }
}
 
class_alias( ApiQueryPageProps::class, 'ApiQueryPageProps' );