includes/api/ApiQueryCategoryInfo.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on May 13, 2007
   6  *
   7  * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  */
  26
  27 /**
  28  * This query adds the "<categories>" subelement to all pages with the list of
  29  * categories the page is in.
  30  *
  31  * @ingroup API
  32  */
  33 class ApiQueryCategoryInfo extends ApiQueryBase {
  34
  35         public function __construct( ApiQuery $query, $moduleName ) {
  36                 parent::__construct( $query, $moduleName, 'ci' );
  37         }
  38
  39         public function execute() {
  40                 $params = $this->extractRequestParams();
  41                 $alltitles = $this->getPageSet()->getGoodAndMissingTitlesByNamespace();
  42                 if ( empty( $alltitles[NS_CATEGORY] ) ) {
  43                         return;
  44                 }
  45                 $categories = $alltitles[NS_CATEGORY];
  46
  47                 $titles = $this->getPageSet()->getGoodAndMissingTitles();
  48                 $cattitles = [];
  49                 foreach ( $categories as $c ) {
  50                         /** @var Title $t */
  51                         $t = $titles[$c];
  52                         $cattitles[$c] = $t->getDBkey();
  53                 }
  54
  55                 $this->addTables( [ 'category', 'page', 'page_props' ] );
  56                 $this->addJoinConds( [
  57                         'page' => [ 'LEFT JOIN', [
  58                                 'page_namespace' => NS_CATEGORY,
  59                                 'page_title=cat_title' ] ],
  60                         'page_props' => [ 'LEFT JOIN', [
  61                                 'pp_page=page_id',
  62                                 'pp_propname' => 'hiddencat' ] ],
  63                 ] );
  64
  65                 $this->addFields( [
  66                         'cat_title',
  67                         'cat_pages',
  68                         'cat_subcats',
  69                         'cat_files',
  70                         'cat_hidden' => 'pp_propname'
  71                 ] );
  72                 $this->addWhere( [ 'cat_title' => $cattitles ] );
  73
  74                 if ( !is_null( $params['continue'] ) ) {
  75                         $title = $this->getDB()->addQuotes( $params['continue'] );
  76                         $this->addWhere( "cat_title >= $title" );
  77                 }
  78                 $this->addOption( 'ORDER BY', 'cat_title' );
  79
  80                 $res = $this->select( __METHOD__ );
  81
  82                 $catids = array_flip( $cattitles );
  83                 foreach ( $res as $row ) {
  84                         $vals = [];
  85                         $vals['size'] = intval( $row->cat_pages );
  86                         $vals['pages'] = $row->cat_pages - $row->cat_subcats - $row->cat_files;
  87                         $vals['files'] = intval( $row->cat_files );
  88                         $vals['subcats'] = intval( $row->cat_subcats );
  89                         $vals['hidden'] = (bool)$row->cat_hidden;
  90                         $fit = $this->addPageSubItems( $catids[$row->cat_title], $vals );
  91                         if ( !$fit ) {
  92                                 $this->setContinueEnumParameter( 'continue', $row->cat_title );
  93                                 break;
  94                         }
  95                 }
  96         }
  97
  98         public function getCacheMode( $params ) {
  99                 return 'public';
 100         }
 101
 102         public function getAllowedParams() {
 103                 return [
 104                         'continue' => [
 105                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
 106                         ],
 107                 ];
 108         }
 109
 110         protected function getExamplesMessages() {
 111                 return [
 112                         'action=query&prop=categoryinfo&titles=Category:Foo|Category:Bar'
 113                                 => 'apihelp-query+categoryinfo-example-simple',
 114                 ];
 115         }
 116
 117         public function getHelpUrls() {
 118                 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Categoryinfo';
 119         }
 120 }