ApiQueryCategoryInfo.php

Go to the documentation of this file.

<?php
class ApiQueryCategoryInfo extends ApiQueryBase {

    public function __construct( ApiQuery $query, $moduleName ) {
        parent::__construct( $query, $moduleName, 'ci' );
    }

    public function execute() {
        $params = $this->extractRequestParams();
        $alltitles = $this->getPageSet()->getGoodAndMissingTitlesByNamespace();
        if ( empty( $alltitles[NS_CATEGORY] ) ) {
            return;
        }
        $categories = $alltitles[NS_CATEGORY];

        $titles = $this->getPageSet()->getGoodAndMissingTitles();
        $cattitles = [];
        foreach ( $categories as $c ) {
            $t = $titles[$c];
            $cattitles[$c] = $t->getDBkey();
        }

        $this->addTables( [ 'category', 'page', 'page_props' ] );
        $this->addJoinConds( [
            'page' => [ 'LEFT JOIN', [
                'page_namespace' => NS_CATEGORY,
                'page_title=cat_title' ] ],
            'page_props' => [ 'LEFT JOIN', [
                'pp_page=page_id',
                'pp_propname' => 'hiddencat' ] ],
        ] );

        $this->addFields( [
            'cat_title',
            'cat_pages',
            'cat_subcats',
            'cat_files',
            'cat_hidden' => 'pp_propname'
        ] );
        $this->addWhere( [ 'cat_title' => $cattitles ] );

        if ( !is_null( $params['continue'] ) ) {
            $title = $this->getDB()->addQuotes( $params['continue'] );
            $this->addWhere( "cat_title >= $title" );
        }
        $this->addOption( 'ORDER BY', 'cat_title' );

        $res = $this->select( __METHOD__ );

        $catids = array_flip( $cattitles );
        foreach ( $res as $row ) {
            $vals = [];
            $vals['size'] = intval( $row->cat_pages );
            $vals['pages'] = $row->cat_pages - $row->cat_subcats - $row->cat_files;
            $vals['files'] = intval( $row->cat_files );
            $vals['subcats'] = intval( $row->cat_subcats );
            $vals['hidden'] = (bool)$row->cat_hidden;
            $fit = $this->addPageSubItems( $catids[$row->cat_title], $vals );
            if ( !$fit ) {
                $this->setContinueEnumParameter( 'continue', $row->cat_title );
                break;
            }
        }
    }

    public function getCacheMode( $params ) {
        return 'public';
    }

    public function getAllowedParams() {
        return [
            'continue' => [
                ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
            ],
        ];
    }

    protected function getExamplesMessages() {
        return [
            'action=query&prop=categoryinfo&titles=Category:Foo|Category:Bar'
                => 'apihelp-query+categoryinfo-example-simple',
        ];
    }

    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/API:Categoryinfo';
    }
}