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 * A query module to enumerate categories the set of pages belong to.
36 class ApiQueryCategories
extends ApiQueryGeneratorBase
{
38 public function __construct($query, $moduleName) {
39 parent
:: __construct($query, $moduleName, 'cl');
42 public function execute() {
46 public function executeGenerator($resultPageSet) {
47 $this->run($resultPageSet);
50 private function run($resultPageSet = null) {
52 if ($this->getPageSet()->getGoodTitleCount() == 0)
53 return; // nothing to do
55 $params = $this->extractRequestParams();
56 $prop = $params['prop'];
58 $this->addFields(array (
63 $fld_sortkey = $fld_timestamp = false;
64 if (!is_null($prop)) {
65 foreach($prop as $p) {
68 $this->addFields('cl_sortkey');
72 $this->addFields('cl_timestamp');
73 $fld_timestamp = true;
76 ApiBase
:: dieDebug(__METHOD__
, "Unknown prop=$p");
81 $this->addTables('categorylinks');
82 $this->addWhereFld('cl_from', array_keys($this->getPageSet()->getGoodTitles()));
83 $this->addOption('ORDER BY', "cl_from, cl_to");
86 $res = $this->select(__METHOD__
);
88 if (is_null($resultPageSet)) {
91 $lastId = 0; // database has no ID 0
92 while ($row = $db->fetchObject($res)) {
93 if ($lastId != $row->cl_from
) {
95 $this->addPageSubItems($lastId, $data);
98 $lastId = $row->cl_from
;
101 $title = Title
:: makeTitle(NS_CATEGORY
, $row->cl_to
);
104 ApiQueryBase
:: addTitleInfo($vals, $title);
106 $vals['sortkey'] = $row->cl_sortkey
;
108 $vals['timestamp'] = $row->cl_timestamp
;
114 $this->addPageSubItems($lastId, $data);
120 while ($row = $db->fetchObject($res)) {
121 $titles[] = Title
:: makeTitle(NS_CATEGORY
, $row->cl_to
);
123 $resultPageSet->populateFromTitles($titles);
126 $db->freeResult($res);
129 public function getAllowedParams() {
132 ApiBase
:: PARAM_ISMULTI
=> true,
133 ApiBase
:: PARAM_TYPE
=> array (
141 public function getParamDescription() {
143 'prop' => 'Which additional properties to get for each category.',
147 public function getDescription() {
148 return 'List all categories the page(s) belong to';
151 protected function getExamples() {
153 "Get a list of categories [[Albert Einstein]] belongs to:",
154 " api.php?action=query&prop=categories&titles=Albert%20Einstein",
155 "Get information about all categories used in the [[Albert Einstein]]:",
156 " api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info"
160 public function getVersion() {
161 return __CLASS__
. ': $Id$';