RCFeedFormatter Interface Reference

Interface for RC feed formatters. More...

Inheritance diagram for RCFeedFormatter:

List of all members.

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.

Since:

1.22

Definition at line 27 of file RCFeedFormatter.php.

---

Member Function Documentation

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 The text to send.

Implemented in MachineReadableRCFeedFormatter, and IRCColourfulRCFeedFormatter.

---

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

• includes/rcfeed/RCFeedFormatter.php