ApiUnblock Class Reference

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

Inheritance diagram for ApiUnblock:

Collaboration diagram for ApiUnblock:

List of all members.

Public Member Functions
	__construct ($main, $action)
	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.
	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 unblocking of users.

Requires API write mode to be enabled.

Definition at line 33 of file ApiUnblock.php.

---

Constructor & Destructor Documentation

ApiUnblock::__construct	(	$	main,
		$	action
	)

Definition at line 35 of file ApiUnblock.php.

---

Member Function Documentation

ApiUnblock::execute

(

)

Unblocks the specified user or provides the reason the unblock failed.

Reimplemented from ApiBase.

Definition at line 42 of file ApiUnblock.php.

References $res, $user, SpecialBlock\checkUnblockSelf(), ApiBase\dieUsage(), ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), ContextSource\getContext(), ApiBase\getMain(), ApiBase\getModuleName(), User\getName(), ContextSource\getRequest(), ApiBase\getResult(), ContextSource\getUser(), Block\newFromTarget(), SpecialUnblock\processUnblock(), and Block\TYPE_AUTO.

Here is the call graph for this function:

ApiUnblock::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 99 of file ApiUnblock.php.

References ApiBase\PARAM_TYPE.

ApiUnblock::getDescription

(

)

Returns the description string for this module.

Returns:

mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 122 of file ApiUnblock.php.

ApiUnblock::getExamples

(

)

Returns usage examples for this module.

Return false if no examples are available.

Returns:

false|string|array

Reimplemented from ApiBase.

Definition at line 144 of file ApiUnblock.php.

ApiUnblock::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 151 of file ApiUnblock.php.

ApiUnblock::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 111 of file ApiUnblock.php.

References ApiBase\getModulePrefix().

Here is the call graph for this function:

ApiUnblock::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 126 of file ApiUnblock.php.

ApiUnblock::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 140 of file ApiUnblock.php.

ApiUnblock::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 155 of file ApiUnblock.php.

ApiUnblock::isWriteMode

(

)

Indicates whether this module requires write mode.

Returns:

bool

Reimplemented from ApiBase.

Definition at line 95 of file ApiUnblock.php.

ApiUnblock::mustBePosted

(

)

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

Returns:

bool

Reimplemented from ApiBase.

Definition at line 91 of file ApiUnblock.php.

ApiUnblock::needsToken

(

)

Returns whether this module requires a Token to execute.

Returns:

bool

Reimplemented from ApiBase.

Definition at line 136 of file ApiUnblock.php.

---

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

• includes/api/ApiUnblock.php