Skip to content

Commit beccd5e

Browse files
authored
Deprecate event triggered assertions (#169)
1 parent de2ac28 commit beccd5e

File tree

1 file changed

+39
-1
lines changed

1 file changed

+39
-1
lines changed

src/Codeception/Module/Symfony/EventsAssertionsTrait.php

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,27 @@ public function dontSeeOrphanEvent(array|object|string $expected = null): void
5656
* ```
5757
*
5858
* @param object|string|string[] $expected
59+
* @deprecated Use `dontSeeEventListenerIsCalled()` instead.
5960
*/
6061
public function dontSeeEventTriggered(array|object|string $expected): void
62+
{
63+
trigger_error('dontSeeEventTriggered is deprecated, please use dontSeeEventListenerIsCalled instead', E_USER_DEPRECATED);
64+
$this->dontSeeEventListenerIsCalled($expected);
65+
}
66+
67+
/**
68+
* Verifies that one or more event listeners were not called during the test.
69+
*
70+
* ```php
71+
* <?php
72+
* $I->dontSeeEventListenerIsCalled('App\MyEventListener');
73+
* $I->dontSeeEventListenerIsCalled(new App\Events\MyEventListener());
74+
* $I->dontSeeEventListenerIsCalled(['App\MyEventListener', 'App\MyOtherEventListener']);
75+
* ```
76+
*
77+
* @param object|string|string[] $expected
78+
*/
79+
public function dontSeeEventListenerIsCalled(array|object|string $expected): void
6180
{
6281
$eventCollector = $this->grabEventCollector(__FUNCTION__);
6382

@@ -106,8 +125,27 @@ public function seeOrphanEvent(array|object|string $expected): void
106125
* ```
107126
*
108127
* @param object|string|string[] $expected
128+
* @deprecated Use `seeEventListenerIsCalled()` instead.
109129
*/
110130
public function seeEventTriggered(array|object|string $expected): void
131+
{
132+
trigger_error('seeEventTriggered is deprecated, please use seeEventListenerIsCalled instead', E_USER_DEPRECATED);
133+
$this->seeEventListenerIsCalled($expected);
134+
}
135+
136+
/**
137+
* Verifies that one or more event listeners were called during the test.
138+
*
139+
* ```php
140+
* <?php
141+
* $I->seeEventListenerIsCalled('App\MyEventListener');
142+
* $I->seeEventListenerIsCalled(new App\Events\MyEventListener());
143+
* $I->seeEventListenerIsCalled(['App\MyEventListener', 'App\MyOtherEventListener']);
144+
* ```
145+
*
146+
* @param object|string|string[] $expected
147+
*/
148+
public function seeEventListenerIsCalled(array|object|string $expected): void
111149
{
112150
$eventCollector = $this->grabEventCollector(__FUNCTION__);
113151

@@ -170,4 +208,4 @@ protected function grabEventCollector(string $function): EventDataCollector
170208
{
171209
return $this->grabCollector('events', $function);
172210
}
173-
}
211+
}

0 commit comments

Comments
 (0)