Module to fetch tokens via action=query&meta=tokens. More...

Inheritance diagram for ApiQueryTokens:

Collaboration diagram for ApiQueryTokens:

Public Member Functions
	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.
	getCacheMode ($params)
	Get the cache mode for the data generated by this module.
	getDescription ()
	Returns the description string for this module.
	getParamDescription ()
	Returns an array of parameter descriptions.
Static Public Member Functions
static	getTokenTypeSalts ()
Protected Member Functions
	getExamples ()
	Returns usage examples for this module.

Detailed Description

Module to fetch tokens via action=query&meta=tokens.

Since:: 1.24

Definition at line 34 of file ApiQueryTokens.php.

Member Function Documentation

ApiQueryTokens::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 36 of file ApiQueryTokens.php.

References $params, $res, $type, array(), as, ApiBase\extractRequestParams(), ApiBase\getMain(), ApiBase\getModuleName(), ContextSource\getRequest(), ApiBase\getResult(), getTokenTypeSalts(), ContextSource\getUser(), and ApiBase\setWarning().

ApiQueryTokens::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 74 of file ApiQueryTokens.php.

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

ApiQueryTokens::getCacheMode ( $ params )

Get the cache mode for the data generated by this module.

Override this in the module subclass. For possible return values and other details about cache modes, see ApiMain::setCacheMode()

Public caching will only be allowed if *all* the modules that supply data for a given request return a cache mode of public.

Parameters:

array $params

Returns:: string

Reimplemented from ApiQueryBase.

Definition at line 101 of file ApiQueryTokens.php.

ApiQueryTokens::getDescription ( )

Returns the description string for this module.

Returns:: string|array

Reimplemented from ApiBase.

Definition at line 90 of file ApiQueryTokens.php.

ApiQueryTokens::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 94 of file ApiQueryTokens.php.

References array().

ApiQueryTokens::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 84 of file ApiQueryTokens.php.

References array().

static ApiQueryTokens::getTokenTypeSalts ( ) [static]

Definition at line 55 of file ApiQueryTokens.php.

References array(), wfProfileIn(), wfProfileOut(), and wfRunHooks().

Referenced by execute().

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

includes/api/ApiQueryTokens.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation