includes/api/ApiHelp.php

   1 <?php
   2
   3
   4 /*
   5  * Created on Sep 6, 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 ('ApiBase.php');
  30 }
  31
  32 class ApiHelp extends ApiBase {
  33
  34         public function __construct($main, $action) {
  35                 parent :: __construct($main, $action);
  36         }
  37
  38         /**
  39          * Stub module for displaying help when no parameters are given
  40          */
  41         public function execute() {
  42                 $this->dieUsage('', 'help');
  43         }
  44
  45         protected function getDescription() {
  46                 return array (
  47                         'Display this help screen.'
  48                 );
  49         }
  50
  51         public function getVersion() {
  52                 return __CLASS__ . ': $Id$';
  53         }
  54 }
  55 ?>