ApiQueryCategoryInfo.php

Go to the documentation of this file.

<?php
class ApiQueryCategoryInfo extends ApiQueryBase {

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

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

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

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

                $this->addFields( array( 'cat_title', 'cat_pages', 'cat_subcats', 'cat_files', 'cat_hidden' => 'pp_propname' ) );
                $this->addWhere( array( '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 = array();
                        $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 );
                        if ( $row->cat_hidden ) {
                                $vals['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 array(
                        'continue' => null,
                );
        }

        public function getParamDescription() {
                return array(
                        'continue' => 'When more results are available, use this to continue',
                );
        }

        public function getResultProperties() {
                return array(
                        ApiBase::PROP_LIST => false,
                        '' => array(
                                'size' => array(
                                        ApiBase::PROP_TYPE => 'integer',
                                        ApiBase::PROP_NULLABLE => false
                                ),
                                'pages' => array(
                                        ApiBase::PROP_TYPE => 'integer',
                                        ApiBase::PROP_NULLABLE => false
                                ),
                                'files' => array(
                                        ApiBase::PROP_TYPE => 'integer',
                                        ApiBase::PROP_NULLABLE => false
                                ),
                                'subcats' => array(
                                        ApiBase::PROP_TYPE => 'integer',
                                        ApiBase::PROP_NULLABLE => false
                                ),
                                'hidden' => array(
                                        ApiBase::PROP_TYPE => 'boolean',
                                        ApiBase::PROP_NULLABLE => false
                                )
                        )
                );
        }

        public function getDescription() {
                return 'Returns information about the given categories';
        }

        public function getExamples() {
                return 'api.php?action=query&prop=categoryinfo&titles=Category:Foo|Category:Bar';
        }

        public function getHelpUrls() {
                return 'https://www.mediawiki.org/wiki/API:Properties#categoryinfo_.2F_ci';
        }

        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }
}