10000 Respect parent class contract in ContainerAwareDoctrineEventManager · mathroc/symfony@42d6272 · GitHub
[go: up one dir, main page]
Skip to content

Commit 42d6272

Browse files
KocKoc
committed
Respect parent class contract in ContainerAwareDoctrineEventManager
1 parent e197c9a commit 42d6272

File tree

2 files changed

+106
-53
lines changed

2 files changed

+106
-53
lines changed

‎src/Symfony/Bridge/Doctrine/ContainerAwareEventManager.php

Lines changed: 46 additions & 43 deletions
131
Original file line numberDiff line numberDiff line change
@@ -37,72 +37,61 @@ public function __construct(ContainerInterface $container)
3737
}
3838

3939
/**
40-
* Dispatches an event to all registered listeners.
41-
*
42-
* @param string $eventName The name of the event to dispatch. The name of the event is
43-
* the name of the method that is invoked on listeners.
44-
* @param EventArgs $eventArgs The event arguments to pass to the event handlers/listeners.
45-
* If not supplied, the single empty EventArgs instance is used.
46-
*
47-
* @return bool
40+
* {@inheritdoc}
4841
*/
4942
public function dispatchEvent($eventName, EventArgs $eventArgs = null)
5043
{
51-
if (isset($this->listeners[$eventName])) {
52-
$eventArgs = null === $eventArgs ? EventArgs::getEmptyInstance() : $eventArgs;
44+
if (!isset($this->listeners[$eventName])) {
45+
return;
46+
}
5347

54-
$initialized = isset($this->initialized[$eventName]);
48+
$eventArgs = null === $eventArgs ? EventArgs::getEmptyInstance() : $eventArgs;
5549

56-
foreach ($this->listeners[$eventName] as $hash => $listener) {
57-
if (!$initialized && \is_string($listener)) {
58-
$this->listeners[$eventName][$hash] = $listener = $this->container->get($listener);
59-
}
50+
if (!isset($this->initialized[$eventName])) {
51+
$this->initializeListeners($eventName);
52+
}
6053

61-
$listener->$eventName($eventArgs);
62-
}
63-
$this->initialized[$eventName] = true;
54+
foreach ($this->listeners[$eventName] as $hash => $listener) {
55+
$listener->$eventName($eventArgs);
6456
}
6557
}
6658

6759
/**
68-
* Gets the listeners of a specific event or all listeners.
69-
*
70-
* @param string $event The name of the event
71-
*
72-
* @return array The event listeners for the specified event, or all event listeners
60+
* {@inheritdoc}
7361
*/
7462
public function getListeners($event = null)
7563
{
76-
return $event ? $this->listeners[$event] : $this->listeners;
64+
if (null !== $event) {
65+
if (!isset($this->initialized[$event])) {
66+
$this->initializeListeners($event);
67+
}
68+
69+
return $this->listeners[$event];
70+
}
71+
72+
foreach ($this->listeners as $event => $listeners) {
73+
if (!isset($this->initialized[$event])) {
74+
$this->initializeListeners($event);
75+
}
76+
}
77+
78+
return $this->listeners;
7779
}
7880

7981
/**
80-
* Checks whether an event has any registered listeners.
81-
*
82-
* @param string $event
83-
*
84-
* @return bool TRUE if the specified event has any listeners, FALSE otherwise
82+
* {@inheritdoc}
8583
*/
8684
public function hasListeners($event)
8785
{
8886
return isset($this->listeners[$event]) && $this->listeners[$event];
8987
}
9088

9189
/**
92-
* Adds an event listener that listens on the specified events.
93-
*
94-
* @param string|array $events The event(s) to listen on
95-
* @param object|string $listener The listener object
96-
*
97-
* @throws \RuntimeException
90+
* {@inheritdoc}
9891
*/
9992
public function addEventListener($events, $listener)
10093
{
10194
if (\is_string($listener)) {
102-
if ($this->initialized) {
103-
throw new \RuntimeException('Adding lazy-loading listeners after construction is not supported.');
104-
}
105-
10695
$hash = '_service_'.$listener;
10796
} else {
10897
// Picks the hash code related to that listener
@@ -113,14 +102,15 @@ public function addEventListener($events, $listener)
113102
// Overrides listener if a previous one was associated already
114103
// Prevents duplicate listeners on same event (same instance only)
115104
$this->listeners[$event][$hash] = $listener;
105+
106+
if (\is_string($listener)) {
107+
unset($this->initialized[$event]);
108+
}
116109
}
117110
}
118111

119112
/**
120-
* Removes an event listener from the specified events.
121-
*
122-
* @param string|array $events
123-
* @param object|string $listener
113+
* {@inheritdoc}
124114
*/
125115
public function removeEventListener($events, $listener)
126116
{
@@ -138,4 +128,17 @@ public function removeEventListener($events, $listener)
138128
}
139129
}
140130
}
+
132+
/**
133+
* @param string $eventName
134+
*/
135+
private function initializeListeners($eventName)
136+
{
137+
foreach ($this->listeners[$eventName] as $hash => $listener) {
138+
if (\is_string($listener)) {
139+
$this->listeners[$eventName][$hash] = $this->container->get($listener);
140+
}
141+
}
142+
$this->initialized[$eventName] = true;
143+
}
141144
}

‎src/Symfony/Bridge/Doctrine/Tests/ContainerAwareEventManagerTest.php

Lines changed: 60 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ protected function setUp()
2828

2929
public function testDispatchEvent()
3030
{
31-
$this->container->set('foobar', $listener1 = new MyListener());
32-
$this->evm->addEventListener('foo', 'foobar');
31+
$this->container->set('lazy', $listener1 = new MyListener());
32+
$this->evm->addEventListener('foo', 'lazy');
3333
$this->evm->addEventListener('foo', $listener2 = new MyListener());
3434

3535
$this->evm->dispatchEvent('foo');
@@ -38,19 +38,69 @@ public function testDispatchEvent()
3838
$this->assertTrue($listener2->called);
3939
}
4040

41+
public function testAddEventListenerAfterDispatchEvent()
42+
{
43+
$this->container->set('lazy1', $listener1 = new MyListener());
44+
$this->evm->addEventListener('foo', 'lazy1');
45+
$this->evm->addEventListener('foo', $listener2 = new MyListener());
46+
47+
$this->evm->dispatchEvent('foo');
48+
49+
$this->container->set('lazy2', $listener3 = new MyListener());
50+
$this->evm->addEventListener('foo', 'lazy2');
51+
$this->evm->addEventListener('foo', $listener4 = new MyListener());
52+
53+
$this->evm->dispatchEvent('foo');
54+
55+
$this->assertTrue($listener1->called);
56+
$this->assertTrue($listener2->called);
57+
$this->assertTrue($listener3->called);
58+
$this->assertTrue($listener4->called);
59+
}
60+
61+
public function testGetListenersForEvent()
62+
{
63+
$this->container->set('lazy', $listener1 = new MyListener());
64+
$this->evm->addEventListener('foo', 'lazy');
65+
$this->evm->addEventListener('foo', $listener2 = new MyListener());
66+
67+
$this->assertSame([$listener1, $listener2], array_values($this->evm->getListeners('foo')));
68+
}
69+
70+
public function testGetListeners()
71+
{
72+
$this->container->set('lazy', $listener1 = new MyListener());
73+
$this->evm->addEventListener('foo', 'lazy');
74+
$this->evm->addEventListener('foo', $listener2 = new MyListener());
75+
76+
$this->assertSame([$listener1, $listener2], array_values($this->evm->getListeners()['foo']));
77+
}
78+
4179
public function testRemoveEventListener()
4280
{
43-
$this->evm->addEventListener('foo', 'bar');
44-
$this->evm->addEventListener('foo', $listener = new MyListener());
81+
$this->container->set('lazy', $listener1 = new MyListener());
82+
$this->evm->addEventListener('foo', 'lazy');
83+
$this->evm->addEventListener('foo', $listener2 = new MyListener());
84+
85+
$this->evm->removeEventListener('foo', $listener2);
86+
$this->assertSame([$listener1], array_values($this->evm->getListeners('foo')));
4587

46-
$listeners = ['foo' => ['_service_bar' => 'bar', spl_object_hash($listener) => $listener]];
47-
$this->assertSame($listeners, $this->evm->getListeners());
48-
$this->assertSame($listeners['foo'], $this->evm->getListeners('foo'));
88+
$this->evm->removeEventListener('foo', 'lazy');
89+
$this->assertSame([], $this->evm->getListeners('foo'));
90+
}
91+
92+
public function testRemoveEventListenerAfterDispatchEvent()
93+
{
94+
$this->container->set('lazy', $listener1 = new MyListener());
95+
$this->evm->addEventListener('foo', 'lazy');
96+
$this->evm->addEventListener('foo', $listener2 = new MyListener());
97+
98+
$this->evm->dispatchEvent('foo');
4999

50-
$this->evm->removeEventListener('foo', $listener);
51-
$this->assertSame(['_service_bar' => 'bar'], $this->evm->getListeners('foo'));
100+
$this->evm->removeEventListener('foo', $listener2);
101+
$this->assertSame([$listener1], array_values($this->evm->getListeners('foo')));
52102

53-
$this->evm->removeEventListener('foo', 'bar');
103+
$this->evm->removeEventListener('foo', 'lazy');
54104
$this->assertSame([], $this->evm->getListeners('foo'));
55105
}
56106
}

0 commit comments

Comments
 (0)
0