MediaWiki  REL1_19
Public Member Functions | Private Member Functions
ApiHelp Class Reference
API

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

Inheritance diagram for ApiHelp:
Inheritance graph
[legend]
Collaboration diagram for ApiHelp:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 __construct ($main, $action)
 execute ()
 Module for displaying help.
 getAllowedParams ()
 Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed.
 getDescription ()
 Returns the description string for this module.
 getExamples ()
 Returns usage examples for this module.
 getHelpUrls ()
 getParamDescription ()
 Returns an array of parameter descriptions.
 getVersion ()
 Returns a string that identifies the version of the extending class.
 isReadMode ()
 Indicates whether this module requires read rights.
 shouldCheckMaxlag ()
 Indicates if this module needs maxlag to be checked.

Private Member Functions

 buildModuleHelp ($module, $type)

Detailed Description

This is a simple class to handle action=help.

Definition at line 32 of file ApiHelp.php.

Constructor & Destructor Documentation

ApiHelp::__construct ( $  main,
$  action 
)

Definition at line 34 of file ApiHelp.php.

Member Function Documentation

ApiHelp::buildModuleHelp ( $  module,
$  type 
) [private]
Parameters:
$moduleApiBase
$typeString What type of request is this? e.g. action, query, list, prop, meta, format
Returns:
string

Definition at line 96 of file ApiHelp.php.

References ApiMain\makeHelpMsgHeader().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiHelp::execute ( )

Module for displaying help.

Reimplemented from ApiBase.

Definition at line 41 of file ApiHelp.php.

References $result, buildModuleHelp(), ApiBase\dieUsage(), ApiBase\extractRequestParams(), ApiBase\getMain(), ApiBase\getModuleName(), and ApiBase\getResult().

Here is the call graph for this function:

ApiHelp::getAllowedParams ( )

Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed.

Returns:
array or false

Reimplemented from ApiBase.

Definition at line 115 of file ApiHelp.php.

References ApiBase\PARAM_ISMULTI.

ApiHelp::getDescription ( )

Returns the description string for this module.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 133 of file ApiHelp.php.

ApiHelp::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:
false|string|array

Reimplemented from ApiBase.

Definition at line 137 of file ApiHelp.php.

ApiHelp::getHelpUrls ( )
Returns:
false|string|array Returns a false if the module has no help url, else returns a (array of) string

Reimplemented from ApiBase.

Definition at line 147 of file ApiHelp.php.

ApiHelp::getParamDescription ( )

Returns an array of parameter descriptions.

Don't call this functon directly: use getFinalParamDescription() to allow hooks to modify descriptions as needed.

Returns:
array or false

Reimplemented from ApiBase.

Definition at line 126 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 155 of file ApiHelp.php.

ApiHelp::isReadMode ( )

Indicates whether this module requires read rights.

Returns:
bool

Reimplemented from ApiBase.

Definition at line 111 of file ApiHelp.php.

ApiHelp::shouldCheckMaxlag ( )

Indicates if this module needs maxlag to be checked.

Returns:
bool

Reimplemented from ApiBase.

Definition at line 107 of file ApiHelp.php.

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