MediaWiki 1.30.2

[autoinstallsdev/mediawiki.git] / includes / api / ApiQueryCategoryInfo.php

diff --git a/includes/api/ApiQueryCategoryInfo.php b/includes/api/ApiQueryCategoryInfo.php
index f3d45ccf003298919c723a33656ae9a6c0cab3bf..25e9b27499aefe158a1d6620041aada354c2cfc4 100644 (file)
--- a/includes/api/ApiQueryCategoryInfo.php
+++ b/includes/api/ApiQueryCategoryInfo.php
@@ -1,11 +1,10 @@
 <?php
-
-/*
- * Created on May 13, 2007
+/**
+ *
  *
- * API for MediaWiki 1.8+
+ * Created on May 13, 2007
  *
- * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
+ * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -19,82 +18,81 @@
  *
  * You should have received a copy of the GNU General Public License along
  * with this program; if not, write to the Free Software Foundation, Inc.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
  */
 
-if (!defined('MEDIAWIKI')) {
-       // Eclipse helper - will be ignored in production
-       require_once ("ApiQueryBase.php");
-}
-
 /**
- * This query adds the <categories> subelement to all pages with the list of categories the page is in
+ * This query adds the "<categories>" subelement to all pages with the list of
+ * categories the page is in.
  *
  * @ingroup API
  */
 class ApiQueryCategoryInfo extends ApiQueryBase {
 
-       public function __construct($query, $moduleName) {
-               parent :: __construct($query, $moduleName, 'ci');
+       public function __construct( ApiQuery $query, $moduleName ) {
+               parent::__construct( $query, $moduleName, 'ci' );
        }
 
        public function execute() {
                $params = $this->extractRequestParams();
-               $alltitles = $this->getPageSet()->getAllTitlesByNamespace();
+               $alltitles = $this->getPageSet()->getGoodAndMissingTitlesByNamespace();
                if ( empty( $alltitles[NS_CATEGORY] ) ) {
                        return;
                }
                $categories = $alltitles[NS_CATEGORY];
 
-               $titles = $this->getPageSet()->getGoodTitles() +
-                                       $this->getPageSet()->getMissingTitles();
-               $cattitles = array();
-               foreach($categories as $c)
-               {
+               $titles = $this->getPageSet()->getGoodAndMissingTitles();
+               $cattitles = [];
+               foreach ( $categories as $c ) {
+                       /** @var Title $t */
                        $t = $titles[$c];
-                       $cattitles[$c] = $t->getDBKey();
+                       $cattitles[$c] = $t->getDBkey();
                }
 
-               $this->addTables(array('category', 'page', 'page_props'));
-               $this->addJoinConds(array(
-                       'page' => array('LEFT JOIN', array(
+               $this->addTables( [ 'category', 'page', 'page_props' ] );
+               $this->addJoinConds( [
+                       'page' => [ 'LEFT JOIN', [
                                'page_namespace' => NS_CATEGORY,
-                               'page_title=cat_title')),
-                       'page_props' => array('LEFT JOIN', array(
+                               'page_title=cat_title' ] ],
+                       'page_props' => [ 'LEFT JOIN', [
                                'pp_page=page_id',
-                               'pp_propname' => 'hiddencat')),
-               ));
-               $this->addFields(array('cat_title', 'cat_pages', 'cat_subcats', 'cat_files', 'pp_propname AS cat_hidden'));
-               $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');
+                               'pp_propname' => 'hiddencat' ] ],
+               ] );
 
-               $db = $this->getDB();
-               $res = $this->select(__METHOD__);
+               $this->addFields( [
+                       'cat_title',
+                       'cat_pages',
+                       'cat_subcats',
+                       'cat_files',
+                       'cat_hidden' => 'pp_propname'
+               ] );
+               $this->addWhere( [ 'cat_title' => $cattitles ] );
 
-               $catids = array_flip($cattitles);
-               while($row = $db->fetchObject($res))
-               {
-                       $vals = array();
-                       $vals['size'] = intval($row->cat_pages);
+               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);
-                       if($row->cat_hidden)
-                               $vals['hidden'] = '';
-                       $fit = $this->addPageSubItems($catids[$row->cat_title], $vals);
-                       if(!$fit)
-                       {
-                               $this->setContinueEnumParameter('continue', $row->cat_title);
+                       $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;
                        }
                }
-               $db->freeResult($res);
        }
 
        public function getCacheMode( $params ) {
@@ -102,26 +100,21 @@ class ApiQueryCategoryInfo extends ApiQueryBase {
        }
 
        public function getAllowedParams() {
-               return array (
-                       'continue' => null,
-               );
-       }
-
-       public function getParamDescription() {
-               return array (
-                       'continue' => 'When more results are available, use this to continue',
-               );
-       }
-
-       public function getDescription() {
-               return 'Returns information about the given categories';
+               return [
+                       'continue' => [
+                               ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
+                       ],
+               ];
        }
 
-       protected function getExamples() {
-               return "api.php?action=query&prop=categoryinfo&titles=Category:Foo|Category:Bar";
+       protected function getExamplesMessages() {
+               return [
+                       'action=query&prop=categoryinfo&titles=Category:Foo|Category:Bar'
+                               => 'apihelp-query+categoryinfo-example-simple',
+               ];
        }
 
-       public function getVersion() {
-               return __CLASS__ . ': $Id: ApiQueryCategoryInfo.php 69986 2010-07-27 03:57:39Z tstarling $';
+       public function getHelpUrls() {
+               return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Categoryinfo';
        }
 }