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, $mGenerator;
  35
  36         public function __construct($query, $moduleName, $generator = false) {
  37                 parent :: __construct($query->GetMain());
  38                 $this->mQueryModule = $query;
  39                 $this->mModuleName = $moduleName;
  40                 $this->mGenerator = $generator;
  41         }
  42
  43         /**
  44          * Get the main Query module
  45          */
  46         public function GetQuery() {
  47                 return $this->mQueryModule;
  48         }
  49
  50         /**
  51          * Get the name of the query being executed by this instance
  52          */
  53         public function GetModuleName() {
  54                 return $this->mModuleName;
  55         }
  56
  57         /**
  58          * Get the Query database connection (readonly)
  59          */
  60         protected function GetDB() {
  61                 return $this->GetQuery()->GetDB();
  62         }
  63
  64         /**
  65          * Get the PageSet object to work on
  66          */
  67         protected function GetData() {
  68                 return $this->mQueryModule->GetData();
  69         }
  70
  71         /**
  72          * Return true if this instance is being used as a generator.
  73          */
  74         protected function GetIsGenerator() {
  75                 return $this->mGenerator;
  76         }
  77
  78         /**
  79          * Derived classes return true when they can be used as title generators for other query modules.
  80          */
  81         public function GetCanGenerate() {
  82                 return false;
  83         }
  84
  85         public static function TitleToKey($title) {
  86                 return str_replace(' ', '_', $title);
  87         }
  88         public static function KeyToTitle($key) {
  89                 return str_replace('_', ' ', $key);
  90         }
  91 }
  92 ?>