includes/api/ApiHelp.php

   1 <?php
   2
   3 /*
   4  * Created on Sep 6, 2006
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  */
  25
  26 if ( !defined( 'MEDIAWIKI' ) ) {
  27         // Eclipse helper - will be ignored in production
  28         require_once( 'ApiBase.php' );
  29 }
  30
  31 /**
  32  * This is a simple class to handle action=help
  33  *
  34  * @ingroup API
  35  */
  36 class ApiHelp extends ApiBase {
  37
  38         public function __construct( $main, $action ) {
  39                 parent::__construct( $main, $action );
  40         }
  41
  42         /**
  43          * Stub module for displaying help when no parameters are given
  44          */
  45         public function execute() {
  46                 $this->dieUsage( '', 'help' );
  47         }
  48
  49         public function shouldCheckMaxlag() {
  50                 return false;
  51         }
  52
  53         public function isReadMode() {
  54                 return false;
  55         }
  56
  57         public function getDescription() {
  58                 return array (
  59                         'Display this help screen.'
  60                 );
  61         }
  62
  63         public function getVersion() {
  64                 return __CLASS__ . ': $Id$';
  65         }
  66 }