includes/api/ApiQueryCategories.php

   1 <?php
   2
   3 /*
   4  * Created on May 13, 2007
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
   9  *
  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.
  14  *
  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.
  19  *
  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
  24  */
  25
  26 if (!defined('MEDIAWIKI')) {
  27         // Eclipse helper - will be ignored in production
  28         require_once ("ApiQueryBase.php");
  29 }
  30
  31 /**
  32  * @addtogroup API
  33  */
  34 class ApiQueryCategories extends ApiQueryGeneratorBase {
  35
  36         public function __construct($query, $moduleName) {
  37                 parent :: __construct($query, $moduleName, 'cl');
  38         }
  39
  40         public function execute() {
  41                 $this->run();
  42         }
  43
  44         public function executeGenerator($resultPageSet) {
  45                 $this->run($resultPageSet);
  46         }
  47
  48         private function run($resultPageSet = null) {
  49
  50                 $params = $this->extractRequestParams();
  51                 $prop = $params['prop'];
  52
  53                 $this->addFields(array (
  54                         'cl_from',
  55                         'cl_to'
  56                 ));
  57
  58                 $fld_sortkey = false;
  59                 if (!is_null($prop)) {
  60                         foreach($prop as $p) {
  61                                 switch ($p) {
  62                                         case 'sortkey':
  63                                                 $this->addFields('cl_sortkey');
  64                                                 $fld_sortkey = true;
  65                                                 break;
  66                                         default :
  67                                                 ApiBase :: dieDebug(__METHOD__, "Unknown prop=$p");
  68                                 }
  69                         }
  70                 }
  71
  72                 $this->addTables('categorylinks');
  73                 $this->addWhereFld('cl_from', array_keys($this->getPageSet()->getGoodTitles()));
  74                 $this->addOption('ORDER BY', "cl_from, cl_to");
  75
  76                 $db = $this->getDB();
  77                 $res = $this->select(__METHOD__);
  78
  79                 if (is_null($resultPageSet)) {
  80
  81                         $data = array();
  82                         $lastId = 0;    // database has no ID 0
  83                         while ($row = $db->fetchObject($res)) {
  84                                 if ($lastId != $row->cl_from) {
  85                                         if($lastId != 0) {
  86                                                 $this->addPageSubItems($lastId, $data);
  87                                                 $data = array();
  88                                         }
  89                                         $lastId = $row->cl_from;
  90                                 }
  91
  92                                 $title = Title :: makeTitle(NS_CATEGORY, $row->cl_to);
  93                                 $vals = array();
  94                                 ApiQueryBase :: addTitleInfo($vals, $title);
  95                                 if ($fld_sortkey)
  96                                         $vals['sortkey'] = $row->cl_sortkey;
  97                                 $data[] = $vals;
  98                         }
  99
 100                         if($lastId != 0) {
 101                                 $this->addPageSubItems($lastId, $data);
 102                         }
 103
 104                 } else {
 105
 106                         $titles = array();
 107                         while ($row = $db->fetchObject($res)) {
 108                                 $titles[] = Title :: makeTitle(NS_CATEGORY, $row->cl_to);
 109                         }
 110                         $resultPageSet->populateFromTitles($titles);
 111                 }
 112
 113                 $db->freeResult($res);
 114         }
 115
 116         private function addPageSubItems($pageId, $data) {
 117                 $result = $this->getResult();
 118                 $result->setIndexedTagName($data, 'cl');
 119                 $result->addValue(array ('query', 'pages', intval($pageId)),
 120                         'categories',
 121                         $data);
 122         }
 123
 124         protected function getAllowedParams() {
 125                 return array (
 126                         'prop' => array (
 127                                 ApiBase :: PARAM_ISMULTI => true,
 128                                 ApiBase :: PARAM_TYPE => array (
 129                                         'sortkey',
 130                                 )
 131                         )
 132                 );
 133         }
 134
 135         protected function getParamDescription() {
 136                 return array (
 137                         'prop' => 'Which additional properties to get for each category.',
 138                 );
 139         }
 140
 141         protected function getDescription() {
 142                 return 'Returns all links from the given page(s)';
 143         }
 144
 145         protected function getExamples() {
 146                 return array (
 147                                 "Get a list of categories used in the [[Albert Einstein]]:",
 148                                 "  api.php?action=query&prop=categories&titles=Albert%20Einstein",
 149                                 "Get information about all categories used in the [[Albert Einstein]]:",
 150                                 "  api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info"
 151                         );
 152         }
 153
 154         public function getVersion() {
 155                 return __CLASS__ . ': $Id$';
 156         }
 157 }
 158 ?>