MediaWiki REL1_40
EventRelayer Class Reference

Base class for reliable event relays. More...

Inherits LoggerAwareInterface.

Inherited by EventRelayerNull.

Collaboration diagram for 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 29 of file EventRelayer.php.

Constructor & Destructor Documentation

◆ __construct()

EventRelayer::__construct ( array $params)
Stability: stable
to call
Parameters
array$params

Definition at line 38 of file EventRelayer.php.

Member Function Documentation

◆ doNotify()

EventRelayer::doNotify ( $channel,
array $events )
abstractprotected
Parameters
string$channel
array$eventsList of event data maps
Returns
bool Success

Reimplemented in EventRelayerNull.

Referenced by notify(), and notifyMulti().

◆ notify()

EventRelayer::notify ( $channel,
$event )
final
Parameters
string$channel
array$eventEvent data map
Returns
bool Success

Definition at line 47 of file EventRelayer.php.

References doNotify().

◆ notifyMulti()

EventRelayer::notifyMulti ( $channel,
$events )
final
Parameters
string$channel
array$eventsList of event data maps
Returns
bool Success

Definition at line 56 of file EventRelayer.php.

References doNotify().

◆ setLogger()

EventRelayer::setLogger ( LoggerInterface $logger)

Definition at line 60 of file EventRelayer.php.

References $logger.

Member Data Documentation

◆ $logger

LoggerInterface EventRelayer::$logger
protected

Definition at line 31 of file EventRelayer.php.

Referenced by setLogger().


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