FormattedRCFeed Class Reference

Base class for RC feed engines that send messages in a freely configurable format to a uri-addressed engine set in $wgRCEngines. More...

Inheritance diagram for FormattedRCFeed:

Collaboration diagram for FormattedRCFeed:

Public Member Functions
	__construct (array $params=[])
	notify (RecentChange $rc, $actionComment=null)
	send (array $feed, $line)
	Send some text to the specified feed. More...

Private Attributes
	$params

Additional Inherited Members
Static Public Member Functions inherited from RCFeed
static	factory (array $params)

Detailed Description

Base class for RC feed engines that send messages in a freely configurable format to a uri-addressed engine set in $wgRCEngines.

Since

1.29

Definition at line 26 of file FormattedRCFeed.php.

Constructor & Destructor Documentation

__construct()

FormattedRCFeed::__construct

(

array

$params = []

)

Parameters

array

$params

'uri' 'formatter'

See also

$wgRCFeeds

Reimplemented from RCFeed.

Definition at line 35 of file FormattedRCFeed.php.

References $params.

Member Function Documentation

notify()

FormattedRCFeed::notify	(	RecentChange	$rc,
			$actionComment = null
	)

Parameters

RecentChange	$rc
string | null	$actionComment

Returns

bool Success

Reimplemented from RCFeed.

Definition at line 53 of file FormattedRCFeed.php.

References $line, $params, and send().

send()

FormattedRCFeed::send ( array  $feed,   $line  )

abstract

Send some text to the specified feed.

Parameters

array	$feed	The feed, as configured in an associative array
string	$line	The text to send

Returns

bool Success

Reimplemented in RedisPubSubFeedEngine, and UDPRCFeedEngine.

Referenced by notify().

Member Data Documentation

$params

FormattedRCFeed::$params

private

Definition at line 27 of file FormattedRCFeed.php.

Referenced by __construct(), and notify().

---

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

• includes/rcfeed/FormattedRCFeed.php