ApiFeedWatchlist Class Reference
[API]

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

Inherits ApiBase.

List of all members.

Public Member Functions

 __construct ($main, $action)
 getCustomPrinter ()
 This module uses a custom feed wrapper printer.
 execute ()
 Make a nested call to the API to request watchlist items in the last $hours.
 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.
 getParamDescription ()
 Returns an array of parameter descriptions.
 getDescription ()
 Returns the description string for this module.
 getVersion ()
 Returns a string that identifies the version of the extending class.

Protected Member Functions

 getExamples ()
 Returns usage examples for this module.

Private Member Functions

 createFeedItem ($info)


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


Constructor & Destructor Documentation

ApiFeedWatchlist::__construct ( main,
action 
)

Definition at line 40 of file ApiFeedWatchlist.php.

References $action.


Member Function Documentation

ApiFeedWatchlist::createFeedItem ( info  )  [private]

Definition at line 128 of file ApiFeedWatchlist.php.

References $title, $user, and Title::newFromText().

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

References $dbr, $wgContLanguageCode, $wgFeedClasses, $wgFeedLimit, $wgSitename, createFeedItem(), ApiBase::extractRequestParams(), ApiBase::getMain(), ApiBase::getResult(), SpecialPage::getTitleFor(), ApiFormatFeedWrapper::setResult(), wfGetDB(), wfMsgForContent(), and wfTimestamp().

ApiFeedWatchlist::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.

Returns:
array

Reimplemented from ApiBase.

Definition at line 141 of file ApiFeedWatchlist.php.

References $wgFeedClasses, ApiBase::PARAM_DFLT, ApiBase::PARAM_MAX, ApiBase::PARAM_MIN, and ApiBase::PARAM_TYPE.

ApiFeedWatchlist::getCustomPrinter (  ) 

This module uses a custom feed wrapper printer.

Reimplemented from ApiBase.

Definition at line 47 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 167 of file ApiFeedWatchlist.php.

ApiFeedWatchlist::getExamples (  )  [protected]

Returns usage examples for this module.

Return null if no examples are available.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 171 of file ApiFeedWatchlist.php.

ApiFeedWatchlist::getParamDescription (  ) 

Returns an array of parameter descriptions.

Don't call this functon directly: use getFinalParamDescription() to allow hooks to modify descriptions as needed.

Returns:
array

Reimplemented from ApiBase.

Definition at line 159 of file ApiFeedWatchlist.php.

ApiFeedWatchlist::getVersion (  ) 

Returns a string that identifies the version of the extending class.

Typically includes the class name, the svn revision, timestamp, and last author. Usually done with SVN's Id keyword

Returns:
string

Reimplemented from ApiBase.

Definition at line 177 of file ApiFeedWatchlist.php.


The documentation for this class was generated from the following file:

Generated on Sat Sep 5 02:08:30 2009 for MediaWiki by  doxygen 1.5.9