Inherits ApiBase.
Public Member Functions | |
__construct ($main, $action) | |
Std ctor. | |
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. | |
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. | |
getVersion () | |
Returns a string that identifies the version of the extending class. | |
Protected Member Functions | |
getExamples () | |
Returns usage examples for this module. |
Requires API write mode to be enabled.
Definition at line 36 of file ApiBlock.php.
ApiBlock::__construct | ( | $ | main, | |
$ | action | |||
) |
ApiBlock::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.
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 51 of file ApiBlock.php.
References $res, $wgBlockAllowsUTEdit, $wgUser, ApiBase::dieUsageMsg(), ApiBase::extractRequestParams(), ApiBase::getModuleName(), ApiBase::getResult(), Block::infinity(), and wfTimestamp().
ApiBlock::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 121 of file ApiBlock.php.
ApiBlock::getDescription | ( | ) |
Returns the description string for this module.
Reimplemented from ApiBase.
Definition at line 155 of file ApiBlock.php.
ApiBlock::getExamples | ( | ) | [protected] |
Returns usage examples for this module.
Return null if no examples are available.
Reimplemented from ApiBase.
Definition at line 161 of file ApiBlock.php.
ApiBlock::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 138 of file ApiBlock.php.
ApiBlock::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 168 of file ApiBlock.php.
ApiBlock::isWriteMode | ( | ) |
Indicates whether this module requires write mode.
Reimplemented from ApiBase.
Definition at line 117 of file ApiBlock.php.
ApiBlock::mustBePosted | ( | ) |
Indicates whether this module must be called with a POST request.
Reimplemented from ApiBase.
Definition at line 115 of file ApiBlock.php.