ChangesFeed Class Reference

Feed to Special:RecentChanges and Special:RecentChangesLiked. More...

List of all members.

Public Member Functions
	__construct ($format, $type)
	Constructor.
	execute ($feed, $rows, $lastmod, $opts)
	Generates feed's content.
	getFeedObject ($title, $description, $url)
	Get a ChannelFeed subclass object to use.
	loadFromCache ($lastmod, $timekey, $key)
	Try to load the feed result from $messageMemc.
	saveToCache ($feed, $timekey, $key)
	Save to feed result to $messageMemc.
Static Public Member Functions
static	buildItems ($rows)
	Generate the feed items given a row from the database.
static	generateFeed ($rows, &$feed)
	Generate the feed items given a row from the database, printing the feed.
Public Attributes
	$descMsg
	$format
	$titleMsg
	$type

---

Detailed Description

Feed to Special:RecentChanges and Special:RecentChangesLiked.

Definition at line 28 of file ChangesFeed.php.

---

Constructor & Destructor Documentation

ChangesFeed::__construct	(	$	format,
		$	type
	)

Constructor.

Parameters:

string	$format	Feed's format (either 'rss' or 'atom')
string	$type	Type of feed (for cache keys)

Definition at line 37 of file ChangesFeed.php.

References $format, $type, format, and type.

---

Member Function Documentation

static ChangesFeed::buildItems

(

$

rows

)

[static]

Generate the feed items given a row from the database.

Parameters:

object

$rows

DatabaseBase resource with recentchanges rows

Returns:

array

Definition at line 185 of file ChangesFeed.php.

References $n, $title, array(), as, MWNamespace\canTalk(), Revision\DELETED_USER, FeedUtils\formatDiff(), Title\makeTitle(), wfMessage(), wfProfileIn(), and wfProfileOut().

Referenced by ApiFeedRecentChanges\execute(), and generateFeed().

ChangesFeed::execute	(	$	feed,
		$	rows,
		$	lastmod,
		$	opts
	)

Generates feed's content.

Parameters:

ChannelFeed	$feed	ChannelFeed subclass object (generally the one returned by getFeedObject())
ResultWrapper	$rows	ResultWrapper object with rows in recentchanges table
int	$lastmod	Timestamp of the last item in the recentchanges table (only used for the cache key)
FormOptions	$opts	As in SpecialRecentChanges::getDefaultOptions()

Returns:

null|bool True or null

Definition at line 78 of file ChangesFeed.php.

References $key, $wgLang, FeedUtils\checkFeedOutput(), FeedUtils\checkPurge(), format, generateFeed(), global, loadFromCache(), saveToCache(), type, wfDebug(), and wfMemcKey().

static ChangesFeed::generateFeed	(	$	rows,
		&$	feed
	)		[static]

Generate the feed items given a row from the database, printing the feed.

Parameters:

object	$rows	DatabaseBase resource with recentchanges rows
Feed	$feed

Definition at line 169 of file ChangesFeed.php.

References as, buildItems(), wfProfileIn(), and wfProfileOut().

Referenced by execute().

ChangesFeed::getFeedObject	(	$	title,
		$	description,
		$	url
	)

Get a ChannelFeed subclass object to use.

Parameters:

string	$title	Feed's title
string	$description	Feed's description
string	$url	Url of origin page

Returns:

ChannelFeed|bool ChannelFeed subclass or false on failure

Definition at line 50 of file ChangesFeed.php.

References format, and global.

ChangesFeed::loadFromCache	(	$	lastmod,
		$	timekey,
		$	key
	)

Try to load the feed result from $messageMemc.

Parameters:

int	$lastmod	Timestamp of the last item in the recentchanges table
string	$timekey	Memcached key of the last modification
string	$key	Memcached key of the content

Returns:

string|bool Feed's content on cache hit or false on cache miss

Definition at line 134 of file ChangesFeed.php.

References $key, $messageMemc, $wgOut, global, wfDebug(), and wfTimestamp().

Referenced by execute().

ChangesFeed::saveToCache	(	$	feed,
		$	timekey,
		$	key
	)

Save to feed result to $messageMemc.

Parameters:

string	$feed	Feed's content
string	$timekey	Memcached key of the last modification
string	$key	Memcached key of the content

Definition at line 119 of file ChangesFeed.php.

References $key, $messageMemc, global, and wfTimestamp().

Referenced by execute().

---

Member Data Documentation

ChangesFeed::$descMsg

Definition at line 29 of file ChangesFeed.php.

ChangesFeed::$format

Definition at line 29 of file ChangesFeed.php.

Referenced by __construct().

ChangesFeed::$titleMsg

Definition at line 29 of file ChangesFeed.php.

ChangesFeed::$type

Definition at line 29 of file ChangesFeed.php.

Referenced by __construct().

---

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

• includes/changes/ChangesFeed.php