Implements a stack of dispatched events #7404

src/Event/EventManager.php

@@ -53,6 +53,13 @@ class EventManager
      */
     protected $_isGlobal = false;
 
+    /**
+     * A list of already dispatched events
+     *
+     * @var array
+     */
+    protected $_dispatchedEvents = [];
+
     /**
      * Returns the globally available instance of a Cake\Event\EventManager
      * this is used for dispatching events attached from outside the scope
@@ -346,6 +353,7 @@ public function dispatch($event)
 
         $listeners = $this->listeners($event->name());
         if (empty($listeners)) {
+            $this->_dispatchedEvents[] = $event;
             return $event;
         }
 
@@ -361,6 +369,7 @@ public function dispatch($event)
                 $event->result = $result;
             }
         }
+        $this->_dispatchedEvents[] = $event;
         return $event;
     }
 
@@ -460,6 +469,16 @@ public function matchingListeners($eventKeyPattern)
         return $matches;
     }
 
+    /**
+     * Returns a list of dispatched event objects.
+     *
+     * @return array
+     */
+    public function getDispatchedEvents()
+    {
+        return $this->_dispatchedEvents;
+    }
+
     /**
      * Debug friendly object properties.
      *
@@ -473,6 +492,9 @@ public function __debugInfo()
         foreach ($this->_listeners as $key => $listeners) {
             $properties['_listeners'][$key] = count($listeners) . ' listener(s)';
         }
+        foreach ($this->_dispatchedEvents as $event) {
+            $properties['_dispatchedEvents'][] = $event->name() . ' with subject ' . get_class($event->subject());
+        }
         return $properties;
     }
 }

tests/TestCase/Event/EventManagerTest.php

@@ -710,4 +710,26 @@ public function testDispatchWithGlobalAndLocalEvents()
         $this->assertEquals(['listenerFunction'], $listener->callStack);
         $this->assertEquals(['listenerFunction'], $listener2->callStack);
     }
+
+    /**
+     * Test getting a list of dispatched events from the manager.
+     *
+     * @return void
+     * @triggers my_event $this)
+     * @triggers my_second_event $this)
+     */
+    public function testGetDispatchedEvents()
+    {
+        $event = new Event('my_event', $this);
+        $event2 = new Event('my_second_event', $this);
+
+        $manager = new EventManager();
+        $manager->dispatch($event);
+        $manager->dispatch($event2);
+
+        $result = $manager->getDispatchedEvents();
+        $this->assertCount(2, $result);
+        $this->assertEquals($result[0], $event);
+        $this->assertEquals($result[1], $event2);
+    }
 }