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($main, $query) {
  37                 parent :: __construct($main);
  38                 $this->mQueryModule = $query;
  39         }
  40
  41         /**
  42          * Get the name of the query being executed by this instance
  43          */
  44         public function GetQuery() {
  45                 return $this->mQueryModule;
  46         }
  47
  48         /**
  49          * Derived classes return true when they can be used as title generators for other query modules.
  50          */
  51         public function GetCanGenerate() {
  52                 return false;
  53         }
  54
  55         /**
  56          * Return true if this instance is being used as a generator.
  57          */
  58         protected function GetIsGenerator() {
  59                 return false;
  60         }
  61 }
  62 ?>