Inherits ApiQueryBase.
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. | |
getParamDescription () | |
Returns an array of parameter descriptions. | |
getDescription () | |
Returns the description string for this module. | |
getVersion () | |
Returns a string that identifies the version of the extending class. | |
Protected Member Functions | |
getCurrentUserInfo () | |
getRateLimits () | |
getExamples () | |
Returns usage examples for this module. |
Definition at line 36 of file ApiQueryUserInfo.php.
ApiQueryUserInfo::__construct | ( | $ | query, | |
$ | moduleName | |||
) |
Definition at line 38 of file ApiQueryUserInfo.php.
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 42 of file ApiQueryUserInfo.php.
References $result, ApiBase::extractRequestParams(), getCurrentUserInfo(), ApiBase::getModuleName(), and ApiBase::getResult().
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.
Reimplemented from ApiBase.
Definition at line 137 of file ApiQueryUserInfo.php.
References ApiBase::PARAM_DFLT, ApiBase::PARAM_ISMULTI, and ApiBase::PARAM_TYPE.
ApiQueryUserInfo::getCurrentUserInfo | ( | ) | [protected] |
Definition at line 56 of file ApiQueryUserInfo.php.
References $result, $wgUser, User::getDefaultOptions(), ApiBase::getMain(), getRateLimits(), ApiBase::getResult(), wfTimestamp(), and User::whoIs().
Referenced by execute().
ApiQueryUserInfo::getDescription | ( | ) |
Returns the description string for this module.
Reimplemented from ApiBase.
Definition at line 172 of file ApiQueryUserInfo.php.
ApiQueryUserInfo::getExamples | ( | ) | [protected] |
Returns usage examples for this module.
Return null if no examples are available.
Reimplemented from ApiBase.
Definition at line 176 of file ApiQueryUserInfo.php.
ApiQueryUserInfo::getParamDescription | ( | ) |
Returns an array of parameter descriptions.
Don't call this functon directly: use getFinalParamDescription() to allow hooks to modify descriptions as needed.
Reimplemented from ApiBase.
Definition at line 157 of file ApiQueryUserInfo.php.
ApiQueryUserInfo::getRateLimits | ( | ) | [protected] |
Definition at line 104 of file ApiQueryUserInfo.php.
References $action, $wgRateLimits, and $wgUser.
Referenced by getCurrentUserInfo().
ApiQueryUserInfo::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
Reimplemented from ApiBase.
Definition at line 183 of file ApiQueryUserInfo.php.