4 * Created on May 13, 2007
6 * API for MediaWiki 1.8+
8 * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 * http://www.gnu.org/copyleft/gpl.html
26 if ( !defined( 'MEDIAWIKI' ) ) {
27 // Eclipse helper - will be ignored in production
28 require_once ( "ApiQueryBase.php" );
32 * This query adds the <categories> subelement to all pages with the list of categories the page is in
36 class ApiQueryCategoryInfo
extends ApiQueryBase
{
38 public function __construct( $query, $moduleName ) {
39 parent
:: __construct( $query, $moduleName, 'ci' );
42 public function execute() {
43 $params = $this->extractRequestParams();
44 $alltitles = $this->getPageSet()->getAllTitlesByNamespace();
45 if ( empty( $alltitles[NS_CATEGORY
] ) ) {
48 $categories = $alltitles[NS_CATEGORY
];
50 $titles = $this->getPageSet()->getGoodTitles() +
51 $this->getPageSet()->getMissingTitles();
53 foreach ( $categories as $c )
56 $cattitles[$c] = $t->getDBkey();
59 $this->addTables( array( 'category', 'page', 'page_props' ) );
60 $this->addJoinConds( array(
61 'page' => array( 'LEFT JOIN', array(
62 'page_namespace' => NS_CATEGORY
,
63 'page_title=cat_title' ) ),
64 'page_props' => array( 'LEFT JOIN', array(
66 'pp_propname' => 'hiddencat' ) ),
69 $this->addFields( array( 'cat_title', 'cat_pages', 'cat_subcats', 'cat_files', 'pp_propname AS cat_hidden' ) );
70 $this->addWhere( array( 'cat_title' => $cattitles ) );
72 if ( !is_null( $params['continue'] ) )
74 $title = $this->getDB()->addQuotes( $params['continue'] );
75 $this->addWhere( "cat_title >= $title" );
77 $this->addOption( 'ORDER BY', 'cat_title' );
80 $res = $this->select( __METHOD__
);
82 $catids = array_flip( $cattitles );
83 while ( $row = $db->fetchObject( $res ) )
86 $vals['size'] = intval( $row->cat_pages
);
87 $vals['pages'] = $row->cat_pages
- $row->cat_subcats
- $row->cat_files
;
88 $vals['files'] = intval( $row->cat_files
);
89 $vals['subcats'] = intval( $row->cat_subcats
);
90 if ( $row->cat_hidden
)
92 $fit = $this->addPageSubItems( $catids[$row->cat_title
], $vals );
95 $this->setContinueEnumParameter( 'continue', $row->cat_title
);
99 $db->freeResult( $res );
102 public function getAllowedParams() {
108 public function getParamDescription() {
110 'continue' => 'When more results are available, use this to continue',
114 public function getDescription() {
115 return 'Returns information about the given categories';
118 protected function getExamples() {
119 return "api.php?action=query&prop=categoryinfo&titles=Category:Foo|Category:Bar";
122 public function getVersion() {
123 return __CLASS__
. ': $Id$';