MediaWiki  REL1_22
Public Member Functions | Private Member Functions | Private Attributes
ApiFeedWatchlist Class Reference
API

This action allows users to get their watchlist items in RSS/Atom formats. More...

Inheritance diagram for ApiFeedWatchlist:
Inheritance graph
[legend]
Collaboration diagram for ApiFeedWatchlist:
Collaboration graph
[legend]

List of all members.

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.
 getPossibleErrors ()
 Returns a list of all possible errors returned by the module.

Private Member Functions

 createFeedItem ($info)
 getWatchlistModule ()

Private Attributes

 $linkToDiffs = false
 $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:
$infoarray
Returns:
FeedItem

Definition at line 168 of file ApiFeedWatchlist.php.

References $comment, $matches, $timestamp, $title, $user, $wgParser, array(), global, Title\newFromText(), and Sanitizer\normalizeSectionNameWhitespace().

Referenced by execute().

ApiFeedWatchlist::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 53 of file ApiFeedWatchlist.php.

References $params, array(), as, createFeedItem(), ApiBase\dieUsage(), ApiBase\extractRequestParams(), ApiBase\getMain(), ApiBase\getResult(), SpecialPage\getTitleFor(), global, ApiFormatFeedWrapper\setResult(), wfMessage(), and wfTimestamp().

ApiFeedWatchlist::getAllowedParams ( $  flags = 0)

Definition at line 205 of file ApiFeedWatchlist.php.

References $flags, $ret, array(), getWatchlistModule(), global, ApiBase\PARAM_DFLT, ApiBase\PARAM_MAX, ApiBase\PARAM_MIN, and ApiBase\PARAM_TYPE.

ApiFeedWatchlist::getCustomPrinter ( )

This module uses a custom feed wrapper printer.

Returns:
ApiFormatFeedWrapper

Reimplemented from ApiBase.

Definition at line 45 of file ApiFeedWatchlist.php.

References ApiBase\getMain().

ApiFeedWatchlist::getDescription ( )

Returns the description string for this module.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 257 of file ApiFeedWatchlist.php.

ApiFeedWatchlist::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:
bool|string|array

Reimplemented from ApiBase.

Definition at line 268 of file ApiFeedWatchlist.php.

References array().

ApiFeedWatchlist::getHelpUrls ( )
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 275 of file ApiFeedWatchlist.php.

ApiFeedWatchlist::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 241 of file ApiFeedWatchlist.php.

References array(), and getWatchlistModule().

ApiFeedWatchlist::getPossibleErrors ( )

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 261 of file ApiFeedWatchlist.php.

References array().

ApiFeedWatchlist::getWatchlistModule ( ) [private]

Definition at line 197 of file ApiFeedWatchlist.php.

References ApiBase\getMain().

Referenced by getAllowedParams(), and getParamDescription().

Member Data Documentation

ApiFeedWatchlist::$linkToDiffs = false [private]

Definition at line 37 of file ApiFeedWatchlist.php.

ApiFeedWatchlist::$linkToSections = false [private]

Definition at line 38 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: