EventProcessors typically ingest multiple event types that they need to retrieve in onComplete or onTimeout. The helper method getEventOfType(string) has been implemented to allow returning either the singular Event or an array of Events that match the requested event type. Null is returned if the requested type has not yet been consumer

Author: lucasnetau

src/StateMachine/AEventProcessor.php

@@ -241,7 +241,7 @@ public function complete() : bool
 
     /**
      * Get the current chain of events that have been consumed
-     * @return array
+     * @return IEvent[]
      */
     public function getEventChain() : array
     {
@@ -272,6 +272,28 @@ public function getLastEvent() : ?Event {
         return $this->consumedEvents[array_key_last($this->consumedEvents)];
     }
 
+    /**
+     * Return one or more events matching the specified type in the order they were captured
+     * @param string $type
+     * @return IEvent|IEvent[]|null
+     */
+    public function getEventOfType(string $type) {
+        $matched = [];
+        foreach($this->consumedEvents as $event) {
+            if ($event->getEventName() === $type) {
+                $matched[] = $event;
+            }
+        }
+        $cnt = count($matched);
+        if (0 === $cnt) {
+            return null;
+        } elseif (1 === $cnt) {
+            return $matched[0];
+        } else {
+            return $matched;
+        }
+    }
+
     /**
      * Trim the number of events we have consumed, retaining the most recent $length number of events
      * @param int $length
@@ -482,16 +504,14 @@ public function resolveEvents(array $events) : void
     /** Completion Callback handlers */
     public function fire(): void
     {
-        $this->onProgress();
-
         if ($this->complete()) {
             $this->onComplete();
             $this->onDone();
-        }
-
-        if ($this->isTimedOut()) {
+        } elseif ($this->isTimedOut()) {
             $this->onTimeout();
             $this->onDone();
+        } else {
+            $this->onProgress();
         }
     }