ApiBlock Class Reference
[API]

Created on Sep 4, 2007 API for MediaWiki 1.8+. 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.
 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

Created on Sep 4, 2007 API for MediaWiki 1.8+.

Copyright © 2007 Roan Kattouw <Firstname>.<Lastname>.nl

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. http://www.gnu.org/copyleft/gpl.html 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, IPBlockForm::canBlockEmail(), 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 129 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 163 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 186 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 146 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 169 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

Reimplemented from ApiBase.

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

ApiBlock::isWriteMode (  ) 

Indicates whether this module requires write mode.

Returns:
bool

Reimplemented from ApiBase.

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

ApiBlock::needsToken (  ) 

Returns whether this module requires a Token to execute.

Returns:
bool

Reimplemented from ApiBase.

Definition at line 178 of file ApiBlock.php.


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

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