includes/api/ApiQueryInfo.php

   1 <?php
   2
   3
   4 /*
   5  * Created on Sep 25, 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 ("ApiQueryBase.php");
  30 }
  31
  32 class ApiQueryInfo extends ApiQueryBase {
  33
  34         public function __construct($main, $moduleName, $query, $data) {
  35                 parent :: __construct($main, $moduleName, $query, $data);
  36         }
  37
  38         public function Execute() {
  39
  40         }
  41
  42         protected function GetAllowedParams() {
  43                 return array (
  44                         'param' => 'default',
  45                         'enumparam' => array (
  46                                 GN_ENUM_DFLT => 'default',
  47                                 GN_ENUM_ISMULTI => false,
  48                                 GN_ENUM_TYPE => array (
  49                                         'a',
  50                                         'b'
  51                                 )
  52                         )
  53                 );
  54         }
  55
  56         protected function GetParamDescription() {
  57                 return array();
  58         }
  59
  60         protected function GetDescription() {
  61                 return 'module a';
  62         }
  63
  64         protected function GetExamples() {
  65                 return array (
  66                         'http://...'
  67                 );
  68         }
  69 }
  70 ?>