MediaWiki
REL1_22
|
Allows user to patrol pages. More...
Public Member Functions | |
execute () | |
Patrols the article or provides the reason the patrol failed. | |
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. | |
getDescription () | |
Returns the description string for this module. | |
getExamples () | |
Returns usage examples for this module. | |
getHelpUrls () | |
getParamDescription () | |
Returns an array of parameter descriptions. | |
getPossibleErrors () | |
Returns a list of all possible errors returned by the module. | |
getResultProperties () | |
Returns possible properties in the result, grouped by the value of the prop parameter that shows them. | |
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 You have also to override needsToken() Value is passed to User::getEditToken. | |
isWriteMode () | |
Indicates whether this module requires write mode. | |
mustBePosted () | |
Indicates whether this module must be called with a POST request. | |
needsToken () | |
Returns whether this module requires a token to execute It is used to show possible errors in action=paraminfo see bug 25248. |
Allows user to patrol pages.
Definition at line 31 of file ApiPatrol.php.
Patrols the article or provides the reason the patrol failed.
Reimplemented from ApiBase.
Definition at line 36 of file ApiPatrol.php.
References $params, $result, $retval, $rev, ApiQueryBase\addTitleInfo(), array(), ApiBase\dieUsage(), ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), ApiBase\getModuleName(), ApiBase\getResult(), ContextSource\getUser(), Revision\newFromId(), and ApiBase\requireOnlyOneParameter().
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.
Some derived classes may choose to handle an integer $flags parameter in the overriding methods. Callers of this method can pass zero or more OR-ed flags like GET_VALUES_FOR_HELP.
Reimplemented from ApiBase.
Definition at line 78 of file ApiPatrol.php.
References array(), ApiBase\PARAM_REQUIRED, and ApiBase\PARAM_TYPE.
Returns the description string for this module.
Reimplemented from ApiBase.
Definition at line 111 of file ApiPatrol.php.
Returns usage examples for this module.
Return false if no examples are available.
Reimplemented from ApiBase.
Definition at line 137 of file ApiPatrol.php.
References array().
Reimplemented from ApiBase.
Definition at line 144 of file ApiPatrol.php.
Returns an array of parameter descriptions.
Don't call this function directly: use getFinalParamDescription() to allow hooks to modify descriptions as needed.
Reimplemented from ApiBase.
Definition at line 93 of file ApiPatrol.php.
References array().
Returns a list of all possible errors returned by the module.
Don't call this function directly: use getFinalPossibleErrors() to allow hooks to modify parameters as needed.
Reimplemented from ApiBase.
Definition at line 115 of file ApiPatrol.php.
References array().
Returns possible properties in the result, grouped by the value of the prop parameter that shows them.
Properties that are shown always are in a group with empty string as a key. Properties that can be shown by several values of prop are included multiple times. If some properties are part of a list and some are on the root object (see ApiQueryQueryPage), those on the root object are under the key PROP_ROOT. The array can also contain a boolean under the key PROP_LIST, indicating whether the result is a list.
Don't call this function directly: use getFinalResultProperties() to allow hooks to modify descriptions as needed.
Reimplemented from ApiBase.
Definition at line 101 of file ApiPatrol.php.
References array().
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 You have also to override needsToken() Value is passed to User::getEditToken.
Reimplemented from ApiBase.
Definition at line 133 of file ApiPatrol.php.
Indicates whether this module requires write mode.
Reimplemented from ApiBase.
Definition at line 74 of file ApiPatrol.php.
Indicates whether this module must be called with a POST request.
Reimplemented from ApiBase.
Definition at line 70 of file ApiPatrol.php.
Returns whether this module requires a token to execute It is used to show possible errors in action=paraminfo see bug 25248.
Reimplemented from ApiBase.
Definition at line 129 of file ApiPatrol.php.