ApiHelp Class Reference
[API]

This is a simple class to handle action=help. More...

Inherits ApiBase.

List of all members.

Public Member Functions

 __construct ($main, $action)
 execute ()
 Stub module for displaying help when no parameters are given.
 shouldCheckMaxlag ()
 Indicates if this module needs maxlag to be checked.
 isReadMode ()
 Indicates whether this module requires read rights.
 getDescription ()
 Returns the description string for this module.
 getVersion ()
 Returns a string that identifies the version of the extending class.


Detailed Description

This is a simple class to handle action=help.

Definition at line 36 of file ApiHelp.php.


Constructor & Destructor Documentation

ApiHelp::__construct ( main,
action 
)

Definition at line 38 of file ApiHelp.php.

References $action.


Member Function Documentation

ApiHelp::execute (  ) 

Stub module for displaying help when no parameters are given.

Reimplemented from ApiBase.

Definition at line 45 of file ApiHelp.php.

References ApiBase::dieUsage().

ApiHelp::getDescription (  ) 

Returns the description string for this module.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 57 of file ApiHelp.php.

ApiHelp::getVersion (  ) 

Returns a string that identifies the version of the extending class.

Typically includes the class name, the svn revision, timestamp, and last author. Usually done with SVN's Id keyword

Returns:
string

Reimplemented from ApiBase.

Definition at line 63 of file ApiHelp.php.

ApiHelp::isReadMode (  ) 

Indicates whether this module requires read rights.

Returns:
bool

Reimplemented from ApiBase.

Definition at line 53 of file ApiHelp.php.

ApiHelp::shouldCheckMaxlag (  ) 

Indicates if this module needs maxlag to be checked.

Returns:
bool

Reimplemented from ApiBase.

Definition at line 49 of file ApiHelp.php.


The documentation for this class was generated from the following file:

Generated on Sat Sep 5 02:08:30 2009 for MediaWiki by  doxygen 1.5.9