API module that facilitates the blocking of users. More...
Public Member Functions | |
| execute () | |
| Blocks the user specified in the parameters for the given expiry, with the given reason, and with all other settings provided in the params. | |
| 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. | |
| isWriteMode () | |
| Indicates whether this module requires write mode. | |
| mustBePosted () | |
| Indicates whether this module must be called with a POST request. | |
| needsToken () | |
| Returns the token type this module requires in order to execute. | |
Detailed Description
API module that facilitates the blocking of users.
Requires API write mode to be enabled.
Definition at line 33 of file ApiBlock.php.
Member Function Documentation
Blocks the user specified in the parameters for the given expiry, with the given reason, and with all other settings provided in the params.
If the block succeeds, produces a result containing the details of the block and notice of success. If it fails, the result will specify the nature of the error.
Reimplemented from ApiBase.
Definition at line 41 of file ApiBlock.php.
References $params, $res, $retval, $user, array(), SpecialBlock\canBlockEmail(), SpecialBlock\checkUnblockSelf(), ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), ContextSource\getContext(), ApiBase\getDB(), User\getId(), ApiBase\getModuleName(), ApiBase\getResult(), SpecialBlock\getTargetAndType(), ContextSource\getUser(), User\isUsableName(), list, User\newFromName(), Block\newFromTarget(), SpecialBlock\processForm(), and wfTimestamp().
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 149 of file ApiBlock.php.
References array(), ApiBase\PARAM_REQUIRED, and ApiBase\PARAM_TYPE.
Returns the description string for this module.
- Returns:
- string|array
Reimplemented from ApiBase.
Definition at line 188 of file ApiBlock.php.
Returns usage examples for this module.
Return false if no examples are available.
- Returns:
- bool|string|array
Reimplemented from ApiBase.
Definition at line 196 of file ApiBlock.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 203 of file ApiBlock.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 168 of file ApiBlock.php.
References array().
Indicates whether this module requires write mode.
- Returns:
- bool
Reimplemented from ApiBase.
Definition at line 145 of file ApiBlock.php.
Indicates whether this module must be called with a POST request.
- Returns:
- bool
Reimplemented from ApiBase.
Definition at line 141 of file ApiBlock.php.
Returns the token type this module requires in order to execute.
Modules are strongly encouraged to use the core 'csrf' type unless they have specialized security needs. If the token type is not one of the core types, you must use the ApiQueryTokensRegisterTypes hook to register it.
Returning a non-falsey value here will cause self::getFinalParams() to return a required string 'token' parameter and self::getFinalParamDescription() to ensure there is standardized documentation for it. Also, self::mustBePosted() must return true when tokens are used.
In previous versions of MediaWiki, true was a valid return value. Returning true will generate errors indicating that the API module needs updating.
- Returns:
- string|false
Reimplemented from ApiBase.
Definition at line 192 of file ApiBlock.php.
The documentation for this class was generated from the following file:
- includes/api/ApiBlock.php
