5 * Created on Sep 7, 2006
7 * API for MediaWiki 1.8+
9 * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
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.
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.
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
27 if (!defined('MEDIAWIKI')) {
28 // Eclipse helper - will be ignored in production
29 require_once ('ApiBase.php');
32 abstract class ApiQueryBase
extends ApiBase
{
34 private $mQueryModule, $mModuleName, $mGenerator;
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;
44 * Override this method to request extra fields from the pageSet
45 * using $this->getPageSet()->requestField('fieldName')
47 public function requestExtraData() {
51 * Get the main Query module
53 public function getQuery() {
54 return $this->mQueryModule
;
58 * Get the name of the query being executed by this instance
60 public function getModuleName() {
61 return $this->mModuleName
;
65 * Get the Query database connection (readonly)
67 protected function getDB() {
68 return $this->getQuery()->getDB();
72 * Get the PageSet object to work on
73 * @return ApiPageSet data
75 protected function getPageSet() {
76 return $this->mQueryModule
->getPageSet();
80 * Return true if this instance is being used as a generator.
82 protected function getIsGenerator() {
83 return $this->mGenerator
;
87 * Derived classes return true when they can be used as title generators for other query modules.
89 public function getCanGenerate() {
93 public static function titleToKey($title) {
94 return str_replace(' ', '_', $title);
97 public static function keyToTitle($key) {
98 return str_replace('_', ' ', $key);
101 public static function getBaseVersion() {
102 return __CLASS__
. ': $Id$';