API module that facilitates the unblocking of users. More...
Public Member Functions | |
| execute () | |
| Unblocks the specified user or provides the reason the unblock failed. | |
| 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. | |
| getPossibleErrors () | |
| Returns a list of all possible errors returned by the module. | |
| getResultProperties () | |
| Returns possible properties in the result, grouped by the value of the prop parameter that shows them. | |
| 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. | |
| 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. | |
Detailed Description
API module that facilitates the unblocking of users.
Requires API write mode to be enabled.
Definition at line 33 of file ApiUnblock.php.
Member Function Documentation
Unblocks the specified user or provides the reason the unblock failed.
Reimplemented from ApiBase.
Definition at line 38 of file ApiUnblock.php.
References $params, $res, $retval, $user, array(), SpecialBlock\checkUnblockSelf(), ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), ContextSource\getContext(), User\getId(), ApiBase\getModuleName(), User\getName(), ApiBase\getResult(), ContextSource\getUser(), Block\newFromTarget(), SpecialUnblock\processUnblock(), and Block\TYPE_AUTO.
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 86 of file ApiUnblock.php.
References array(), and ApiBase\PARAM_TYPE.
Returns the description string for this module.
- Returns:
- mixed string or array of strings
Reimplemented from ApiBase.
Definition at line 130 of file ApiUnblock.php.
Returns usage examples for this module.
Return false if no examples are available.
- Returns:
- bool|string|array
Reimplemented from ApiBase.
Definition at line 152 of file ApiUnblock.php.
References array().
- 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 159 of file ApiUnblock.php.
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 97 of file ApiUnblock.php.
References array(), and ApiBase\getModulePrefix().
Returns a list of all possible errors returned by the module.
Don't call this function directly: use getFinalPossibleErrors() to allow hooks to modify parameters as needed.
- Returns:
- array in the format of array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )
Reimplemented from ApiBase.
Definition at line 134 of file ApiUnblock.php.
References array().
Returns possible properties in the result, grouped by the value of the prop parameter that shows them.
Properties that are shown always are in a group with empty string as a key. Properties that can be shown by several values of prop are included multiple times. If some properties are part of a list and some are on the root object (see ApiQueryQueryPage), those on the root object are under the key PROP_ROOT. The array can also contain a boolean under the key PROP_LIST, indicating whether the result is a list.
Don't call this function directly: use getFinalResultProperties() to allow hooks to modify descriptions as needed.
- Returns:
- array|bool False on no properties
Reimplemented from ApiBase.
Definition at line 107 of file ApiUnblock.php.
References array(), ApiBase\PROP_NULLABLE, and ApiBase\PROP_TYPE.
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 148 of file ApiUnblock.php.
Indicates whether this module requires write mode.
- Returns:
- bool
Reimplemented from ApiBase.
Definition at line 82 of file ApiUnblock.php.
Indicates whether this module must be called with a POST request.
- Returns:
- bool
Reimplemented from ApiBase.
Definition at line 78 of file ApiUnblock.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 144 of file ApiUnblock.php.
The documentation for this class was generated from the following file:
- includes/api/ApiUnblock.php
