[EventDispatcher] Add EventListenerCaller

unkind · unkind · commit 39a89a7fc10c · 2016-05-25T19:13:07.000+03:00
diff --git a/src/Symfony/Component/EventDispatcher/EventDispatcher.php b/src/Symfony/Component/EventDispatcher/EventDispatcher.php
@@ -29,6 +29,7 @@ class EventDispatcher implements EventDispatcherInterface
 {
     private $listeners = array();
     private $sorted = array();
+    private $listenerCaller;
 
     /**
      * {@inheritdoc}
@@ -155,6 +156,11 @@ public function removeSubscriber(EventSubscriberInterface $subscriber)
         }
     }
 
+    public function setListenerCaller(EventListenerCallerInterface $listenerCaller)
+    {
+        $this->listenerCaller = $listenerCaller;
+    }
+
     /**
      * Triggers the listeners of an event.
      *
@@ -167,12 +173,27 @@ public function removeSubscriber(EventSubscriberInterface $subscriber)
      */
     protected function doDispatch($listeners, $eventName, Event $event)
     {
+        $listenerCaller = $this->getListenerCaller();
+
         foreach ($listeners as $listener) {
             if ($event->isPropagationStopped()) {
                 break;
             }
-            call_user_func($listener, $event, $eventName, $this);
+
+            $listenerCaller->call($listener, $event, $eventName, $this);
+        }
+    }
+
+    /**
+     * @return EventListenerCallerInterface
+     */
+    private function getListenerCaller()
+    {
+        if (null === $this->listenerCaller) {
+            $this->listenerCaller = new StandardEventListenerCaller();
         }
+
+        return $this->listenerCaller;
     }
 
     /**
diff --git a/src/Symfony/Component/EventDispatcher/EventListenerCallerInterface.php b/src/Symfony/Component/EventDispatcher/EventListenerCallerInterface.php
@@ -0,0 +1,26 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\EventDispatcher;
+
+/**
+ *
+ */
+interface EventListenerCallerInterface
+{
+    /**
+     * @param callable                 $listener
+     * @param Event                    $event
+     * @param string                   $eventName
+     * @param EventDispatcherInterface $eventDispatcher
+     */
+    public function call(callable $listener, Event $event, $eventName, EventDispatcherInterface $eventDispatcher);
+}
diff --git a/src/Symfony/Component/EventDispatcher/StandardEventListenerCaller.php b/src/Symfony/Component/EventDispatcher/StandardEventListenerCaller.php
@@ -0,0 +1,26 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\EventDispatcher;
+
+/**
+ *
+ */
+final class StandardEventListenerCaller implements EventListenerCallerInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function call(callable $listener, Event $event, $eventName, EventDispatcherInterface $eventDispatcher)
+    {
+        $listener($event, $eventName, $eventDispatcher);
+    }
+}
diff --git a/src/Symfony/Component/EventDispatcher/Tests/EventDispatcherTest.php b/src/Symfony/Component/EventDispatcher/Tests/EventDispatcherTest.php
@@ -10,13 +10,35 @@
  */
 
 namespace Symfony\Component\EventDispatcher\Tests;
-
+use Symfony\Component\EventDispatcher\Event;
 use Symfony\Component\EventDispatcher\EventDispatcher;
+use Symfony\Component\EventDispatcher\EventListenerCallerInterface;
 
 class EventDispatcherTest extends AbstractEventDispatcherTest
 {
     protected function createEventDispatcher()
     {
         return new EventDispatcher();
     }
+
+    public function testCustomEventListenerCaller()
+    {
+        $listenerCallerMock = $this->getMockForAbstractClass(EventListenerCallerInterface::class);
+        $listenerCallerMock
+            ->expects($this->once())
+            ->method('call')
+            ->will($this->returnCallback(function ($listener, Event $event) {
+                $listener($event);
+            }));
+
+        $dispatcher = new EventDispatcher();
+        $dispatcher->setListenerCaller($listenerCallerMock);
+        $dispatcher->addListener('foo', function (Event $event) {
+            $event->stopPropagation();
+        });
+
+        $event = $dispatcher->dispatch('foo', new Event());
+
+        $this->assertTrue($event->isPropagationStopped());
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,7 @@ class EventDispatcher implements EventDispatcherInterface`
`29`	`29`	`{`
`30`	`30`	`private $listeners = array();`
`31`	`31`	`private $sorted = array();`
	`32`	`+ private $listenerCaller;`
`32`	`33`
`33`	`34`	`/**`
`34`	`35`	`* {@inheritdoc}`
`@@ -155,6 +156,11 @@ public function removeSubscriber(EventSubscriberInterface $subscriber)`
`155`	`156`	`}`
`156`	`157`	`}`
`157`	`158`
	`159`	`+ public function setListenerCaller(EventListenerCallerInterface $listenerCaller)`
	`160`	`+ {`
	`161`	`+ $this->listenerCaller = $listenerCaller;`
	`162`	`+ }`
	`163`	`+`
`158`	`164`	`/**`
`159`	`165`	`* Triggers the listeners of an event.`
`160`	`166`	`*`
`@@ -167,12 +173,27 @@ public function removeSubscriber(EventSubscriberInterface $subscriber)`
`167`	`173`	`*/`
`168`	`174`	`protected function doDispatch($listeners, $eventName, Event $event)`
`169`	`175`	`{`
	`176`	`+ $listenerCaller = $this->getListenerCaller();`
	`177`	`+`
`170`	`178`	`foreach ($listeners as $listener) {`
`171`	`179`	`if ($event->isPropagationStopped()) {`
`172`	`180`	`break;`
`173`	`181`	`}`
`174`		`- call_user_func($listener, $event, $eventName, $this);`
	`182`	`+`
	`183`	`+ $listenerCaller->call($listener, $event, $eventName, $this);`
	`184`	`+ }`
	`185`	`+ }`
	`186`	`+`
	`187`	`+ /**`
	`188`	`+ * @return EventListenerCallerInterface`
	`189`	`+ */`
	`190`	`+ private function getListenerCaller()`
	`191`	`+ {`
	`192`	`+ if (null === $this->listenerCaller) {`
	`193`	`+ $this->listenerCaller = new StandardEventListenerCaller();`
`175`	`194`	`}`
	`195`	`+`
	`196`	`+ return $this->listenerCaller;`
`176`	`197`	`}`
`177`	`198`
`178`	`199`	`/**`