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. | |
| getExamples () | |
| Returns usage examples for this module. | |
| getHelpUrls () | |
| getParamDescription () | |
| Returns an array of parameter descriptions. | |
| 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 You have also to override needsToken() Value is passed to User::getEditToken. | |
| getVersion () | |
| Returns a string that identifies the version of the extending class. | |
| isWriteMode () | |
| Indicates whether this module requires write mode. | |
| mustBePosted () | |
| Indicates whether this module must be called with a POST request. | |
| needsToken () | |
| Returns whether this module requires a token to execute It is used to show possible errors in action=paraminfo see bug 25248. | |
Private Member Functions | |
| getUrUser () | |
Private Attributes | |
| $mUser = null | |
Detailed Description
Definition at line 31 of file ApiUserrights.php.
Constructor & Destructor Documentation
| ApiUserrights::__construct | ( | $ | main, |
| $ | action | ||
| ) |
Definition at line 33 of file ApiUserrights.php.
Member Function Documentation
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 $params, $result, $user, ApiBase\extractRequestParams(), ApiBase\getModuleName(), ApiBase\getResult(), and getUrUser().
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 89 of file ApiUserrights.php.
References User\getAllGroups(), ApiBase\PARAM_DFLT, ApiBase\PARAM_ISMULTI, ApiBase\PARAM_REQUIRED, and ApiBase\PARAM_TYPE.
Returns the description string for this module.
- Returns:
- mixed string or array of strings
Reimplemented from ApiBase.
Definition at line 123 of file ApiUserrights.php.
Returns usage examples for this module.
Return false if no examples are available.
- Returns:
- bool|string|array
Reimplemented from ApiBase.
Definition at line 135 of file ApiUserrights.php.
- Returns:
- bool|string|array Returns a false if the module has no help url, else returns a (array of) string
Reimplemented from ApiBase.
Definition at line 141 of file ApiUserrights.php.
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 113 of file ApiUserrights.php.
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 You have also to override needsToken() Value is passed to User::getEditToken.
- Returns:
- bool|string|array
Reimplemented from ApiBase.
Definition at line 131 of file ApiUserrights.php.
References getUrUser().
| ApiUserrights::getUrUser | ( | ) | [private] |
- Returns:
- User
Definition at line 61 of file ApiUserrights.php.
References $params, $user, ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), and UserrightsPage\fetchUser().
Referenced by execute(), and getTokenSalt().
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
- Returns:
- string
Reimplemented from ApiBase.
Definition at line 145 of file ApiUserrights.php.
Indicates whether this module requires write mode.
- Returns:
- bool
Reimplemented from ApiBase.
Definition at line 85 of file ApiUserrights.php.
Indicates whether this module must be called with a POST request.
- Returns:
- bool
Reimplemented from ApiBase.
Definition at line 81 of file ApiUserrights.php.
Returns whether this module requires a token to execute It is used to show possible errors in action=paraminfo see bug 25248.
- Returns:
- bool
Reimplemented from ApiBase.
Definition at line 127 of file ApiUserrights.php.
Member Data Documentation
ApiUserrights::$mUser = null [private] |
Definition at line 37 of file ApiUserrights.php.
The documentation for this class was generated from the following file:
- includes/api/ApiUserrights.php
