RCFeedFormatter Interface Reference

Interface for RC feed formatters. More...

Inherited by IRCColourfulRCFeedFormatter, and MachineReadableRCFeedFormatter.

Public Member Functions
	getLine (array $feed, RecentChange $rc, $actionComment)
	Formats the line to be sent by an engine.

Detailed Description

Interface for RC feed formatters.

Stability: stable

to implement

Since

1.22

Definition at line 28 of file RCFeedFormatter.php.

Member Function Documentation

getLine()

RCFeedFormatter::getLine	(	array	$feed,
		RecentChange	$rc,
			$actionComment )

Formats the line to be sent by an engine.

Parameters

array	$feed	The feed, as configured in an associative array.
RecentChange	$rc	The RecentChange object showing what sort of event has taken place.
string | null	$actionComment

Returns

string|null The text to send. If the formatter returns null, the line will not be sent.

Implemented in IRCColourfulRCFeedFormatter, and MachineReadableRCFeedFormatter.

---

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

• includes/rcfeed/RCFeedFormatter.php