ApiProtect Class Reference
[API]

Inherits ApiBase.

List of all members.

Public Member Functions

 __construct ($main, $action)
 execute ()
 Evaluates the parameters, performs the requested query, and sets up the result.
 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

Definition at line 33 of file ApiProtect.php.


Constructor & Destructor Documentation

ApiProtect::__construct ( main,
action 
)

Definition at line 35 of file ApiProtect.php.

References $action.


Member Function Documentation

ApiProtect::execute (  ) 

Evaluates the parameters, performs the requested query, and sets up the result.

Concrete implementations of ApiBase must override this method to provide whatever functionality their module offers. Implementations must not produce any output on their own and are not expected to handle any errors.

The execute() method will be invoked directly by ApiMain immediately before the result of the module is output. Aside from the constructor, implementations should assume that no other methods will be called externally on the module before the result is processed.

The result data should be stored in the ApiResult object available through getResult().

Reimplemented from ApiBase.

Definition at line 39 of file ApiProtect.php.

References $i, $ok, $res, $wgRestrictionLevels, $wgRestrictionTypes, $wgUser, ApiBase::dieUsageMsg(), ApiBase::extractRequestParams(), ApiBase::getModuleName(), ApiBase::getResult(), Block::infinity(), Title::newFromText(), wfTimestamp(), and wfTimestampNow().

ApiProtect::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 134 of file ApiProtect.php.

References ApiBase::PARAM_ALLOW_DUPLICATES, ApiBase::PARAM_DFLT, and ApiBase::PARAM_ISMULTI.

ApiProtect::getDescription (  ) 

Returns the description string for this module.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 166 of file ApiProtect.php.

ApiProtect::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 195 of file ApiProtect.php.

ApiProtect::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 152 of file ApiProtect.php.

ApiProtect::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 172 of file ApiProtect.php.

ApiProtect::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 191 of file ApiProtect.php.

ApiProtect::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 202 of file ApiProtect.php.

ApiProtect::isWriteMode (  ) 

Indicates whether this module requires write mode.

Returns:
bool

Reimplemented from ApiBase.

Definition at line 130 of file ApiProtect.php.

ApiProtect::mustBePosted (  ) 

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

Returns:
bool

Reimplemented from ApiBase.

Definition at line 126 of file ApiProtect.php.

ApiProtect::needsToken (  ) 

Returns whether this module requires a Token to execute.

Returns:
bool

Reimplemented from ApiBase.

Definition at line 187 of file ApiProtect.php.


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

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