This action allows users to get their watchlist items in RSS/Atom formats. More...
Public Member Functions | |
| execute () | |
| Make a nested call to the API to request watchlist items in the last $hours. | |
| getAllowedParams ($flags=0) | |
| getCustomPrinter () | |
| This module uses a custom feed wrapper printer. | |
| getDescription () | |
| Returns the description string for this module. | |
| getExamples () | |
| Returns usage examples for this module. | |
| getHelpUrls () | |
| getParamDescription () | |
| Returns an array of parameter descriptions. | |
Private Member Functions | |
| createFeedItem ($info) | |
| getWatchlistModule () | |
Private Attributes | |
| $linkToSections = false | |
| $watchlistModule = null | |
Detailed Description
This action allows users to get their watchlist items in RSS/Atom formats.
When executed, it performs a nested call to the API to get the needed data, and formats it in a proper format.
Definition at line 34 of file ApiFeedWatchlist.php.
Member Function Documentation
| ApiFeedWatchlist::createFeedItem | ( | $ | info | ) | [private] |
- Parameters:
-
array $info
- Returns:
- FeedItem
Definition at line 166 of file ApiFeedWatchlist.php.
References $comment, $matches, $timestamp, $title, $user, $wgParser, array(), global, Title\newFromText(), and Sanitizer\normalizeSectionNameWhitespace().
Referenced by execute().
Make a nested call to the API to request watchlist items in the last $hours.
Wrap the result as an RSS/Atom feed.
Reimplemented from ApiBase.
Definition at line 52 of file ApiFeedWatchlist.php.
References $e, $params, array(), as, createFeedItem(), ApiBase\dieUsage(), ApiBase\extractRequestParams(), ContextSource\getConfig(), ApiBase\getMain(), ApiBase\getResult(), SpecialPage\getTitleFor(), ApiFormatFeedWrapper\setResult(), wfMessage(), and wfTimestamp().
| ApiFeedWatchlist::getAllowedParams | ( | $ | flags = 0 | ) |
Definition at line 207 of file ApiFeedWatchlist.php.
References $flags, $ret, array(), ContextSource\getConfig(), getWatchlistModule(), ApiBase\PARAM_DFLT, ApiBase\PARAM_MAX, ApiBase\PARAM_MIN, and ApiBase\PARAM_TYPE.
This module uses a custom feed wrapper printer.
- Returns:
- ApiFormatFeedWrapper
Reimplemented from ApiBase.
Definition at line 44 of file ApiFeedWatchlist.php.
References ApiBase\getMain().
Returns the description string for this module.
- Returns:
- string|array
Reimplemented from ApiBase.
Definition at line 258 of file ApiFeedWatchlist.php.
Returns usage examples for this module.
Return false if no examples are available.
- Returns:
- bool|string|array
Reimplemented from ApiBase.
Definition at line 262 of file ApiFeedWatchlist.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 269 of file ApiFeedWatchlist.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 242 of file ApiFeedWatchlist.php.
References array(), and getWatchlistModule().
| ApiFeedWatchlist::getWatchlistModule | ( | ) | [private] |
Definition at line 198 of file ApiFeedWatchlist.php.
References ApiBase\getMain().
Referenced by getAllowedParams(), and getParamDescription().
Member Data Documentation
ApiFeedWatchlist::$linkToSections = false [private] |
Definition at line 37 of file ApiFeedWatchlist.php.
ApiFeedWatchlist::$watchlistModule = null [private] |
Definition at line 36 of file ApiFeedWatchlist.php.
The documentation for this class was generated from the following file:
- includes/api/ApiFeedWatchlist.php
