Inherits ApiBase.
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. |
Definition at line 36 of file ApiHelp.php.
ApiHelp::__construct | ( | $ | main, | |
$ | action | |||
) |
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.
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
Reimplemented from ApiBase.
Definition at line 63 of file ApiHelp.php.
ApiHelp::isReadMode | ( | ) |
Indicates whether this module requires read rights.
Reimplemented from ApiBase.
Definition at line 53 of file ApiHelp.php.
ApiHelp::shouldCheckMaxlag | ( | ) |
Indicates if this module needs maxlag to be checked.
Reimplemented from ApiBase.
Definition at line 49 of file ApiHelp.php.