Skip to content

[DoctrineBridge] Invokable event listeners #32486

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 9, 2019
Merged

[DoctrineBridge] Invokable event listeners #32486

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Symfony/Bridge/Doctrine/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ CHANGELOG

* added `DoctrineClearEntityManagerMiddleware`
* deprecated `RegistryInterface`, use `Doctrine\Common\Persistence\ManagerRegistry`

* added support for invokable event listeners

4.3.0
-----
Expand Down
53 changes: 38 additions & 15 deletions src/Symfony/Bridge/Doctrine/ContainerAwareEventManager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ class ContainerAwareEventManager extends EventManager
*/
private $listeners = [];
private $initialized = [];
private $methods = [];
private $container;

public function __construct(ContainerInterface $container)
Expand All @@ -52,7 +53,7 @@ public function dispatchEvent($eventName, EventArgs $eventArgs = null)
}

foreach ($this->listeners[$eventName] as $hash => $listener) {
$listener->$eventName($eventArgs);
$listener->{$this->methods[$eventName][$hash]}($eventArgs);
}
}

Expand Down Expand Up @@ -91,12 +92,7 @@ public function hasListeners($event)
*/
public function addEventListener($events, $listener)
{
if (\is_string($listener)) {
$hash = '_service_'.$listener;
} else {
// Picks the hash code related to that listener
$hash = spl_object_hash($listener);
}
$hash = $this->getHash($listener);

foreach ((array) $events as $event) {
// Overrides listener if a previous one was associated already
Expand All @@ -105,6 +101,8 @@ public function addEventListener($events, $listener)

if (\is_string($listener)) {
unset($this->initialized[$event]);
} else {
$this->methods[$event][$hash] = $this->getMethod($listener, $event);
}
}
}
Expand All @@ -114,28 +112,53 @@ public function addEventListener($events, $listener)
*/
public function removeEventListener($events, $listener)
{
if (\is_string($listener)) {
$hash = '_service_'.$listener;
} else {
// Picks the hash code related to that listener
$hash = spl_object_hash($listener);
}
$hash = $this->getHash($listener);

foreach ((array) $events as $event) {
// Check if actually have this listener associated
// Check if we actually have this listener associated
if (isset($this->listeners[$event][$hash])) {
unset($this->listeners[$event][$hash]);
}

if (isset($this->methods[$event][$hash])) {
unset($this->methods[$event][$hash]);
}
}
}

private function initializeListeners(string $eventName)
{
foreach ($this->listeners[$eventName] as $hash => $listener) {
if (\is_string($listener)) {
$this->listeners[$eventName][$hash] = $this->container->get($listener);
$this->listeners[$eventName][$hash] = $listener = $this->container->get($listener);

$this->methods[$eventName][$hash] = $this->getMethod($listener, $eventName);
}
}
$this->initialized[$eventName] = true;
}

/**
* @param string|object $listener
*/
private function getHash($listener): string
{
if (\is_string($listener)) {
return '_service_'.$listener;
}

return spl_object_hash($listener);
}

/**
* @param object $listener
*/
private function getMethod($listener, string $event): string
{
if (!method_exists($listener, $event) && method_exists($listener, '__invoke')) {
return '__invoke';
}

return $event;
}
}
84 changes: 68 additions & 16 deletions src/Symfony/Bridge/Doctrine/Tests/ContainerAwareEventManagerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,34 +28,80 @@ protected function setUp()

public function testDispatchEvent()
{
$this->container->set('lazy', $listener1 = new MyListener());
$this->evm->addEventListener('foo', 'lazy');
$this->container->set('lazy1', $listener1 = new MyListener());
$this->evm->addEventListener('foo', 'lazy1');
$this->evm->addEventListener('foo', $listener2 = new MyListener());
$this->container->set('lazy2', $listener3 = new MyListener());
$this->evm->addEventListener('bar', 'lazy2');
$this->evm->addEventListener('bar', $listener4 = new MyListener());
$this->container->set('lazy3', $listener5 = new MyListener());
$this->evm->addEventListener('foo', $listener5 = new MyListener());
$this->evm->addEventListener('bar', $listener5);

$this->evm->dispatchEvent('foo');

$this->assertTrue($listener1->called);
$this->assertTrue($listener2->called);
$this->evm->dispatchEvent('bar');

$this->assertSame(0, $listener1->calledByInvokeCount);
$this->assertSame(1, $listener1->calledByEventNameCount);
$this->assertSame(0, $listener2->calledByInvokeCount);
$this->assertSame(1, $listener2->calledByEventNameCount);
$this->assertSame(1, $listener3->calledByInvokeCount);
$this->assertSame(0, $listener3->calledByEventNameCount);
$this->assertSame(1, $listener4->calledByInvokeCount);
$this->assertSame(0, $listener4->calledByEventNameCount);
$this->assertSame(1, $listener5->calledByInvokeCount);
$this->assertSame(1, $listener5->calledByEventNameCount);
}

public function testAddEventListenerAfterDispatchEvent()
{
$this->container->set('lazy1', $listener1 = new MyListener());
$this->evm->addEventListener('foo', 'lazy1');
$this->evm->addEventListener('foo', $listener2 = new MyListener());

$this->evm->dispatchEvent('foo');

$this->container->set('lazy2', $listener3 = new MyListener());
$this->evm->addEventListener('foo', 'lazy2');
$this->evm->addEventListener('foo', $listener4 = new MyListener());
$this->evm->addEventListener('bar', 'lazy2');
$this->evm->addEventListener('bar', $listener4 = new MyListener());
$this->container->set('lazy3', $listener5 = new MyListener());
$this->evm->addEventListener('foo', $listener5 = new MyListener());
$this->evm->addEventListener('bar', $listener5);

$this->evm->dispatchEvent('foo');
$this->evm->dispatchEvent('bar');

$this->container->set('lazy4', $listener6 = new MyListener());
$this->evm->addEventListener('foo', 'lazy4');
$this->evm->addEventListener('foo', $listener7 = new MyListener());
$this->container->set('lazy5', $listener8 = new MyListener());
$this->evm->addEventListener('bar', 'lazy5');
$this->evm->addEventListener('bar', $listener9 = new MyListener());
$this->container->set('lazy6', $listener10 = new MyListener());
$this->evm->addEventListener('foo', $listener10 = new MyListener());
$this->evm->addEventListener('bar', $listener10);

$this->assertTrue($listener1->called);
$this->assertTrue($listener2->called);
$this->assertTrue($listener3->called);
$this->assertTrue($listener4->called);
$this->evm->dispatchEvent('foo');
$this->evm->dispatchEvent('bar');

$this->assertSame(0, $listener1->calledByInvokeCount);
$this->assertSame(2, $listener1->calledByEventNameCount);
$this->assertSame(0, $listener2->calledByInvokeCount);
$this->assertSame(2, $listener2->calledByEventNameCount);
$this->assertSame(2, $listener3->calledByInvokeCount);
$this->assertSame(0, $listener3->calledByEventNameCount);
$this->assertSame(2, $listener4->calledByInvokeCount);
$this->assertSame(0, $listener4->calledByEventNameCount);
$this->assertSame(2, $listener5->calledByInvokeCount);
$this->assertSame(2, $listener5->calledByEventNameCount);

$this->assertSame(0, $listener6->calledByInvokeCount);
$this->assertSame(1, $listener6->calledByEventNameCount);
$this->assertSame(0, $listener7->calledByInvokeCount);
$this->assertSame(1, $listener7->calledByEventNameCount);
$this->assertSame(1, $listener8->calledByInvokeCount);
$this->assertSame(0, $listener8->calledByEventNameCount);
$this->assertSame(1, $listener9->calledByInvokeCount);
$this->assertSame(0, $listener9->calledByEventNameCount);
$this->assertSame(1, $listener10->calledByInvokeCount);
$this->assertSame(1, $listener10->calledByEventNameCount);
}

public function testGetListenersForEvent()
Expand Down Expand Up @@ -107,10 +153,16 @@ public function testRemoveEventListenerAfterDispatchEvent()

class MyListener
{
public $called = false;
public $calledByInvokeCount = 0;
public $calledByEventNameCount = 0;

public function __invoke(): void
{
++$this->calledByInvokeCount;
}

public function foo()
{
$this->called = true;
++$this->calledByEventNameCount;
}
}