ApiQueryAllCategories.php

Go to the documentation of this file.

<?php
class ApiQueryAllCategories extends ApiQueryGeneratorBase {

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

        public function execute() {
                $this->run();
        }

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

        public function executeGenerator( $resultPageSet ) {
                $this->run( $resultPageSet );
        }

        private function run( $resultPageSet = null ) {
                $db = $this->getDB();
                $params = $this->extractRequestParams();

                $this->addTables( 'category' );
                $this->addFields( 'cat_title' );

                if ( !is_null( $params['continue'] ) ) {
                        $cont = explode( '|', $params['continue'] );
                        if ( count( $cont ) != 1 ) {
                                $this->dieUsage( "Invalid continue param. You should pass the " .
                                        "original value returned by the previous query", "_badcontinue" );
                        }
                        $op = $params['dir'] == 'descending' ? '<' : '>';
                        $cont_from = $db->addQuotes( $cont[0] );
                        $this->addWhere( "cat_title $op= $cont_from" );
                }

                $dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' );
                $from = ( is_null( $params['from'] ) ? null : $this->titlePartToKey( $params['from'] ) );
                $to = ( is_null( $params['to'] ) ? null : $this->titlePartToKey( $params['to'] ) );
                $this->addWhereRange( 'cat_title', $dir, $from, $to );

                $min = $params['min'];
                $max = $params['max'];
                if ( $dir == 'newer' ) {
                        $this->addWhereRange( 'cat_pages', 'newer', $min, $max );
                } else {
                        $this->addWhereRange( 'cat_pages', 'older', $max, $min);
                }

                if ( isset( $params['prefix'] ) ) {
                        $this->addWhere( 'cat_title' . $db->buildLike( $this->titlePartToKey( $params['prefix'] ), $db->anyString() ) );
                }

                $this->addOption( 'LIMIT', $params['limit'] + 1 );
                $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
                $this->addOption( 'ORDER BY', 'cat_title' . $sort );

                $prop = array_flip( $params['prop'] );
                $this->addFieldsIf( array( 'cat_pages', 'cat_subcats', 'cat_files' ), isset( $prop['size'] ) );
                if ( isset( $prop['hidden'] ) ) {
                        $this->addTables( array( '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_hidden' => 'pp_propname' ) );
                }

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

                $pages = array();

                $result = $this->getResult();
                $count = 0;
                foreach ( $res as $row ) {
                        if ( ++ $count > $params['limit'] ) {
                                // We've reached the one extra which shows that there are additional cats to be had. Stop here...
                                $this->setContinueEnumParameter( 'continue', $row->cat_title );
                                break;
                        }

                        // Normalize titles
                        $titleObj = Title::makeTitle( NS_CATEGORY, $row->cat_title );
                        if ( !is_null( $resultPageSet ) ) {
                                $pages[] = $titleObj;
                        } else {
                                $item = array();
                                $result->setContent( $item, $titleObj->getText() );
                                if ( isset( $prop['size'] ) ) {
                                        $item['size'] = intval( $row->cat_pages );
                                        $item['pages'] = $row->cat_pages - $row->cat_subcats - $row->cat_files;
                                        $item['files'] = intval( $row->cat_files );
                                        $item['subcats'] = intval( $row->cat_subcats );
                                }
                                if ( isset( $prop['hidden'] ) && $row->cat_hidden ) {
                                        $item['hidden'] = '';
                                }
                                $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $item );
                                if ( !$fit ) {
                                        $this->setContinueEnumParameter( 'continue', $row->cat_title );
                                        break;
                                }
                        }
                }

                if ( is_null( $resultPageSet ) ) {
                        $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'c' );
                } else {
                        $resultPageSet->populateFromTitles( $pages );
                }
        }

        public function getAllowedParams() {
                return array(
                        'from' => null,
                        'continue' => null,
                        'to' => null,
                        'prefix' => null,
                        'dir' => array(
                                ApiBase::PARAM_DFLT => 'ascending',
                                ApiBase::PARAM_TYPE => array(
                                        'ascending',
                                        'descending'
                                ),
                        ),
                        'min' => array(
                                ApiBase::PARAM_DFLT => null,
                                ApiBase::PARAM_TYPE => 'integer'
                        ),
                        'max' => array(
                                ApiBase::PARAM_DFLT => null,
                                ApiBase::PARAM_TYPE => 'integer'
                        ),
                        'limit' => array(
                                ApiBase::PARAM_DFLT => 10,
                                ApiBase::PARAM_TYPE => 'limit',
                                ApiBase::PARAM_MIN => 1,
                                ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
                                ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
                        ),
                        'prop' => array(
                                ApiBase::PARAM_TYPE => array( 'size', 'hidden' ),
                                ApiBase::PARAM_DFLT => '',
                                ApiBase::PARAM_ISMULTI => true
                        ),
                );
        }

        public function getParamDescription() {
                return array(
                        'from' => 'The category to start enumerating from',
                        'continue' => 'When more results are available, use this to continue',
                        'to' => 'The category to stop enumerating at',
                        'prefix' => 'Search for all category titles that begin with this value',
                        'dir' => 'Direction to sort in',
                        'min' => 'Minimum number of category members',
                        'max' => 'Maximum number of category members',
                        'limit' => 'How many categories to return',
                        'prop' => array(
                                'Which properties to get',
                                ' size    - Adds number of pages in the category',
                                ' hidden  - Tags categories that are hidden with __HIDDENCAT__',
                        ),
                );
        }

        public function getResultProperties() {
                return array(
                        '' => array(
                                '*' => 'string'
                        ),
                        'size' => array(
                                'size' => 'integer',
                                'pages' => 'integer',
                                'files' => 'integer',
                                'subcats' => 'integer'
                        ),
                        'hidden' => array(
                                'hidden' => 'boolean'
                        )
                );
        }

        public function getDescription() {
                return 'Enumerate all categories';
        }

        public function getPossibleErrors() {
                return array_merge( parent::getPossibleErrors(), array(
                        array( 'code' => '_badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ),
                ) );
        }

        public function getExamples() {
                return array(
                        'api.php?action=query&list=allcategories&acprop=size',
                        'api.php?action=query&generator=allcategories&gacprefix=List&prop=info',
                );
        }

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

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