Query module to get information about the currently logged-in user. More...

Inheritance diagram for ApiQueryUserInfo:

Collaboration diagram for ApiQueryUserInfo:

Public Member Functions
	__construct ($query, $moduleName)
	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.
	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.
Protected Member Functions
	getCurrentUserInfo ()
	getRateLimits ()
Private Attributes
	$prop = array()

Detailed Description

Query module to get information about the currently logged-in user.

Definition at line 32 of file ApiQueryUserInfo.php.

Constructor & Destructor Documentation

ApiQueryUserInfo::__construct	(	$	query,
		$	moduleName
	)

Definition at line 36 of file ApiQueryUserInfo.php.

Member Function Documentation

ApiQueryUserInfo::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 40 of file ApiQueryUserInfo.php.

References $result, ApiBase\extractRequestParams(), getCurrentUserInfo(), ApiBase\getModuleName(), and ApiBase\getResult().

Here is the call graph for this function:

ApiQueryUserInfo::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.