MediaWiki  master
ChangesFeed Class Reference

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

Public Member Functions

 __construct ($format, $type)
 Constructor. More...
 
 execute ($feed, $rows, $lastmod, $opts)
 Generates feed's content. More...
 
 getFeedObject ($title, $description, $url)
 Get a ChannelFeed subclass object to use. More...
 
 loadFromCache ($lastmod, $timekey, $key)
 Try to load the feed result from cache. More...
 
 saveToCache ($feed, $timekey, $key)
 Save to feed result to cache. More...
 

Static Public Member Functions

static buildItems ($rows)
 Generate the feed items given a row from the database. More...
 
static generateFeed ($rows, &$feed)
 Generate the feed items given a row from the database, printing the feed. More...
 

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$formatFeed's format (either 'rss' or 'atom')
string$typeType 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$rowsIDatabase resource with recentchanges rows
Returns
array

Definition at line 184 of file ChangesFeed.php.

References $title, as, MWNamespace\canTalk(), Revision\DELETED_USER, FeedUtils\formatDiff(), Title\makeTitle(), RC_EDIT, RC_EXTERNAL, and wfMessage().

Referenced by ApiFeedRecentChanges\execute().

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

Generates feed's content.

Parameters
ChannelFeed$feedChannelFeed subclass object (generally the one returned by getFeedObject())
ResultWrapper$rowsResultWrapper object with rows in recentchanges table
int$lastmodTimestamp of the last item in the recentchanges table (only used for the cache key)
FormOptions$optsAs in SpecialRecentChanges::getDefaultOptions()
Returns
null|bool True or null

Definition at line 78 of file ChangesFeed.php.

References $key, $wgLang, $wgRenderHashAppend, FeedUtils\checkFeedOutput(), FeedUtils\checkPurge(), format, global, loadFromCache(), saveToCache(), serialize(), 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$rowsIDatabase resource with recentchanges rows
ChannelFeed$feed

Definition at line 170 of file ChangesFeed.php.

References as.

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

Get a ChannelFeed subclass object to use.

Parameters
string$titleFeed's title
string$descriptionFeed's description
string$urlUrl of origin page
Returns
ChannelFeed|bool ChannelFeed subclass or false on failure

Definition at line 50 of file ChangesFeed.php.

References $format, $wgLanguageCode, $wgSitename, format, and global.

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

Try to load the feed result from cache.

Parameters
int$lastmodTimestamp of the last item in the recentchanges table
string$timekeyMemcached key of the last modification
string$keyMemcached 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 $cache, $key, $wgOut, ObjectCache\getMainWANInstance(), global, TS_UNIX, wfDebug(), and wfTimestamp().

Referenced by execute().

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

Save to feed result to cache.

Parameters
string$feedFeed's content
string$timekeyMemcached key of the last modification
string$keyMemcached key of the content

Definition at line 120 of file ChangesFeed.php.

References $cache, $key, ObjectCache\getMainWANInstance(), TS_MW, 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(), and getFeedObject().

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: