From 71d11e9ef1ee8a449db7b558a5ca0c09048278e9 Mon Sep 17 00:00:00 2001
From: Mykhailo Sverdlykivskyi <xedelweiss@gmail.com>
Date: Tue, 19 Dec 2023 12:40:02 +0200
Subject: [PATCH] Make phpDoc and variable names more clear

---
 .../Module/Symfony/EventsAssertionsTrait.php  | 20 ++++++++++---------
 1 file changed, 11 insertions(+), 9 deletions(-)

diff --git a/src/Codeception/Module/Symfony/EventsAssertionsTrait.php b/src/Codeception/Module/Symfony/EventsAssertionsTrait.php
index cbc3af2..f6d56cc 100644
--- a/src/Codeception/Module/Symfony/EventsAssertionsTrait.php
+++ b/src/Codeception/Module/Symfony/EventsAssertionsTrait.php
@@ -45,7 +45,7 @@ public function dontSeeOrphanEvent(array|object|string $expected = null): void
 
     /**
      * Verifies that there were no events during the test.
-     * Orphan events are included. Use `dontSeeOrphanEvent` to exclude them.
+     * Both regular and orphan events are checked.
      *
      * ```php
      *  <?php
@@ -158,7 +158,10 @@ public function seeOrphanEvent(array|object|string $expected): void
 
     /**
      * Verifies that one or more events were dispatched during the test.
-     * Orphan events are included. Use `seeOrphanEvent` to exclude them.
+     * Both regular and orphan events are checked.
+     *
+     * If you need to verify that expected event is not orphan,
+     * add `dontSeeOrphanEvent` call.
      *
      * ```php
      *  <?php
@@ -168,7 +171,6 @@ public function seeOrphanEvent(array|object|string $expected): void
      *  ```
      *
      * @param array|object|string $expected
-     * @see seeOrphanEvent
      */
     public function seeEvent(array|object|string $expected): void
     {
@@ -250,7 +252,7 @@ protected function assertEventTriggered(
             $this->fail('No event was triggered');
         }
 
-        $actual = array_map(static fn (Data $data) => $data->getValue(true), $data);
+        $actualEventsCollection = array_map(static fn (Data $data) => $data->getValue(true), $data);
 
         foreach ($expected as $expectedEvent) {
             $expectedEvent = is_object($expectedEvent) ? $expectedEvent::class : $expectedEvent;
@@ -258,16 +260,16 @@ protected function assertEventTriggered(
                 ? "The '{$expectedEvent}' event did not trigger"
                 : "The '{$expectedEvent}' event triggered";
 
-            $condition = false;
+            $eventTriggered = false;
 
-            foreach ($actual as $actualEvents) {
-                $condition = $condition || $this->eventWasTriggered($actualEvents, (string)$expectedEvent);
+            foreach ($actualEventsCollection as $actualEvents) {
+                $eventTriggered = $eventTriggered || $this->eventWasTriggered($actualEvents, (string)$expectedEvent);
             }
 
             if ($assertTrue) {
-                $this->assertTrue($condition, $message);
+                $this->assertTrue($eventTriggered, $message);
             } else {
-                $this->assertFalse($condition, $message);
+                $this->assertFalse($eventTriggered, $message);
             }
         }
     }