includes/api/ApiQueryBase.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 abstract class ApiQueryBase extends ApiBase {
  33
  34         private $mQueryModule, $mModuleName, $mIsGenerator;
  35
  36         public function __construct($query, $moduleName, $isGenerator = false) {
  37                 parent :: __construct($query->getMain());
  38                 $this->mQueryModule = $query;
  39                 $this->mModuleName = $moduleName;
  40                 $this->mIsGenerator = $isGenerator;
  41         }
  42
  43         /**
  44          * Override this method to request extra fields from the pageSet
  45          * using $this->getPageSet()->requestField('fieldName')
  46          */
  47         public function requestExtraData() {
  48         }
  49
  50         /**
  51          * Get the main Query module
  52          */
  53         public function getQuery() {
  54                 return $this->mQueryModule;
  55         }
  56
  57         /**
  58          * Get the name of the query being executed by this instance
  59          */
  60         public function getModuleName() {
  61                 return $this->mModuleName;
  62         }
  63
  64         /**
  65          * Overrides base class to prepend 'g' to every generator parameter
  66          */
  67         public function extractRequestParams() {
  68                 $prefix = '';
  69                 if($this->isGenerator())
  70                         $prefix = 'g';
  71                 return parent :: extractRequestParams($prefix);
  72         }
  73
  74         /**
  75          * Get the Query database connection (readonly)
  76          */
  77         protected function getDB() {
  78                 return $this->getQuery()->getDB();
  79         }
  80
  81         /**
  82          * Get the PageSet object to work on
  83          * @return ApiPageSet data
  84          */
  85         protected function getPageSet() {
  86                 return $this->mQueryModule->getPageSet();
  87         }
  88
  89         /**
  90          * Return true if this instance is being used as a generator.
  91          */
  92         protected function isGenerator() {
  93                 return $this->mIsGenerator;
  94         }
  95
  96         /**
  97          * Derived classes return true when they can be used as title generators for other query modules.
  98          */
  99         public function getCanGenerate() {
 100                 return false;
 101         }
 102
 103         public static function titleToKey($title) {
 104                 return str_replace(' ', '_', $title);
 105         }
 106
 107         public static function keyToTitle($key) {
 108                 return str_replace('_', ' ', $key);
 109         }
 110
 111         public static function getBaseVersion() {
 112                 return __CLASS__ . ': $Id$';
 113         }
 114 }
 115 ?>