API interface for setting the wl_notificationtimestamp field. 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. | |
| 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. | |
Private Member Functions | |
| getPageSet () | |
| Get a cached instance of an ApiPageSet object. | |
Private Attributes | |
| $mPageSet | |
Detailed Description
API interface for setting the wl_notificationtimestamp field.
Definition at line 32 of file ApiSetNotificationTimestamp.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 36 of file ApiSetNotificationTimestamp.php.
References $lb, $params, $res, $result, $rev, $timestamp, $title, $user, array(), as, ApiBase\dieUsage(), ApiBase\extractRequestParams(), ApiBase\getModuleName(), getPageSet(), ApiBase\getResult(), Revision\getTimestampFromId(), ContextSource\getUser(), ApiBase\requireMaxOneParameter(), wfGetDB(), and wfTimestamp().
| ApiSetNotificationTimestamp::getAllowedParams | ( | $ | flags = 0 | ) |
Definition at line 208 of file ApiSetNotificationTimestamp.php.
References $flags, $result, array(), getPageSet(), and ApiBase\PARAM_TYPE.
Returns the description string for this module.
- Returns:
- string|array
Reimplemented from ApiBase.
Definition at line 241 of file ApiSetNotificationTimestamp.php.
References array().
Returns usage examples for this module.
Return false if no examples are available.
- Returns:
- bool|string|array
Reimplemented from ApiBase.
Definition at line 249 of file ApiSetNotificationTimestamp.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 262 of file ApiSetNotificationTimestamp.php.
| ApiSetNotificationTimestamp::getPageSet | ( | ) | [private] |
Get a cached instance of an ApiPageSet object.
- Returns:
- ApiPageSet
Definition at line 188 of file ApiSetNotificationTimestamp.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 231 of file ApiSetNotificationTimestamp.php.
References array(), and getPageSet().
Indicates whether this module requires write mode.
- Returns:
- bool
Reimplemented from ApiBase.
Definition at line 200 of file ApiSetNotificationTimestamp.php.
Indicates whether this module must be called with a POST request.
- Returns:
- bool
Reimplemented from ApiBase.
Definition at line 196 of file ApiSetNotificationTimestamp.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 204 of file ApiSetNotificationTimestamp.php.
Member Data Documentation
ApiSetNotificationTimestamp::$mPageSet [private] |
Definition at line 34 of file ApiSetNotificationTimestamp.php.
The documentation for this class was generated from the following file:
- includes/api/ApiSetNotificationTimestamp.php
