MediaWiki master
MediaWiki\RCFeed\FormattedRCFeed Class Reference

Base class for RCFeed implementations that use RCFeedFormatter. More...

Inherits MediaWiki\RCFeed\RCFeed.

Inherited by MediaWiki\RCFeed\RedisPubSubFeedEngine, and MediaWiki\RCFeed\UDPRCFeedEngine.

Collaboration diagram for MediaWiki\RCFeed\FormattedRCFeed:

Public Member Functions

 __construct (array $params)
 
 notify (RecentChange $rc, $actionComment=null)
 
 send (array $feed, $line)
 Send some text to the specified feed.
 

Additional Inherited Members

- Static Public Member Functions inherited from MediaWiki\RCFeed\RCFeed
static factory (array $params)
 

Detailed Description

Base class for RCFeed implementations that use RCFeedFormatter.

Parameters:

  • formatter: [required] Which RCFeedFormatter class to use.
See also
$wgRCFeeds
Since
1.29

Definition at line 34 of file FormattedRCFeed.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\RCFeed\FormattedRCFeed::__construct ( array $params)
Parameters
array$params

Reimplemented from MediaWiki\RCFeed\RCFeed.

Definition at line 40 of file FormattedRCFeed.php.

References $params.

Member Function Documentation

◆ notify()

MediaWiki\RCFeed\FormattedRCFeed::notify ( RecentChange $rc,
$actionComment = null )
Parameters
RecentChange$rc
string | null$actionComment
Returns
bool Success

Reimplemented from MediaWiki\RCFeed\RCFeed.

Definition at line 58 of file FormattedRCFeed.php.

References MediaWiki\RCFeed\FormattedRCFeed\send().

◆ send()

MediaWiki\RCFeed\FormattedRCFeed::send ( array $feed,
$line )
abstract

Send some text to the specified feed.

Parameters
array$feedThe feed, as configured in an associative array
string$lineThe text to send
Returns
bool Success

Reimplemented in MediaWiki\RCFeed\RedisPubSubFeedEngine, and MediaWiki\RCFeed\UDPRCFeedEngine.

Referenced by MediaWiki\RCFeed\FormattedRCFeed\notify().


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