1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace PEIP\ABS\Channel; |
4
|
|
|
|
5
|
|
|
namespace PEIP\ABS\Channel; |
6
|
|
|
|
7
|
|
|
/* |
8
|
|
|
* This file is part of the PEIP package. |
9
|
|
|
* (c) 2009-2016 Timo Michna <timomichna/yahoo.de> |
10
|
|
|
* |
11
|
|
|
* For the full copyright and license information, please view the LICENSE |
12
|
|
|
* file that was distributed with this source code. |
13
|
|
|
*/ |
14
|
|
|
|
15
|
|
|
/* |
16
|
|
|
* PEIP\ABS\Channel\SubscribableChannel |
17
|
|
|
* Abstract base class for subscribable channels |
18
|
|
|
* |
19
|
|
|
* @author Timo Michna <timomichna/yahoo.de> |
20
|
|
|
* @package PEIP |
21
|
|
|
* @subpackage channel |
22
|
|
|
* @extends \PEIP\ABS\Channel\Channel |
23
|
|
|
* @implements \PEIP\INF\Event\Connectable, \PEIP\INF\Channel\Channel, \PEIP\INF\Channel\SubscribableChannel |
24
|
|
|
*/ |
25
|
|
|
|
26
|
|
|
|
27
|
|
|
use PEIP\Dispatcher\Dispatcher; |
28
|
|
|
use PEIP\Util\Test; |
29
|
|
|
|
30
|
|
|
abstract class SubscribableChannel extends \PEIP\ABS\Channel\Channel implements \PEIP\INF\Channel\SubscribableChannel |
31
|
|
|
{ |
32
|
|
|
protected $messageDispatcher; |
33
|
|
|
|
34
|
|
|
/** |
35
|
|
|
* Subscribes a given listener to the channel. |
36
|
|
|
* |
37
|
|
|
* @event subscribe |
38
|
|
|
* |
39
|
|
|
* @param callable|PEIP\INF\Handler\Handler $handler the listener to subscribe |
40
|
|
|
* |
41
|
|
|
* @return |
42
|
|
|
*/ |
43
|
|
|
public function subscribe($handler) |
44
|
|
|
{ |
45
|
|
|
Test::ensureHandler($handler); |
46
|
|
|
$this->getMessageDispatcher()->connect($handler); |
47
|
|
|
$this->doFireEvent('subscribe', ['SUBSCRIBER' => $handler]); |
48
|
|
|
} |
49
|
|
|
|
50
|
|
|
/** |
51
|
|
|
* Unsubscribes a given listener from the channel. |
52
|
|
|
* |
53
|
|
|
* @event unsubscribe |
54
|
|
|
* |
55
|
|
|
* @param callable|PEIP\INF\Handler\Handler $handler the listener to unsubscribe |
56
|
|
|
* |
57
|
|
|
* @return |
58
|
|
|
*/ |
59
|
|
|
public function unsubscribe($handler) |
60
|
|
|
{ |
61
|
|
|
Test::ensureHandler($handler); |
62
|
|
|
$this->getMessageDispatcher()->disconnect($handler); |
63
|
|
|
$this->doFireEvent('unsubscribe', ['SUBSCRIBER' => $handler]); |
64
|
|
|
} |
65
|
|
|
|
66
|
|
|
/** |
67
|
|
|
* Sets the message dispatcher resposible for notifying all subscribers about new messages. |
68
|
|
|
* |
69
|
|
|
* @param \PEIP\INF\Dispatcher\Dispatcher $dispatcher instance of \PEIP\INF\Dispatcher\Dispatcher |
70
|
|
|
* @param bool $transferListeners wether to transfer listeners of old dispatcher (if set) to new one. default: true |
71
|
|
|
* |
72
|
|
|
* @return |
73
|
|
|
*/ |
74
|
|
|
public function setMessageDispatcher(\PEIP\INF\Dispatcher\Dispatcher $dispatcher, $transferListeners = true) |
75
|
|
|
{ |
76
|
|
View Code Duplication |
if (isset($this->dispatcher) && $transferListeners) { |
|
|
|
|
77
|
|
|
foreach ($this->dispatcher->getListeners() as $listener) { |
|
|
|
|
78
|
|
|
$dispatcher->connect($listener); |
79
|
|
|
$this->dispatcher->disconnect($listener); |
|
|
|
|
80
|
|
|
} |
81
|
|
|
} |
82
|
|
|
$this->dispatcher = $dispatcher; |
|
|
|
|
83
|
|
|
} |
84
|
|
|
|
85
|
|
|
/** |
86
|
|
|
* Returns the message dispatcher resposible for notifying all subscribers about new messages. |
87
|
|
|
* |
88
|
|
|
* @return |
89
|
|
|
*/ |
90
|
|
|
public function getMessageDispatcher() |
91
|
|
|
{ |
92
|
|
|
return isset($this->dispatcher) ? $this->dispatcher : $this->dispatcher = new Dispatcher(); |
|
|
|
|
93
|
|
|
} |
94
|
|
|
} |
95
|
|
|
|
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.