wiki.techinc.nl/includes/api/ApiQuery.php

104 lines
No EOL
2.5 KiB
PHP

<?php
/*
* Created on Sep 7, 2006
*
* API for MediaWiki 1.8+
*
* Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
* http://www.gnu.org/copyleft/gpl.html
*/
if (!defined('MEDIAWIKI')) {
// Eclipse helper - will be ignored in production
require_once ("ApiBase.php");
}
class ApiQuery extends ApiBase {
private static $apiAutoloadClasses_Query = array (
'ApiQueryContent' => 'includes/api/ApiQueryContent.php',
);
private static $sQueryModules = array (
'content' => 'ApiQueryContent'
);
/**
* Constructor
*/
public function __construct($main, $action) {
parent :: __construct($main);
ApiInitAutoloadClasses($this->apiAutoloadClasses_Query);
$this->mModuleNames = array_keys($this->sQueryModules);
$this->mDb =& wfGetDB( DB_SLAVE );
}
public function GetDB() {
return $this->mDb;
}
public function Execute() {
}
/**
* Returns an array of allowed parameters (keys) => default value for that parameter
*/
protected function GetAllowedParams() {
return array (
'what' => 'default',
'enumparam' => array (
GN_ENUM_DFLT => null,
GN_ENUM_ISMULTI => true,
GN_ENUM_CHOICES => $this->mModuleNames
)
);
}
/**
* Returns the description string for this module
*/
protected function GetDescription() {
return 'module a';
}
/**
* Returns usage examples for this module. Return null if no examples are available.
*/
protected function GetExamples() {
return array (
'http://...'
);
}
/**
* Returns the description string for the given parameter.
*/
protected function GetParamDescription($paramName) {
switch ($paramName) {
case 'param' :
return 'description';
default :
return parent :: GetParamDescription($paramName);
}
}
}
?>