ApiFeedWatchlist Class Reference

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

Inheritance diagram for ApiFeedWatchlist:

Collaboration diagram for ApiFeedWatchlist:

List of all members.

Public Member Functions
	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.
	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)
Private Attributes
	$linkToDiffs = false

---

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:

$info

array

Returns:

FeedItem

Definition at line 154 of file ApiFeedWatchlist.php.

References $comment, $timestamp, $title, $user, array(), 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 51 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

(

)

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.

Some derived classes may choose to handle an integer $flags parameter in the overriding methods. Callers of this method can pass zero or more OR-ed flags like GET_VALUES_FOR_HELP.

Returns:

array|bool

Reimplemented from ApiBase.

Definition at line 171 of file ApiFeedWatchlist.php.

References array(), 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 41 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 211 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 222 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 229 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 199 of file ApiFeedWatchlist.php.

References array().

ApiFeedWatchlist::getPossibleErrors

(

)

Returns a list of all possible errors returned by the module.

Returns:

array in the format of array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )

Reimplemented from ApiBase.

Definition at line 215 of file ApiFeedWatchlist.php.

References array().

---

Member Data Documentation

ApiFeedWatchlist::$linkToDiffs = false [private]

Definition at line 45 of file ApiFeedWatchlist.php.

---

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

• includes/api/ApiFeedWatchlist.php