ApiBlock Class Reference

API module that facilitates the blocking of users. More...

Inheritance diagram for ApiBlock:

Collaboration diagram for ApiBlock:

List of all members.

Public Member Functions
	__construct ($main, $action)
	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.
	getPossibleErrors ()
	Returns a list of all possible errors returned by the module.
	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.
	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.

---

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.

---

Constructor & Destructor Documentation

ApiBlock::__construct	(	$	main,
		$	action
	)

Definition at line 35 of file ApiBlock.php.

---

Member Function Documentation

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 45 of file ApiBlock.php.

References $res, $user, SpecialBlock\canBlockEmail(), SpecialBlock\checkUnblockSelf(), ApiBase\dieUsage(), ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), ContextSource\getContext(), User\getId(), ApiBase\getMain(), ApiBase\getModuleName(), ContextSource\getRequest(), ApiBase\getResult(), SpecialBlock\getTargetAndType(), ContextSource\getUser(), Block\newFromTarget(), SpecialBlock\processForm(), wfGetDB(), and wfTimestamp().

Here is the call graph for this function:

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.

Returns:

array or false

Reimplemented from ApiBase.

Definition at line 149 of file ApiBlock.php.

References ApiBase\PARAM_REQUIRED, and ApiBase\PARAM_TYPE.

ApiBlock::getDescription

(

)

Returns the description string for this module.

Returns:

mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 188 of file ApiBlock.php.

ApiBlock::getExamples

(

)

Returns usage examples for this module.

Return false if no examples are available.

Returns:

false|string|array

Reimplemented from ApiBase.

Definition at line 210 of file ApiBlock.php.

ApiBlock::getHelpUrls

(

)

Returns:

false|string|array Returns a false if the module has no help url, else returns a (array of) string

Reimplemented from ApiBase.

Definition at line 217 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.

Returns:

array or false

Reimplemented from ApiBase.

Definition at line 170 of file ApiBlock.php.

ApiBlock::getPossibleErrors

(

)

Returns a list of all possible errors returned by the module.

Returns:

array in the format of array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )

Reimplemented from ApiBase.

Definition at line 192 of file ApiBlock.php.

ApiBlock::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.

Returns:

bool|string

Reimplemented from ApiBase.

Definition at line 206 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

Returns:

string

Reimplemented from ApiBase.

Definition at line 221 of file ApiBlock.php.

ApiBlock::isWriteMode

(

)

Indicates whether this module requires write mode.

Returns:

bool

Reimplemented from ApiBase.

Definition at line 145 of file ApiBlock.php.

ApiBlock::mustBePosted

(

)

Indicates whether this module must be called with a POST request.

Returns:

bool

Reimplemented from ApiBase.

Definition at line 141 of file ApiBlock.php.

ApiBlock::needsToken

(

)

Returns whether this module requires a Token to execute.

Returns:

bool

Reimplemented from ApiBase.

Definition at line 202 of file ApiBlock.php.

---

The documentation for this class was generated from the following file:

• includes/api/ApiBlock.php