MediaWiki  master
EventRelayer Class Reference

Base class for reliable event relays. More...

Inheritance diagram for EventRelayer:
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.

Definition at line 27 of file EventRelayer.php.

Constructor & Destructor Documentation

◆ __construct()

EventRelayer::__construct ( array  $params)
Parameters
array$params

Definition at line 34 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

Referenced by notify(), notifyMulti(), and setLogger().

◆ notify()

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

Definition at line 43 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 52 of file EventRelayer.php.

References doNotify().

◆ setLogger()

EventRelayer::setLogger ( LoggerInterface  $logger)

Definition at line 56 of file EventRelayer.php.

References $logger, array(), and doNotify().

Member Data Documentation

◆ $logger

LoggerInterface EventRelayer::$logger
protected

Definition at line 29 of file EventRelayer.php.

Referenced by setLogger().


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