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. | |
| isWriteMode () | |
| Indicates whether this module requires write mode. | |
| mustBePosted () | |
| Indicates whether this module must be called with a POST request. | |
| needsToken () | |
| Returns the token type this module requires in order to execute. | |
Detailed Description
Allows user to patrol pages.
Definition at line 31 of file ApiPatrol.php.
Member Function Documentation
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.
- Returns:
- array|bool
Reimplemented from ApiBase.
Definition at line 78 of file ApiPatrol.php.
References array(), and ApiBase\PARAM_TYPE.
Returns the description string for this module.
- Returns:
- string|array
Reimplemented from ApiBase.
Definition at line 96 of file ApiPatrol.php.
Returns usage examples for this module.
Return false if no examples are available.
- Returns:
- bool|string|array
Reimplemented from ApiBase.
Definition at line 104 of file ApiPatrol.php.
References array().
- Returns:
- bool|string|array Returns a false if the module has no help URL, else returns a (array of) string
Reimplemented from ApiBase.
Definition at line 111 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.
- Returns:
- array|bool False on no parameter descriptions
Reimplemented from ApiBase.
Definition at line 89 of file ApiPatrol.php.
References array().
Indicates whether this module requires write mode.
- Returns:
- bool
Reimplemented from ApiBase.
Definition at line 74 of file ApiPatrol.php.
Indicates whether this module must be called with a POST request.
- Returns:
- bool
Reimplemented from ApiBase.
Definition at line 70 of file ApiPatrol.php.
Returns the token type this module requires in order to execute.
Modules are strongly encouraged to use the core 'csrf' type unless they have specialized security needs. If the token type is not one of the core types, you must use the ApiQueryTokensRegisterTypes hook to register it.
Returning a non-falsey value here will cause self::getFinalParams() to return a required string 'token' parameter and self::getFinalParamDescription() to ensure there is standardized documentation for it. Also, self::mustBePosted() must return true when tokens are used.
In previous versions of MediaWiki, true was a valid return value. Returning true will generate errors indicating that the API module needs updating.
- Returns:
- string|false
Reimplemented from ApiBase.
Definition at line 100 of file ApiPatrol.php.
The documentation for this class was generated from the following file:
- includes/api/ApiPatrol.php
