includes/api/ApiQuery.php

   1 <?php
   2
   3
   4 /*
   5  * Created on Sep 7, 2006
   6  *
   7  * API for MediaWiki 1.8+
   8  *
   9  * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License along
  22  * with this program; if not, write to the Free Software Foundation, Inc.,
  23  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  24  * http://www.gnu.org/copyleft/gpl.html
  25  */
  26
  27 if (!defined('MEDIAWIKI')) {
  28         // Eclipse helper - will be ignored in production
  29         require_once ("ApiBase.php");
  30 }
  31
  32 class ApiQuery extends ApiBase {
  33
  34         private $mQueryPropModules = array (
  35                 'content' => 'ApiQueryContent'
  36         );
  37         private $mQueryListModules = array (
  38                 'backlinks' => 'ApiQueryBacklinks'
  39         );
  40
  41         private $mSlaveDB = null;
  42
  43         /**
  44         * Constructor
  45         */
  46         public function __construct($main, $action) {
  47                 parent :: __construct($main);
  48                 $this->mPropModuleNames = array_keys($this->mQueryPropModules);
  49                 $this->mListModuleNames = array_keys($this->mQueryListModules);
  50         }
  51
  52         public function GetDB() {
  53                 if (!isset ($this->mSlaveDB))
  54                         $this->mSlaveDB = & wfGetDB(DB_SLAVE);
  55                 return $this->mSlaveDB;
  56         }
  57
  58         public function Execute() {
  59
  60         }
  61
  62         /**
  63          * Returns an array of allowed parameters (keys) => default value for that parameter
  64          */
  65         protected function GetAllowedParams() {
  66                 return array (
  67                         'titles' => array (
  68                                 GN_ENUM_DFLT => null,
  69                                 GN_ENUM_ISMULTI => true
  70                         ),
  71                         'pageids' => array (
  72                                 GN_ENUM_DFLT => 0,
  73                                 GN_ENUM_ISMULTI => true
  74                         ),
  75                         'revids' => array (
  76                                 GN_ENUM_DFLT => 0,
  77                                 GN_ENUM_ISMULTI => true
  78                         ),
  79                         'prop' => array (
  80                                 GN_ENUM_DFLT => null,
  81                                 GN_ENUM_ISMULTI => true,
  82                                 GN_ENUM_CHOICES => array_keys($this->mPropModuleNames
  83                         )
  84                 ), 'list' => array (
  85                         GN_ENUM_DFLT => null,
  86                         GN_ENUM_ISMULTI => true,
  87                         GN_ENUM_CHOICES => array_keys($this->mListModuleNames
  88                 )));
  89         }
  90
  91         /**
  92          * Returns the description string for this module
  93          */
  94         protected function GetDescription() {
  95                 return 'Query Module';
  96         }
  97
  98         /**
  99          * Returns usage examples for this module. Return null if no examples are available.
 100          */
 101         protected function GetExamples() {
 102                 return array (
 103                         'api.php ? action=query & what=content & titles=ArticleA|ArticleB'
 104                 );
 105         }
 106 }
 107 ?>