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
	__construct ($main, $action)
	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.
	getVersion ()
	Returns a string that identifies the version of the extending class.
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.

---

Constructor & Destructor Documentation

ApiFeedWatchlist::__construct	(	$	main,
		$	action
	)

Definition at line 36 of file ApiFeedWatchlist.php.

---

Member Function Documentation

ApiFeedWatchlist::createFeedItem

(

$

info

)

[private]

Parameters:

$info

array

Returns:

FeedItem

Definition at line 157 of file ApiFeedWatchlist.php.

References $comment, $title, $user, and Title\newFromText().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

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 $wgFeed, $wgFeedClasses, $wgFeedLimit, $wgLanguageCode, $wgSitename, createFeedItem(), ApiBase\dieUsage(), ApiBase\extractRequestParams(), ApiBase\getMain(), ApiBase\getResult(), SpecialPage\getTitleFor(), ApiFormatFeedWrapper\setResult(), wfMsgForContent(), and wfTimestamp().

Here is the call graph for this function:

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 or false

Reimplemented from ApiBase.

Definition at line 174 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.

Returns:

ApiFormatFeedWrapper

Reimplemented from ApiBase.

Definition at line 45 of file ApiFeedWatchlist.php.

References ApiBase\getMain().

Here is the call graph for this function:

ApiFeedWatchlist::getDescription

(

)

Returns the description string for this module.

Returns:

mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 214 of file ApiFeedWatchlist.php.

ApiFeedWatchlist::getExamples

(

)

Returns usage examples for this module.

Return false if no examples are available.

Returns:

false|string|array

Reimplemented from ApiBase.

Definition at line 225 of file ApiFeedWatchlist.php.

ApiFeedWatchlist::getHelpUrls

(

)

Returns:

false|string|array Returns a false if the module has no help url, else returns a (array of) string

Reimplemented from ApiBase.

Definition at line 232 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 or false

Reimplemented from ApiBase.

Definition at line 202 of file ApiFeedWatchlist.php.

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

---

Member Data Documentation

ApiFeedWatchlist::$linkToDiffs = false [private]

Definition at line 49 of file ApiFeedWatchlist.php.

---

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

• includes/api/ApiFeedWatchlist.php