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

Inheritance diagram for ApiHelp:

Collaboration diagram for ApiHelp:

Public Member Functions
	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.
	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.

Member Function Documentation

ApiHelp::buildModuleHelp	(	$	module,
		$	type
	)		`[private]`

Parameters:

$module	ApiBase
$type	String What type of request is this? e.g. action, query, list, prop, meta, format

Returns:: string

Definition at line 111 of file ApiHelp.php.

References ApiMain\makeHelpMsgHeader().

Referenced by execute().

ApiHelp::execute ( )

Module for displaying help.

Reimplemented from ApiBase.

Definition at line 37 of file ApiHelp.php.

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

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.

Some derived classes may choose to handle an integer $flags parameter in the overriding methods. Callers of this method can pass zero or more OR-ed flags like GET_VALUES_FOR_HELP.

Returns:: array|bool

Reimplemented from ApiBase.

Definition at line 130 of file ApiHelp.php.

References array(), ApiBase\PARAM_DEPRECATED, and 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 149 of file ApiHelp.php.

ApiHelp::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:: bool|string|array

Reimplemented from ApiBase.

Definition at line 153 of file ApiHelp.php.

References array().

ApiHelp::getHelpUrls ( )

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

Reimplemented from ApiBase.

Definition at line 162 of file ApiHelp.php.

References array().

ApiHelp::getParamDescription ( )

Returns an array of parameter descriptions.

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

Returns:: array|bool False on no parameter descriptions

Reimplemented from ApiBase.

Definition at line 142 of file ApiHelp.php.

References array().

ApiHelp::isReadMode ( )

Indicates whether this module requires read rights.

Returns:: bool

Reimplemented from ApiBase.

Definition at line 126 of file ApiHelp.php.

ApiHelp::shouldCheckMaxlag ( )

Indicates if this module needs maxlag to be checked.

Returns:: bool

Reimplemented from ApiBase.

Definition at line 122 of file ApiHelp.php.

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

includes/api/ApiHelp.php

Public Member Functions

Private Member Functions

Detailed Description

Member Function Documentation