ApiUnblock Class Reference
[API]

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

Inherits ApiBase.

List of all members.

Public Member Functions

 __construct ($main, $action)
 execute ()
 Unblocks the specified user or provides the reason the unblock failed.
 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.
 getPossibleErrors ()
 Returns a list of all possible errors returned by the module.
 needsToken ()
 Returns whether this module requires a Token to execute.
 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.

Protected Member Functions

 getExamples ()
 Returns usage examples for this module.


Detailed Description

API module that facilitates the unblocking of users.

Requires API write mode to be enabled.

Definition at line 36 of file ApiUnblock.php.


Constructor & Destructor Documentation

ApiUnblock::__construct ( main,
action 
)

Definition at line 38 of file ApiUnblock.php.

References $action.


Member Function Documentation

ApiUnblock::execute (  ) 

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

Reimplemented from ApiBase.

Definition at line 45 of file ApiUnblock.php.

References $res, $wgUser, ApiBase::dieUsageMsg(), IPUnblockForm::doUnblock(), ApiBase::extractRequestParams(), ApiBase::getModuleName(), and ApiBase::getResult().

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

Reimplemented from ApiBase.

Definition at line 85 of file ApiUnblock.php.

ApiUnblock::getDescription (  ) 

Returns the description string for this module.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 105 of file ApiUnblock.php.

ApiUnblock::getExamples (  )  [protected]

Returns usage examples for this module.

Return null if no examples are available.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

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

Reimplemented from ApiBase.

Definition at line 95 of file ApiUnblock.php.

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 111 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

Reimplemented from ApiBase.

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

ApiUnblock::isWriteMode (  ) 

Indicates whether this module requires write mode.

Returns:
bool

Reimplemented from ApiBase.

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

ApiUnblock::needsToken (  ) 

Returns whether this module requires a Token to execute.

Returns:
bool

Reimplemented from ApiBase.

Definition at line 119 of file ApiUnblock.php.


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

Generated on Sat Apr 30 22:57:32 2011 for MediaWiki by  doxygen 1.5.9