Inheritance diagram for ApiTokens:

Collaboration diagram for ApiTokens:

Public Member Functions
	__construct ($main, $action)
	execute ()
	Evaluates the parameters, performs the requested query, and sets up the result.
	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.
	getParamDescription ()
	Returns an array of parameter descriptions.
	getResultProperties ()
	Returns possible properties in the result, grouped by the value of the prop parameter that shows them.
	getVersion ()
	Returns a string that identifies the version of the extending class.
Protected Member Functions
	getExamples ()
	Returns usage examples for this module.
Private Member Functions
	getTokenTypes ()

Detailed Description

Definition at line 31 of file ApiTokens.php.

Constructor & Destructor Documentation

ApiTokens::__construct	(	$	main,
		$	action
	)

Definition at line 33 of file ApiTokens.php.

Member Function Documentation

ApiTokens::execute ( )

Evaluates the parameters, performs the requested query, and sets up the result.

Concrete implementations of ApiBase must override this method to provide whatever functionality their module offers. Implementations must not produce any output on their own and are not expected to handle any errors.

The execute() method will be invoked directly by ApiMain immediately before the result of the module is output. Aside from the constructor, implementations should assume that no other methods will be called externally on the module before the result is processed.

The result data should be stored in the ApiResult object available through getResult().

Reimplemented from ApiBase.

Definition at line 37 of file ApiTokens.php.

References $params, $res, ApiBase\extractRequestParams(), ApiBase\getModuleName(), ApiBase\getResult(), getTokenTypes(), ApiBase\setWarning(), wfProfileIn(), and wfProfileOut().

ApiTokens::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|bool

Reimplemented from ApiBase.

Definition at line 82 of file ApiTokens.php.

References getTokenTypes(), ApiBase\PARAM_DFLT, ApiBase\PARAM_ISMULTI, and ApiBase\PARAM_TYPE.

ApiTokens::getDescription ( )

Returns the description string for this module.

Returns:: mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 149 of file ApiTokens.php.

ApiTokens::getExamples ( ) [protected]

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 ApiTokens.php.

ApiTokens::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|bool False on no parameter descriptions

Reimplemented from ApiBase.

Definition at line 143 of file ApiTokens.php.

ApiTokens::getResultProperties ( )

Returns possible properties in the result, grouped by the value of the prop parameter that shows them.

Properties that are shown always are in a group with empty string as a key. Properties that can be shown by several values of prop are included multiple times. If some properties are part of a list and some are on the root object (see ApiQueryQueryPage), those on the root object are under the key PROP_ROOT. The array can also contain a boolean under the key PROP_LIST, indicating whether the result is a list.

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