1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace Wikimedia\EventRelayer;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
/**
* Base class for reliable event relays
*
* @stable to extend
*/
abstract class EventRelayer implements LoggerAwareInterface {
/** @var LoggerInterface */
protected $logger;
/**
* @stable to call
*
* @param array $params
*/
public function __construct( array $params ) {
$this->logger = new NullLogger();
}
/**
* @param string $channel
* @param array $event Event data map
* @return bool Success
*/
final public function notify( $channel, $event ) {
return $this->doNotify( $channel, [ $event ] );
}
/**
* @param string $channel
* @param array $events List of event data maps
* @return bool Success
*/
final public function notifyMulti( $channel, $events ) {
return $this->doNotify( $channel, $events );
}
public function setLogger( LoggerInterface $logger ) {
$this->logger = $logger;
}
/**
* @param string $channel
* @param array $events List of event data maps
* @return bool Success
*/
abstract protected function doNotify( $channel, array $events );
}
/** @deprecated class alias since 1.41 */
class_alias( EventRelayer::class, 'EventRelayer' );
|