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
	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.
	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 unblocking of users.

Requires API write mode to be enabled.

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

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.

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.

ApiUnblock::getDescription

(

)

Returns the description string for this module.

Returns:

string|array

Reimplemented from ApiBase.

Definition at line 108 of file ApiUnblock.php.

ApiUnblock::getExamples

(

)

Returns usage examples for this module.

Return false if no examples are available.

Returns:

bool|string|array

Reimplemented from ApiBase.

Definition at line 116 of file ApiUnblock.php.

References array().

ApiUnblock::getHelpUrls

(

)

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

ApiUnblock::getParamDescription

(

)

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

References array(), and ApiBase\getModulePrefix().

ApiUnblock::isWriteMode

(

)

Indicates whether this module requires write mode.

Returns:

bool

Reimplemented from ApiBase.

Definition at line 82 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 78 of file ApiUnblock.php.

ApiUnblock::needsToken

(

)

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

---

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

• includes/api/ApiUnblock.php