Wikimedia\EventRelayer\EventRelayer Class Reference

Base class for reliable event relays. More...

Inherits LoggerAwareInterface.

Inherited by Wikimedia\EventRelayer\EventRelayerNull.

Collaboration diagram for Wikimedia\EventRelayer\EventRelayer:

Public Member Functions
	__construct (array $params)
	notify ( $channel, $event)
	notifyMulti ( $channel, $events)
	setLogger (LoggerInterface $logger)

Protected Member Functions
	doNotify ( $channel, array $events)

Protected Attributes
LoggerInterface	$logger

Detailed Description

Base class for reliable event relays.

Stability: stable

to extend

Definition at line 32 of file EventRelayer.php.

Constructor & Destructor Documentation

__construct()

Wikimedia\EventRelayer\EventRelayer::__construct

(

array

$params

)

Stability: stable

to call

Parameters

array

$params

Definition at line 41 of file EventRelayer.php.

Member Function Documentation

doNotify()

Wikimedia\EventRelayer\EventRelayer::doNotify ( $channel, array $events )

abstractprotected

Parameters

string	$channel
array	$events	List of event data maps

Returns

bool Success

Reimplemented in Wikimedia\EventRelayer\EventRelayerNull.

Referenced by Wikimedia\EventRelayer\EventRelayer\notify(), and Wikimedia\EventRelayer\EventRelayer\notifyMulti().

notify()

Wikimedia\EventRelayer\EventRelayer::notify ( $channel, $event )

final

Parameters

string	$channel
array	$event	Event data map

Returns

bool Success

Definition at line 50 of file EventRelayer.php.

References Wikimedia\EventRelayer\EventRelayer\doNotify().

notifyMulti()

Wikimedia\EventRelayer\EventRelayer::notifyMulti ( $channel, $events )

final

Parameters

string	$channel
array	$events	List of event data maps

Returns

bool Success

Definition at line 59 of file EventRelayer.php.

References Wikimedia\EventRelayer\EventRelayer\doNotify().

setLogger()

Wikimedia\EventRelayer\EventRelayer::setLogger

(

LoggerInterface

$logger

)

Definition at line 63 of file EventRelayer.php.

References Wikimedia\EventRelayer\EventRelayer\$logger.

Member Data Documentation

$logger

LoggerInterface Wikimedia\EventRelayer\EventRelayer::$logger

protected

Definition at line 34 of file EventRelayer.php.

Referenced by Wikimedia\EventRelayer\EventRelayer\setLogger().

---

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

• includes/libs/eventrelayer/EventRelayer.php