removed getOrphanedEvents from TraceableEventDispatcherInterface, int…

…roduced interface deprecation
symfony · mateuszsip · Oct 1, 2017 · Oct 2, 2017 · Oct 2, 2017 · Dec 3, 2017
commit 59c8adf37f696127bfd90c8b6c63f3e6c16464eb
diff --git a/src/Symfony/Bundle/WebProfilerBundle/CHANGELOG.md b/src/Symfony/Bundle/WebProfilerBundle/CHANGELOG.md
@@ -1,10 +1,14 @@
 CHANGELOG
 =========
 
-4.0.0
+4.1.0
 -----
 
  * added information about orphaned events
+
+4.0.0
+-----
+
  * removed the `WebProfilerExtension::dumpValue()` method
  * removed the `getTemplates()` method of the `TemplateManager` class in favor of the ``getNames()`` method
  * removed the `web_profiler.position` config option and the

diff --git a/src/Symfony/Component/EventDispatcher/CHANGELOG.md b/src/Symfony/Component/EventDispatcher/CHANGELOG.md
@@ -1,10 +1,14 @@
 CHANGELOG
 =========
 
+4.1.0
+-----
+
+ * The method `TraceableEventDispatcher::getOrphanedEvents()` has been added.
+
 4.0.0
 -----
 
-  * The method `EventDispatcherInterface::getOrphanedEvents()` has been added.
  * removed the `ContainerAwareEventDispatcher` class
  * added the `reset()` method to the `TraceableEventDispatcherInterface`
 

diff --git a/src/Symfony/Component/EventDispatcher/Debug/TraceableEventDispatcher.php b/src/Symfony/Component/EventDispatcher/Debug/TraceableEventDispatcher.php
@@ -209,6 +209,16 @@ public function getNotCalledListeners()
         return $notCalled;
     }
 
+    /**
+     * Gets the orphaned events.
+     *
+     * @return array An array of orphaned events
+     */
+    public function getOrphanedEvents()
+    {
+        return $this->orphanedEvents;
+    }
+
     public function reset()
     {
         $this->called = array();
@@ -249,8 +259,10 @@ protected function postDispatch($eventName, Event $event)
 
     private function preProcess($eventName)
     {
-        if (false === $this->dispatcher->hasListeners($eventName)) {
+        if (!$this->dispatcher->hasListeners($eventName)) {
             $this->orphanedEvents[] = $eventName;
+
+            return;
         }
 
         foreach ($this->dispatcher->getListeners($eventName) as $listener) {
@@ -325,14 +337,4 @@ private function sortListenersByPriority($a, $b)
 
         return 1;
     }
-
-    /**
-     * Gets the orphaned events.
-     *
-     * @return array An array of orphaned events
-     */
-    public function getOrphanedEvents()
-    {
-        return $this->orphanedEvents;
-    }
 }
diff --git a/src/Symfony/Component/EventDispatcher/Debug/TraceableEventDispatcherInterface.php b/src/Symfony/Component/EventDispatcher/Debug/TraceableEventDispatcherInterface.php
@@ -14,6 +14,8 @@
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 
 /**
+ * @deprecated since version 4.1, will be removed in 5.0.
+ *
  * @author Fabien Potencier <fabien@symfony.com>
  */
 interface TraceableEventDispatcherInterface extends EventDispatcherInterface
@@ -36,11 +38,4 @@ public function getNotCalledListeners();
      * Resets the trace.
      */
     public function reset();
-
-    /**
-     * Gets the orphaned events.
-     *
-     * @return array An array of orphaned events
-     */
-    public function getOrphanedEvents();
 }
diff --git a/src/Symfony/Component/HttpKernel/CHANGELOG.md b/src/Symfony/Component/HttpKernel/CHANGELOG.md
@@ -4,6 +4,7 @@ CHANGELOG
 4.1.0
 -----
 
+ * added orphaned events support to `EventDataCollector`
  * `ExceptionListener` now logs and collects exceptions at priority `2048` (previously logged at `-128` and collected at `0`)
 
 4.0.0
@@ -33,7 +34,6 @@ CHANGELOG
 3.4.0
 -----
 
- * added orphaned events support to `EventDataCollector`
  * added a minimalist PSR-3 `Logger` class that writes in `stderr`
  * made kernels implementing `CompilerPassInterface` able to process the container
  * deprecated bundle inheritance

diff --git a/src/Symfony/Component/HttpKernel/DataCollector/EventDataCollector.php b/src/Symfony/Component/HttpKernel/DataCollector/EventDataCollector.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\HttpKernel\DataCollector;
 
 use Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher;
+use Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcherInterface;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
@@ -53,11 +54,15 @@ public function reset()
 
     public function lateCollect()
     {
-        if ($this->dispatcher instanceof TraceableEventDispatcher) {
+        if ($this->dispatcher instanceof TraceableEventDispatcherInterface) {
             $this->setCalledListeners($this->dispatcher->getCalledListeners());
             $this->setNotCalledListeners($this->dispatcher->getNotCalledListeners());<
F438
/span>
+        }
+
+        if ($this->dispatcher instanceof TraceableEventDispatcher) {
             $this->setOrphanedEvents($this->dispatcher->getOrphanedEvents());
         }
+
         $this->data = $this->cloneVar($this->data);
     }
 
@@ -74,51 +79,51 @@ public function setCalledListeners(array $listeners)
     }
 
     /**
-     * Sets the not called listeners.
+     * Gets the called listeners.
      *
-     * @param array $listeners An array of not called listeners
+     * @return array An array of called listeners
      *
      * @see TraceableEventDispatcher
      */
-    public function setNotCalledListeners(array $listeners)
+    public function getCalledListeners()
     {
-        $this->data['not_called_listeners'] = $listeners;
+        return $this->data['called_listeners'];
     }
 
     /**
-     * Sets the orphaned events.
+     * Sets the not called listeners.
      *
-     * @param array $events An array of orphaned events
+     * @param array $listeners
      *
      * @see TraceableEventDispatcher
      */
-    public function setOrphanedEvents(array $events)
+    public function setNotCalledListeners(array $listeners)
     {
-        $this->data['orphaned_events'] = $events;
+        $this->data['not_called_listeners'] = $listeners;
     }
 
     /**
-     * Gets the called listeners.
+     * Gets the not called listeners.
      *
-     * @return array An array of called listeners
+     * @return array
      *
      * @see TraceableEventDispatcher
      */
-    public function getCalledListeners()
+    public function getNotCalledListeners()
     {
-        return $this->data['called_listeners'];
+        return $this->data['not_called_listeners'];
     }
 
     /**
-     * Gets the not called listeners.
+     * Sets the orphaned events.
      *
-     * @return array An array of not called listeners
+     * @param array $events An array of orphaned events
      *
      * @see TraceableEventDispatcher
      */
-    public function getNotCalledListeners()
+    public function setOrphanedEvents(array $events)
     {
-        return $this->data['not_called_listeners'];
+        $this->data['orphaned_events'] = $events;
     }
 
     /**

diff --git a/src/Symfony/Component/HttpKernel/Tests/Fixtures/TestEventDispatcher.php b/src/Symfony/Component/HttpKernel/Tests/Fixtures/TestEventDispatcher.php
@@ -11,10 +11,9 @@
 
 namespace Symfony\Component\HttpKernel\Tests\Fixtures;
 
-use Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcherInterface;
-use Symfony\Component\EventDispatcher\EventDispatcher;
+use Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher;
 
-class TestEventDispatcher extends EventDispatcher implements TraceableEventDispatcherInterface
+class TestEventDispatcher extends TraceableEventDispatcher
 {
     public function getCalledListeners()
     {