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;
  35
  36         public function __construct($query, $moduleName, $paramPrefix = '') {
  37                 parent :: __construct($query->getMain(), $moduleName, $paramPrefix);
  38                 $this->mQueryModule = $query;
  39         }
  40
  41         /**
  42          * Override this method to request extra fields from the pageSet
  43          * using $this->getPageSet()->requestField('fieldName')
  44          */
  45         public function requestExtraData() {
  46         }
  47
  48         /**
  49          * Get the main Query module
  50          */
  51         public function getQuery() {
  52                 return $this->mQueryModule;
  53         }
  54
  55         protected function setContinueEnumParameter($paramName, $paramValue) {
  56                 $msg = array (
  57                         $this->encodeParamName($paramName
  58                 ) => $paramValue);
  59                 $this->getResult()->addValue('query-continue', $this->getModuleName(), $msg);
  60         }
  61
  62         /**
  63          * Get the Query database connection (readonly)
  64          */
  65         protected function getDB() {
  66                 return $this->getQuery()->getDB();
  67         }
  68
  69         /**
  70          * Get the PageSet object to work on
  71          * @return ApiPageSet data
  72          */
  73         protected function getPageSet() {
  74                 return $this->mQueryModule->getPageSet();
  75         }
  76
  77         public static function titleToKey($title) {
  78                 return str_replace(' ', '_', $title);
  79         }
  80
  81         public static function keyToTitle($key) {
  82                 return str_replace('_', ' ', $key);
  83         }
  84
  85         public static function getBaseVersion() {
  86                 return __CLASS__ . ': $Id$';
  87         }
  88 }
  89
  90 abstract class ApiQueryGeneratorBase extends ApiQueryBase {
  91
  92         private $mIsGenerator;
  93
  94         public function __construct($query, $moduleName, $paramPrefix = '') {
  95                 parent :: __construct($query, $moduleName, $paramPrefix);
  96                 $mIsGenerator = false;
  97         }
  98
  99         public function setGeneratorMode() {
 100                 $this->mIsGenerator = true;
 101         }
 102
 103         /**
 104          * Overrides base class to prepend 'g' to every generator parameter
 105          */
 106         public function encodeParamName($paramName) {
 107                 if ($this->mIsGenerator)
 108                         return 'g' . parent :: encodeParamName($paramName);
 109                 else
 110                         return parent :: encodeParamName($paramName);
 111         }
 112
 113         /**
 114          * Execute this module as a generator
 115          * @param $resultPageSet PageSet: All output should be appended to this object
 116          */
 117         public abstract function executeGenerator($resultPageSet);
 118 }
 119 ?>