Public Member Functions | |
__construct ($main, $action) | |
execute () | |
Evaluates the parameters, performs the requested query, and sets up the result. | |
mustBePosted () | |
Indicates whether this module must be called with a POST request. | |
isWriteMode () | |
Indicates whether this module requires write mode. | |
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. | |
getPossibleErrors () | |
Returns a list of all possible errors returned by the module. | |
needsToken () | |
Returns whether this module requires a Token to execute. | |
getTokenSalt () | |
Returns the token salt if there is one, '' if the module doesn't require a salt, else false if the module doesn't need a token. | |
getVersion () | |
Returns a string that identifies the version of the extending class. | |
Protected Member Functions | |
getExamples () | |
Returns usage examples for this module. |
Definition at line 33 of file ApiUserrights.php.
ApiUserrights::__construct | ( | $ | main, | |
$ | action | |||
) |
ApiUserrights::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 39 of file ApiUserrights.php.
References ApiBase::extractRequestParams(), ApiBase::getModuleName(), and ApiBase::getResult().
ApiUserrights::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 65 of file ApiUserrights.php.
References User::getAllGroups(), ApiBase::PARAM_DFLT, ApiBase::PARAM_ISMULTI, and ApiBase::PARAM_TYPE.
ApiUserrights::getDescription | ( | ) |
Returns the description string for this module.
Reimplemented from ApiBase.
Definition at line 93 of file ApiUserrights.php.
ApiUserrights::getExamples | ( | ) | [protected] |
Returns usage examples for this module.
Return null if no examples are available.
Reimplemented from ApiBase.
Definition at line 123 of file ApiUserrights.php.
ApiUserrights::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 83 of file ApiUserrights.php.
ApiUserrights::getPossibleErrors | ( | ) |
Returns a list of all possible errors returned by the module.
Reimplemented from ApiBase.
Definition at line 99 of file ApiUserrights.php.
ApiUserrights::getTokenSalt | ( | ) |
Returns the token salt if there is one, '' if the module doesn't require a salt, else false if the module doesn't need a token.
Reimplemented from ApiBase.
Definition at line 109 of file ApiUserrights.php.
References ApiBase::dieUsageMsg(), and ApiBase::extractRequestParams().
ApiUserrights::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 129 of file ApiUserrights.php.
ApiUserrights::isWriteMode | ( | ) |
Indicates whether this module requires write mode.
Reimplemented from ApiBase.
Definition at line 61 of file ApiUserrights.php.
ApiUserrights::mustBePosted | ( | ) |
Indicates whether this module must be called with a POST request.
Reimplemented from ApiBase.
Definition at line 57 of file ApiUserrights.php.
ApiUserrights::needsToken | ( | ) |
Returns whether this module requires a Token to execute.
Reimplemented from ApiBase.
Definition at line 105 of file ApiUserrights.php.