Inherits ApiBase.
Public Member Functions | |
__construct ($main, $action) | |
execute () | |
Patrols the article or provides the reason the patrol failed. | |
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. |
Definition at line 34 of file ApiPatrol.php.
ApiPatrol::__construct | ( | $ | main, | |
$ | action | |||
) |
ApiPatrol::execute | ( | ) |
Patrols the article or provides the reason the patrol failed.
Reimplemented from ApiBase.
Definition at line 43 of file ApiPatrol.php.
References $result, ApiQueryBase::addTitleInfo(), ApiBase::dieUsageMsg(), ApiBase::extractRequestParams(), ApiBase::getModuleName(), ApiBase::getResult(), and RecentChange::markPatrolled().
ApiPatrol::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.
Reimplemented from ApiBase.
Definition at line 66 of file ApiPatrol.php.
References ApiBase::PARAM_TYPE.
ApiPatrol::getDescription | ( | ) |
Returns the description string for this module.
Reimplemented from ApiBase.
Definition at line 82 of file ApiPatrol.php.
ApiPatrol::getExamples | ( | ) | [protected] |
Returns usage examples for this module.
Return null if no examples are available.
Reimplemented from ApiBase.
Definition at line 103 of file ApiPatrol.php.
ApiPatrol::getParamDescription | ( | ) |
Returns an array of parameter descriptions.
Don't call this functon directly: use getFinalParamDescription() to allow hooks to modify descriptions as needed.
Reimplemented from ApiBase.
Definition at line 75 of file ApiPatrol.php.
ApiPatrol::getPossibleErrors | ( | ) |
Returns a list of all possible errors returned by the module.
Reimplemented from ApiBase.
Definition at line 88 of file ApiPatrol.php.
ApiPatrol::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.
Reimplemented from ApiBase.
Definition at line 99 of file ApiPatrol.php.
ApiPatrol::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
Reimplemented from ApiBase.
Definition at line 109 of file ApiPatrol.php.
ApiPatrol::isWriteMode | ( | ) |
Indicates whether this module requires write mode.
Reimplemented from ApiBase.
Definition at line 62 of file ApiPatrol.php.
ApiPatrol::needsToken | ( | ) |
Returns whether this module requires a Token to execute.
Reimplemented from ApiBase.
Definition at line 95 of file ApiPatrol.php.