ApiBlock Class Reference
[API]

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

Inherits ApiBase.

List of all members.

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.


Detailed Description

API module that facilitates the blocking of users.

Requires API write mode to be enabled.

Definition at line 36 of file ApiBlock.php.


Constructor & Destructor Documentation

ApiBlock::__construct ( main,
action 
)

Std ctor.

Definition at line 41 of file ApiBlock.php.

References $action.


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

Returns:
array

Reimplemented from ApiBase.

Definition at line 121 of file ApiBlock.php.

ApiBlock::getDescription (  ) 

Returns the description string for this module.

Returns:
mixed string or array of strings

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.

Returns:
mixed string or array of strings

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.

Returns:
array

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

Returns:
string

Reimplemented from ApiBase.

Definition at line 168 of file ApiBlock.php.

ApiBlock::isWriteMode (  ) 

Indicates whether this module requires write mode.

Returns:
bool

Reimplemented from ApiBase.

Definition at line 117 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 115 of file ApiBlock.php.


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

Generated on Sat Sep 5 02:08:30 2009 for MediaWiki by  doxygen 1.5.9