Skip to content

Deprecate event triggered assertions #169

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 18, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 39 additions & 1 deletion src/Codeception/Module/Symfony/EventsAssertionsTrait.php
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,27 @@ public function dontSeeOrphanEvent(array|object|string $expected = null): void
* ```
*
* @param object|string|string[] $expected
* @deprecated Use `dontSeeEventListenerIsCalled()` instead.
*/
public function dontSeeEventTriggered(array|object|string $expected): void
{
trigger_error('dontSeeEventTriggered is deprecated, please use dontSeeEventListenerIsCalled instead', E_USER_DEPRECATED);
$this->dontSeeEventListenerIsCalled($expected);
}

/**
* Verifies that one or more event listeners were not called during the test.
*
* ```php
* <?php
* $I->dontSeeEventListenerIsCalled('App\MyEventListener');
* $I->dontSeeEventListenerIsCalled(new App\Events\MyEventListener());
* $I->dontSeeEventListenerIsCalled(['App\MyEventListener', 'App\MyOtherEventListener']);
* ```
*
* @param object|string|string[] $expected
*/
public function dontSeeEventListenerIsCalled(array|object|string $expected): void
{
$eventCollector = $this->grabEventCollector(__FUNCTION__);

Expand Down Expand Up @@ -106,8 +125,27 @@ public function seeOrphanEvent(array|object|string $expected): void
* ```
*
* @param object|string|string[] $expected
* @deprecated Use `seeEventListenerIsCalled()` instead.
*/
public function seeEventTriggered(array|object|string $expected): void
{
trigger_error('seeEventTriggered is deprecated, please use seeEventListenerIsCalled instead', E_USER_DEPRECATED);
$this->seeEventListenerIsCalled($expected);
}

/**
* Verifies that one or more event listeners were called during the test.
*
* ```php
* <?php
* $I->seeEventListenerIsCalled('App\MyEventListener');
* $I->seeEventListenerIsCalled(new App\Events\MyEventListener());
* $I->seeEventListenerIsCalled(['App\MyEventListener', 'App\MyOtherEventListener']);
* ```
*
* @param object|string|string[] $expected
*/
public function seeEventListenerIsCalled(array|object|string $expected): void
{
$eventCollector = $this->grabEventCollector(__FUNCTION__);

Expand Down Expand Up @@ -170,4 +208,4 @@ protected function grabEventCollector(string $function): EventDataCollector
{
return $this->grabCollector('events', $function);
}
}
}