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         /**
  56          * Get the Query database connection (readonly)
  57          */
  58         protected function getDB() {
  59                 return $this->getQuery()->getDB();
  60         }
  61
  62         /**
  63          * Get the PageSet object to work on
  64          * @return ApiPageSet data
  65          */
  66         protected function getPageSet() {
  67                 return $this->mQueryModule->getPageSet();
  68         }
  69
  70         public static function titleToKey($title) {
  71                 return str_replace(' ', '_', $title);
  72         }
  73
  74         public static function keyToTitle($key) {
  75                 return str_replace('_', ' ', $key);
  76         }
  77
  78         public static function getBaseVersion() {
  79                 return __CLASS__ . ': $Id$';
  80         }
  81 }
  82
  83 abstract class ApiQueryGeneratorBase extends ApiQueryBase {
  84
  85         private $mIsGenerator;
  86
  87         public function __construct($query, $moduleName, $paramPrefix = '') {
  88                 parent :: __construct($query, $moduleName, $paramPrefix);
  89                 $mIsGenerator = false;
  90         }
  91
  92         public function setGeneratorMode() {
  93                 $this->mIsGenerator = true;
  94         }
  95
  96         /**
  97          * Overrides base class to prepend 'g' to every generator parameter
  98          */
  99         public function encodeParamName($paramName) {
 100                 if ($this->mIsGenerator)
 101                         return 'g' . parent :: encodeParamName($paramName);
 102                 else
 103                         return parent :: encodeParamName($paramName);
 104         }
 105
 106         /**
 107          * Execute this module as a generator
 108          * @param $resultPageSet PageSet: All output should be appended to this object
 109          */
 110         public abstract function executeGenerator($resultPageSet);
 111 }
 112 ?>