includes/api/ApiQueryContent.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 ("ApiQueryBase.php");
  30 }
  31
  32 class ApiQueryContent extends ApiQueryBase {
  33
  34         /**
  35         * Constructor
  36         */
  37         public function __construct($main, $action) {
  38                 parent :: __construct($main);
  39         }
  40
  41         public function Execute() {
  42
  43         }
  44
  45         /**
  46          * Returns an array of allowed parameters (keys) => default value for that parameter
  47          */
  48         protected function GetAllowedParams() {
  49                 return array (
  50                         'param' => 'default',
  51                         'enumparam' => array (
  52                                 GN_ENUM_DFLT => 'default',
  53                                 GN_ENUM_ISMULTI => false,
  54                                 GN_ENUM_CHOICES => array (
  55                                         'a',
  56                                         'b'
  57                                 )
  58                         )
  59                 );
  60         }
  61
  62         /**
  63          * Returns the description string for this module
  64          */
  65         protected function GetDescription() {
  66                 return 'module a';
  67         }
  68
  69         /**
  70          * Returns usage examples for this module. Return null if no examples are available.
  71          */
  72         protected function GetExamples() {
  73                 return array (
  74                         'http://...'
  75                 );
  76         }
  77 }
  78 ?>