API module to allow users to watch a page. More...
Public Member Functions | |
| execute () | |
| Evaluates the parameters, performs the requested query, and sets up the result. | |
| getAllowedParams ($flags=0) | |
| 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. | |
Private Member Functions | |
| getPageSet () | |
| Get a cached instance of an ApiPageSet object. | |
| watchTitle (Title $title, User $user, array $params, $compatibilityMode=false) | |
Private Attributes | |
| $mPageSet = null | |
Detailed Description
API module to allow users to watch a page.
Definition at line 32 of file ApiWatch.php.
Member Function Documentation
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 35 of file ApiWatch.php.
References $params, $res, $title, $user, array(), as, ApiBase\dieUsage(), ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), ApiBase\getModuleName(), ApiBase\getModulePrefix(), getPageSet(), ApiBase\getResult(), ContextSource\getUser(), Title\newFromText(), and watchTitle().
| ApiWatch::getAllowedParams | ( | $ | flags = 0 | ) |
Definition at line 171 of file ApiWatch.php.
References $flags, $result, array(), getPageSet(), ApiBase\PARAM_DEPRECATED, ApiBase\PARAM_REQUIRED, and ApiBase\PARAM_TYPE.
Returns the description string for this module.
- Returns:
- mixed string or array of strings
Reimplemented from ApiBase.
Definition at line 213 of file ApiWatch.php.
Returns usage examples for this module.
Return false if no examples are available.
- Returns:
- bool|string|array
Reimplemented from ApiBase.
Definition at line 225 of file ApiWatch.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 232 of file ApiWatch.php.
| ApiWatch::getPageSet | ( | ) | [private] |
Get a cached instance of an ApiPageSet object.
- Returns:
- ApiPageSet
Definition at line 147 of file ApiWatch.php.
Referenced by execute(), getAllowedParams(), and getParamDescription().
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 191 of file ApiWatch.php.
References array(), and getPageSet().
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.
- Returns:
- array in the format of array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )
Reimplemented from ApiBase.
Definition at line 217 of file ApiWatch.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.
- Returns:
- array|bool False on no properties
Reimplemented from ApiBase.
Definition at line 202 of file ApiWatch.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.
- Returns:
- bool|string|array
Reimplemented from ApiBase.
Definition at line 167 of file ApiWatch.php.
Indicates whether this module requires write mode.
- Returns:
- bool
Reimplemented from ApiBase.
Definition at line 159 of file ApiWatch.php.
Indicates whether this module must be called with a POST request.
- Returns:
- bool
Reimplemented from ApiBase.
Definition at line 155 of file ApiWatch.php.
Returns whether this module requires a token to execute It is used to show possible errors in action=paraminfo see bug 25248.
- Returns:
- bool
Reimplemented from ApiBase.
Definition at line 163 of file ApiWatch.php.
| ApiWatch::watchTitle | ( | Title $ | title, |
| User $ | user, | ||
| array $ | params, | ||
| $ | compatibilityMode = false |
||
| ) | [private] |
Definition at line 93 of file ApiWatch.php.
References $res, array(), ApiBase\dieStatus(), WatchAction\doUnwatch(), WatchAction\doWatch(), Language\factory(), ContextSource\getContext(), ApiBase\getErrorFromStatus(), Title\getPrefixedText(), Title\isWatchable(), ContextSource\msg(), and title.
Referenced by execute().
Member Data Documentation
ApiWatch::$mPageSet = null [private] |
Definition at line 33 of file ApiWatch.php.
The documentation for this class was generated from the following file:
- includes/api/ApiWatch.php
