| layout | doc |
|---|---|
| title | Symfony - Codeception - Documentation |
{% highlight yaml %} composer require --dev codeception/module-symfony
{% endhighlight %}
This module uses Symfony's DomCrawler and HttpKernel Component to emulate requests and test response.
- Access Symfony services through the dependency injection container:
$I->grabService(...) - Use Doctrine to test against the database:
$I->seeInRepository(...)- see Doctrine Module - Assert that emails would have been sent:
$I->seeEmailIsSent() - Tests are wrapped into Doctrine transaction to speed them up.
- Symfony Router can be cached between requests to speed up testing.
https://github.com/Codeception/symfony-module-tests
app_path: 'src' - Specify custom path to your app dir, where the kernel interface is located.environment: 'local' - Environment used for load kernelkernel_class: 'App\Kernel' - Kernel class nameem_service: 'doctrine.orm.entity_manager' - Use the stated EntityManager to pair with Doctrine Module.debug: true - Turn on/off debug modecache_router: 'false' - Enable router caching between tests in order to increase performance (can have an impact on ajax requests sending via '$I->sendAjaxPostRequest()')rebootable_client: 'true' - Reboot client's kernel before each requestguard: 'false' - Enable custom authentication system with guard (only for Symfony 5.4)bootstrap: 'false' - Enable the test environment setup with the tests/bootstrap.php file if it exists or with Symfony DotEnv otherwise. If false, it does nothing.authenticator: 'false' - Reboot client's kernel before each request (only for Symfony 6.0 or higher)
modules:
enabled:
- Symfony:
app_path: 'src'
environment: 'test'
- kernel - HttpKernel instance
- client - current Crawler instance
services: Includes methods related to the Symfony dependency injection container (DIC):- grabService
- persistService
- persistPermanentService
- unpersistService
See WebDriver module for general information on how to load parts of a framework module.
Usage example:
{% highlight yaml %}
actor: AcceptanceTester modules: enabled: - Symfony: part: services - Doctrine: depends: Symfony - WebDriver: url: http://example.com browser: firefox
{% endhighlight %}
If you're using Symfony with Eloquent ORM (instead of Doctrine), you can load the ORM part of Laravel module
in addition to Symfony module.
hidden API method, expected to be used from Helper classes
apiparam mixed$locatorreturn iterable
Locates element using available Codeception locator types:
- XPath
- CSS
- Strict Locator
Use it in Helpers or GroupObject or Extension classes:
{% highlight php %}
getModule('Symfony')->_findElements('.items'); $els = $this->getModule('Symfony')->_findElements(['name' => 'username']); $editLinks = $this->getModule('Symfony')->_findElements(['link' => 'Edit']); // now you can iterate over $editLinks and check that all them have valid hrefs {% endhighlight %} WebDriver module returns `Facebook\WebDriver\Remote\RemoteWebElement` instances PhpBrowser and Framework modules return `Symfony\Component\DomCrawler\Crawler` instances #### _getResponseContent *hidden API method, expected to be used from Helper classes* * `api` * `throws ModuleException` * `return string` Returns content of the last response Use it in Helpers when you want to retrieve response of request performed by another module. {% highlight php %} assertStringContainsString($text, $this->getModule('Symfony')->_getResponseContent(), "response contains"); } {% endhighlight %} #### _loadPage *hidden API method, expected to be used from Helper classes* * `api` * `param string` $method * `param string` $uri * `param array` $parameters * `param array` $files * `param array` $server * `param ?string` $content * `return void` Opens a page with arbitrary request parameters. Useful for testing multi-step forms on a specific step. {% highlight php %} getModule('Symfony')->_loadPage('POST', '/checkout/step2', ['order' => $orderId]); } {% endhighlight %} #### _request *hidden API method, expected to be used from Helper classes* * `api` * `see` `_loadPage` * `param string` $method * `param string` $uri * `param array` $parameters * `param array` $files * `param array` $server * `param ?string` $content * `throws ExternalUrlException|ModuleException` * `return ?string` Send custom request to a backend using method, uri, parameters, etc. Use it in Helpers to create special request actions, like accessing API Returns a string with response body. {% highlight php %} getModule('Symfony')->_request('POST', '/api/v1/users', ['name' => $name]); $user = json_decode($userData); return $user->id; } {% endhighlight %} Does not load the response into the module so you can't interact with response page (click, fill forms). To load arbitrary page for interaction, use `_loadPage` method. #### _savePageSource *hidden API method, expected to be used from Helper classes* * `api` * `param string` $filename * `return void` Saves page source of to a file {% highlight php %} $this->getModule('Symfony')->_savePageSource(codecept_output_dir().'page.html'); {% endhighlight %} #### amHttpAuthenticated * `param string` $username * `param string` $password * `return void` Authenticates user for HTTP_AUTH #### amLoggedInAs * `param \Symfony\Component\Security\Core\User\UserInterface` $user * `param string` $firewallName * `param ?string` $firewallContext * `return void` Login with the given user object. The `$user` object must have a persistent identifier. If you have more than one firewall or firewall context, you can specify the desired one as a parameter. {% highlight php %} grabEntityFromRepository(User::class, [ 'email' => 'john_doe@example.com' ]); $I->amLoggedInAs($user); {% endhighlight %} #### amLoggedInWithToken * `param \Symfony\Component\Security\Core\Authentication\Token\TokenInterface` $token * `param string` $firewallName * `param ?string` $firewallContext * `return void` #### amOnAction * `param string` $action * `param array` $params * `return void` Opens web page by action name {% highlight php %} amOnAction('PostController::index'); $I->amOnAction('HomeController'); $I->amOnAction('ArticleController', ['slug' => 'lorem-ipsum']); {% endhighlight %} #### amOnPage * `param string` $page * `return void` Opens the page for the given relative URI. {% highlight php %} amOnPage('/'); // opens /register page $I->amOnPage('/register'); {% endhighlight %} #### amOnRoute * `param string` $routeName * `param array` $params * `return void` Opens web page using route name and parameters. {% highlight php %} amOnRoute('posts.create'); $I->amOnRoute('posts.show', ['id' => 34]); {% endhighlight %} #### assertBrowserCookieValueSame * `param string` $name * `param string` $expectedValue * `param bool` $raw * `param string` $path * `param ?string` $domain * `param string` $message * `return void` Asserts that the given cookie in the test client is set to the expected value. {% highlight php %} assertBrowserCookieValueSame('cookie_name', 'expected_value'); {% endhighlight %} #### assertBrowserHasCookie * `param string` $name * `param string` $path * `param ?string` $domain * `param string` $message * `return void` Asserts that the test client has the specified cookie set. This indicates that the cookie was set by any response during the test. {% highlight yaml %} assertBrowserHasCookie('cookie_name'); {% endhighlight %} #### assertBrowserNotHasCookie * `param string` $name * `param string` $path * `param ?string` $domain * `param string` $message * `return void` Asserts that the test client does not have the specified cookie set. This indicates that the cookie was not set by any response during the test. {% highlight php %} assertBrowserNotHasCookie('cookie_name'); {% endhighlight %} #### assertCheckboxChecked * `param string` $fieldName * `param string` $message * `return void` Asserts that the checkbox with the given name is checked. {% highlight php %} assertCheckboxChecked('agree_terms'); {% endhighlight %} #### assertCheckboxNotChecked * `param string` $fieldName * `param string` $message * `return void` Asserts that the checkbox with the given name is not checked. {% highlight php %} assertCheckboxNotChecked('subscribe'); {% endhighlight %} #### assertEmailAddressContains * `param string` $headerName * `param string` $expectedValue * `param ?\Symfony\Component\Mime\Email` $email * `return void` Verify that an email contains addresses with a [header](https://datatracker.ietf.org/doc/html/rfc4021) `$headerName` and its expected value `$expectedValue`. If the Email object is not specified, the last email sent is used instead. {% highlight php %} assertEmailAddressContains('To', 'jane_doe@example.com'); {% endhighlight %} #### assertEmailAttachmentCount * `param int` $count * `param ?\Symfony\Component\Mime\Email` $email * `return void` Verify that an email has sent the specified number `$count` of attachments. If the Email object is not specified, the last email sent is used instead. {% highlight php %} assertEmailAttachmentCount(1); {% endhighlight %} #### assertEmailCount * `param int` $count * `param ?string` $transport * `param string` $message * `return void` Asserts that the expected number of emails was sent. {% highlight php %} assertEmailCount(2, 'smtp'); {% endhighlight %} #### assertEmailHasHeader * `param string` $headerName * `param ?\Symfony\Component\Mime\Email` $email * `return void` Verify that an email has a [header](https://datatracker.ietf.org/doc/html/rfc4021) `$headerName`. If the Email object is not specified, the last email sent is used instead. {% highlight php %} assertEmailHasHeader('Bcc'); {% endhighlight %} #### assertEmailHeaderNotSame * `param string` $headerName * `param string` $expectedValue * `param ?\Symfony\Component\Mime\Email` $email * `return void` Verify that the [header](https://datatracker.ietf.org/doc/html/rfc4021) `$headerName` of an email is not the expected one `$expectedValue`. If the Email object is not specified, the last email sent is used instead. {% highlight php %} assertEmailHeaderNotSame('To', 'john_doe@gmail.com'); {% endhighlight %} #### assertEmailHeaderSame * `param string` $headerName * `param string` $expectedValue * `param ?\Symfony\Component\Mime\Email` $email * `return void` Verify that the [header](https://datatracker.ietf.org/doc/html/rfc4021) `$headerName` of an email is the same as expected `$expectedValue`. If the Email object is not specified, the last email sent is used instead. {% highlight php %} assertEmailHeaderSame('To', 'jane_doe@gmail.com'); {% endhighlight %} #### assertEmailHtmlBodyContains * `param string` $text * `param ?\Symfony\Component\Mime\Email` $email * `return void` Verify that the HTML body of an email contains `$text`. If the Email object is not specified, the last email sent is used instead. {% highlight php %} assertEmailHtmlBodyContains('Successful registration'); {% endhighlight %} #### assertEmailHtmlBodyNotContains * `param string` $text * `param ?\Symfony\Component\Mime\Email` $email * `return void` Verify that the HTML body of an email does not contain a text `$text`. If the Email object is not specified, the last email sent is used instead. {% highlight php %} assertEmailHtmlBodyNotContains('userpassword'); {% endhighlight %} #### assertEmailIsNotQueued * `param \Symfony\Component\Mailer\Event\MessageEvent` $event * `param string` $message * `return void` Asserts that the given mailer event is not queued. Use `getMailerEvent(int $index = 0, ?string $transport = null)` to retrieve a mailer event by index. {% highlight php %} getMailerEvent(); $I->assertEmailIsNotQueued($event); {% endhighlight %} #### assertEmailIsQueued * `param \Symfony\Component\Mailer\Event\MessageEvent` $event * `param string` $message * `return void` Asserts that the given mailer event is queued. Use `getMailerEvent(int $index = 0, ?string $transport = null)` to retrieve a mailer event by index. {% highlight php %} getMailerEvent(); $I->assertEmailIsQueued($event); {% endhighlight %} #### assertEmailNotHasHeader * `param string` $headerName * `param ?\Symfony\Component\Mime\Email` $email * `return void` Verify that an email does not have a [header](https://datatracker.ietf.org/doc/html/rfc4021) `$headerName`. If the Email object is not specified, the last email sent is used instead. {% highlight php %} assertEmailNotHasHeader('Bcc'); {% endhighlight %} #### assertEmailTextBodyContains * `param string` $text * `param ?\Symfony\Component\Mime\Email` $email * `return void` Verify the text body of an email contains a `$text`. If the Email object is not specified, the last email sent is used instead. {% highlight php %} assertEmailTextBodyContains('Example text body'); {% endhighlight %} #### assertEmailTextBodyNotContains * `param string` $text * `param ?\Symfony\Component\Mime\Email` $email * `return void` Verify that the text body of an email does not contain a `$text`. If the Email object is not specified, the last email sent is used instead. {% highlight php %} assertEmailTextBodyNotContains('My secret text body'); {% endhighlight %} #### assertFormValue * `param string` $formSelector * `param string` $fieldName * `param string` $value * `param string` $message * `return void` Asserts that value of the field of the first form matching the given selector does equal the expected value. {% highlight php %} assertFormValue('#loginForm', 'username', 'john_doe'); {% endhighlight %} #### assertHttpClientRequest * `param string` $expectedUrl * `param string` $expectedMethod * `param string|array|null` $expectedBody * `param array` $expectedHeaders * `param string` $httpClientId * `return void` Asserts that the given URL has been called using, if specified, the given method, body and/or headers. By default, it will inspect the default Symfony HttpClient; you may check a different one by passing its service-id in $httpClientId. It succeeds even if the request was executed multiple times. {% highlight php %} assertHttpClientRequest( 'https://example.com/api', 'POST', '{"data": "value"}', ['Authorization' => 'Bearer token'] ); {% endhighlight %} #### assertHttpClientRequestCount * `param int` $count * `param string` $httpClientId * `return void` Asserts that exactly $count requests have been executed by the given HttpClient. By default, it will inspect the default Symfony HttpClient; you may check a different one by passing its service-id in $httpClientId. {% highlight php %} $I->assertHttpClientRequestCount(3); {% endhighlight %} #### assertInputValueNotSame * `param string` $fieldName * `param string` $expectedValue * `param string` $message * `return void` Asserts that the value of the form input with the given name does not equal the expected value. {% highlight php %} assertInputValueNotSame('username', 'admin'); {% endhighlight %} #### assertInputValueSame * `param string` $fieldName * `param string` $expectedValue * `param string` $message * `return void` Asserts that the value of the form input with the given name equals the expected value. {% highlight php %} assertInputValueSame('username', 'johndoe'); {% endhighlight %} #### assertNoFormValue * `param string` $formSelector * `param string` $fieldName * `param string` $message * `return void` Asserts that the field of the first form matching the given selector does not have a value. {% highlight php %} assertNoFormValue('#registrationForm', 'middle_name'); {% endhighlight %} #### assertNotHttpClientRequest * `param string` $unexpectedUrl * `param string` $unexpectedMethod * `param string` $httpClientId * `return void` Asserts that the given URL *has not* been requested with the supplied HTTP method. By default, it will inspect the default Symfony HttpClient; you may check a different one by passing its service-id in $httpClientId. {% highlight php %} $I->assertNotHttpClientRequest('https://example.com/unexpected', 'GET'); {% endhighlight %} #### assertNotificationCount * `param int` $count * `param ?string` $transportName * `param string` $message * `return void` Asserts that the expected number of notifications was sent. {% highlight php %} assertNotificationCount(2, 'smtp'); {% endhighlight %} #### assertNotificationIsNotQueued * `param \Symfony\Component\Notifier\Event\MessageEvent` $event * `param string` $message * `return void` Asserts that the given notifier event is not queued. Use `getNotifierEvent(int $index = 0, ?string $transportName = null)` to retrieve a notifier event by index. {% highlight php %} getNotifierEvent(); $I->asserNotificationIsNotQueued($event); {% endhighlight %} #### assertNotificationIsQueued * `param \Symfony\Component\Notifier\Event\MessageEvent` $event * `param string` $message * `return void` Asserts that the given notifier event is queued. Use `getNotifierEvent(int $index = 0, ?string $transportName = null)` to retrieve a notifier event by index. {% highlight php %} getNotifierEvent(); $I->assertNotificationIsQueued($event); {% endhighlight %} #### assertNotificationSubjectContains * `param \Symfony\Component\Notifier\Message\MessageInterface` $notification * `param string` $text * `param string` $message * `return void` Asserts that the given notification contains given subject. Use `getNotifierMessage(int $index = 0, ?string $transportName = null)` to retrieve a notification by index. {% highlight php %} getNotifierMessage(); $I->assertNotificationSubjectContains($notification, 'Subject'); {% endhighlight %} #### assertNotificationSubjectNotContains * `param \Symfony\Component\Notifier\Message\MessageInterface` $notification * `param string` $text * `param string` $message * `return void` Asserts that the given notification does not contain given subject. Use `getNotifierMessage(int $index = 0, ?string $transportName = null)` to retrieve a notification by index. {% highlight php %} getNotifierMessage(); $I->assertNotificationSubjectNotContains($notification, 'Subject'); {% endhighlight %} #### assertNotificationTransportIsEqual * `param \Symfony\Component\Notifier\Message\MessageInterface` $notification * `param ?string` $transportName * `param string` $message * `return void` Asserts that the given notification uses given transport. Use `getNotifierMessage(int $index = 0, ?string $transportName = null)` to retrieve a notification by index. {% highlight php %} getNotifierMessage(); $I->assertNotificationTransportIsEqual($notification, 'chat'); {% endhighlight %} #### assertNotificationTransportIsNotEqual * `param \Symfony\Component\Notifier\Message\MessageInterface` $notification * `param ?string` $transportName * `param string` $message * `return void` Asserts that the given notification does not use given transport. Use `getNotifierMessage(int $index = 0, ?string $transportName = null)` to retrieve a notification by index. {% highlight php %} getNotifierMessage(); $I->assertNotificationTransportIsNotEqual($notification, 'transport'); {% endhighlight %} #### assertPageTitleContains * `param string` $expectedTitle * `param string` $message * `return void` Asserts that the `<title>` element contains the given title. {% highlight php %} assertPageTitleContains('Welcome'); {% endhighlight %} #### assertPageTitleSame * `param string` $expectedTitle * `param string` $message * `return void` Asserts that the `<title>` element equals the given title. {% highlight php %} assertPageTitleSame('Home Page'); {% endhighlight %} #### assertQueuedEmailCount * `param int` $count * `param ?string` $transport * `param string` $message * `return void` Asserts that the expected number of emails was queued (e.g. using the Messenger component). {% highlight php %} assertQueuedEmailCount(1, 'smtp'); {% endhighlight %} #### assertQueuedNotificationCount * `param int` $count * `param ?string` $transportName * `param string` $message * `return void` Asserts that the expected number of notifications was queued (e.g. using the Notifier component). {% highlight php %} assertQueuedNotificationCount(1, 'smtp'); {% endhighlight %} #### assertRequestAttributeValueSame * `param string` $name * `param string` $expectedValue * `param string` $message * `return void` Asserts that the specified request attribute matches the expected value. {% highlight php %} assertRequestAttributeValueSame('attribute_name', 'expected_value'); {% endhighlight %} #### assertResponseCookieValueSame * `param string` $name * `param string` $expectedValue * `param string` $path * `param ?string` $domain * `param string` $message * `return void` Asserts that the specified response cookie is present and matches the expected value. {% highlight php %} assertResponseCookieValueSame('cookie_name', 'expected_value'); {% endhighlight %} #### assertResponseFormatSame * `param ?string` $expectedFormat * `param string` $message * `return void` Asserts that the response format matches the expected format. This checks the format returned by the `Response::getFormat()` method. {% highlight php %} assertResponseFormatSame('json'); {% endhighlight %} #### assertResponseHasCookie * `param string` $name * `param string` $path * `param ?string` $domain * `param string` $message * `return void` Asserts that the specified cookie is present in the response. Optionally, it can check for a specific cookie path or domain. {% highlight php %} assertResponseHasCookie('cookie_name'); {% endhighlight %} #### assertResponseHasHeader * `param string` $headerName * `param string` $message * `return void` Asserts that the specified header is available in the response. For example, use `assertResponseHasHeader('content-type');`. {% highlight php %} assertResponseHasHeader('content-type'); {% endhighlight %} #### assertResponseHeaderNotSame * `param string` $headerName * `param string` $expectedValue * `param string` $message * `return void` Asserts that the specified header does not contain the expected value in the response. For example, use `assertResponseHeaderNotSame('content-type', 'application/octet-stream');`. {% highlight php %} assertResponseHeaderNotSame('content-type', 'application/json'); {% endhighlight %} #### assertResponseHeaderSame * `param string` $headerName * `param string` $expectedValue * `param string` $message * `return void` Asserts that the specified header contains the expected value in the response. For example, use `assertResponseHeaderSame('content-type', 'application/octet-stream');`. {% highlight php %} assertResponseHeaderSame('content-type', 'application/json'); {% endhighlight %} #### assertResponseIsSuccessful * `param string` $message * `param bool` $verbose * `return void` Asserts that the response was successful (HTTP status code is in the 2xx range). {% highlight php %} assertResponseIsSuccessful(); {% endhighlight %} #### assertResponseIsUnprocessable * `param string` $message * `param bool` $verbose * `return void` Asserts that the response is unprocessable (HTTP status code is 422). {% highlight php %} assertResponseIsUnprocessable(); {% endhighlight %} #### assertResponseNotHasCookie * `param string` $name * `param string` $path * `param ?string` $domain * `param string` $message * `return void` Asserts that the specified cookie is not present in the response. Optionally, it can check for a specific cookie path or domain. {% highlight php %} assertResponseNotHasCookie('cookie_name'); {% endhighlight %} #### assertResponseNotHasHeader * `param string` $headerName * `param string` $message * `return void` Asserts that the specified header is not available in the response. {% highlight php %} assertResponseNotHasHeader('content-type'); {% endhighlight %} #### assertResponseRedirects * `param ?string` $expectedLocation * `param ?int` $expectedCode * `param string` $message * `param bool` $verbose * `return void` Asserts that the response is a redirect. Optionally, you can check the target location and status code. The expected location can be either an absolute or a relative path. {% highlight php %} assertResponseRedirects('/login', 302); {% endhighlight %} #### assertResponseStatusCodeSame * `param int` $expectedCode * `param string` $message * `param bool` $verbose * `return void` Asserts that the response status code matches the expected code. {% highlight php %} assertResponseStatusCodeSame(200); {% endhighlight %} #### assertRouteSame * `param string` $expectedRoute * `param array` $parameters * `param string` $message * `return void` Asserts the request matches the given route and optionally route parameters. {% highlight php %} assertRouteSame('profile', ['id' => 123]); {% endhighlight %} #### assertSelectorExists * `param string` $selector * `param string` $message * `return void` Asserts that the given selector matches at least one element in the response. {% highlight php %} assertSelectorExists('.main-content'); {% endhighlight %} #### assertSelectorNotExists * `param string` $selector * `param string` $message * `return void` Asserts that the given selector does not match at least one element in the response. {% highlight php %} assertSelectorNotExists('.error'); {% endhighlight %} #### assertSelectorTextContains * `param string` $selector * `param string` $text * `param string` $message * `return void` Asserts that the first element matching the given selector contains the expected text. {% highlight php %} assertSelectorTextContains('h1', 'Dashboard'); {% endhighlight %} #### assertSelectorTextNotContains * `param string` $selector * `param string` $text * `param string` $message * `return void` Asserts that the first element matching the given selector does not contain the expected text. {% highlight php %} assertSelectorTextNotContains('p', 'error'); {% endhighlight %} #### assertSelectorTextSame * `param string` $selector * `param string` $text * `param string` $message * `return void` Asserts that the text of the first element matching the given selector equals the expected text. {% highlight php %} assertSelectorTextSame('h1', 'Dashboard'); {% endhighlight %} #### attachFile * `param ` $field * `param string` $filename * `return void` Attaches a file relative to the Codeception `_data` directory to the given file upload field. {% highlight php %} attachFile('input[@type="file"]', 'prices.xls'); {% endhighlight %} #### checkOption * `param ` $option * `return void` Ticks a checkbox. For radio buttons, use the `selectOption` method instead. {% highlight php %} checkOption('#agree'); {% endhighlight %} #### click * `param string|array` $link * `param ` $context * `return void` Perform a click on a link or a button, given by a locator. If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string. For buttons, the "value" attribute, "name" attribute, and inner text are searched. For links, the link text is searched. For images, the "alt" attribute and inner text of any parent links are searched. The second parameter is a context (CSS or XPath locator) to narrow the search. Note that if the locator matches a button of type `submit`, the form will be submitted. {% highlight php %} click('Logout'); // button of form $I->click('Submit'); // CSS button $I->click('#form input[type=submit]'); // XPath $I->click('//form/*[@type="submit"]'); // link in context $I->click('Logout', '#nav'); // using strict locator $I->click(['link' => 'Login']); {% endhighlight %} #### deleteHeader @deprecated * `param string` $name * `return void` #### dontSee * `param string` $text * `param array|string` $selector optional * `return void` Checks that the current page doesn't contain the text specified (case insensitive). Give a locator as the second parameter to match a specific region. {% highlight php %} dontSee('Login'); // I can suppose user is already logged in $I->dontSee('Sign Up','h1'); // I can suppose it's not a signup page $I->dontSee('Sign Up','//body/h1'); // with XPath $I->dontSee('Sign Up', ['css' => 'body h1']); // with strict CSS locator {% endhighlight %} Note that the search is done after stripping all HTML tags from the body, so `$I->dontSee('strong')` will fail on strings like: - `I am Stronger than thou
` - `<script>document.createElement('strong');</script>` But will ignore strings like: - `Home` - `Home`
- ``
For checking the raw source code, use `seeInSource()`.
#### dontSeeAuthentication
* `return void`
Check that user is not authenticated.
{% highlight php %}
dontSeeAuthentication();
{% endhighlight %}
#### dontSeeCheckboxIsChecked
* `param ` $checkbox
* `return void`
Check that the specified checkbox is unchecked.
{% highlight php %}
dontSeeCheckboxIsChecked('#agree'); // I suppose user didn't agree to terms
$I->seeCheckboxIsChecked('#signup_form input[type=checkbox]'); // I suppose user didn't check the first checkbox in form.
{% endhighlight %}
#### dontSeeCookie
* `param ` $cookie
* `param ` $params
* `return mixed|void`
Checks that there isn't a cookie with the given name.
You can set additional cookie params like `domain`, `path` as array passed in last argument.
#### dontSeeCurrentUrlEquals
* `param string` $uri
* `return void`
Checks that the current URL (path) doesn't equal the given string.
Unlike `dontSeeInCurrentUrl`, this only matches the full URL.
{% highlight php %}
dontSeeCurrentUrlEquals('/');
{% endhighlight %}
#### dontSeeCurrentUrlMatches
* `param string` $uri
* `return void`
Checks that current URL (path) doesn't match the given regular expression.
{% highlight php %}
dontSeeCurrentUrlMatches('~^/users/\d+$~');
{% endhighlight %}
#### dontSeeDeprecations
* `param string` $message Optional custom failure message.
* `return void`
Asserts that there are no deprecation messages in Symfony's log.
{% highlight php %}
amOnPage('/home');
$I->dontSeeDeprecations();
{% endhighlight %}
#### dontSeeElement
* `param ` $selector
* `param array` $attributes
* `return void`
Checks that the given element is invisible or not present on the page.
You can also specify expected attributes of this element.
{% highlight php %}
dontSeeElement('.error');
$I->dontSeeElement('//form/input[1]');
$I->dontSeeElement('input', ['name' => 'login']);
$I->dontSeeElement('input', ['value' => '123456']);
{% endhighlight %}
#### dontSeeEmailIsSent
* `return void`
Checks that no email was sent.
The check is based on `\Symfony\Component\Mailer\EventListener\MessageLoggerListener`, which means:
If your app performs an HTTP redirect, you need to suppress it using [stopFollowingRedirects()](#stopFollowingRedirects) first; otherwise this check will *always* pass.
{% highlight php %}
dontSeeEmailIsSent();
{% endhighlight %}
#### dontSeeEvent
* `param class-string|list|null` $expected Fully-qualified event class(es) that must **not** appear.
* `return void`
Verifies that **no** events (regular **or** orphan) were dispatched during the test.
{% highlight php %}
dontSeeEvent();
$I->dontSeeEvent('App\MyEvent');
$I->dontSeeEvent(['App\MyEvent', 'App\MyOtherEvent']);
{% endhighlight %}
#### dontSeeEventListenerIsCalled
* `param class-string|object|list` $expected Listeners (class-strings or object instances).
* `param string|list` $events Event name(s) (empty = any).
* `return void`
Verifies that one or more **listeners** were **not** called during the test.
{% highlight php %}
dontSeeEventListenerIsCalled('App\MyEventListener');
$I->dontSeeEventListenerIsCalled(['App\MyEventListener', 'App\MyOtherEventListener']);
$I->dontSeeEventListenerIsCalled('App\MyEventListener', 'my.event');
$I->dontSeeEventListenerIsCalled('App\MyEventListener', ['my.event', 'my.other.event']);
{% endhighlight %}
#### dontSeeEventTriggered
@deprecated
* `param class-string|object|list` $expected
* `return void`
Verifies that one or more event listeners were not called during the test.
{% highlight php %}
dontSeeEventTriggered('App\MyEvent');
$I->dontSeeEventTriggered(new App\Events\MyEvent());
$I->dontSeeEventTriggered(['App\MyEvent', 'App\MyOtherEvent']);
{% endhighlight %}
#### dontSeeFallbackTranslations
* `return void`
Asserts that no fallback translations were found.
{% highlight php %}
dontSeeFallbackTranslations();
{% endhighlight %}
#### dontSeeFormErrors
* `return void`
Verifies that there are no errors bound to the submitted form.
{% highlight php %}
dontSeeFormErrors();
{% endhighlight %}
#### dontSeeInCurrentUrl
* `param string` $uri
* `return void`
Checks that the current URI (path) doesn't contain the given string.
{% highlight php %}
dontSeeInCurrentUrl('/users/');
{% endhighlight %}
#### dontSeeInField
* `param string|array` $field
* `param ` $value
* `return void`
Checks that an input field or textarea doesn't contain the given value.
For fuzzy locators, the field is matched by label text, CSS and XPath.
{% highlight php %}
dontSeeInField('Body','Type your comment here');
$I->dontSeeInField('form textarea[name=body]','Type your comment here');
$I->dontSeeInField('form input[type=hidden]','hidden_value');
$I->dontSeeInField('#searchform input','Search');
$I->dontSeeInField('//form/*[@name=search]','Search');
$I->dontSeeInField(['name' => 'search'], 'Search');
{% endhighlight %}
#### dontSeeInFormFields
* `param ` $formSelector
* `param array` $params
* `return void`
Checks if the array of form parameters (name => value) are not set on the form matched with
the passed selector.
{% highlight php %}
dontSeeInFormFields('form[name=myform]', [
'input1' => 'non-existent value',
'input2' => 'other non-existent value',
]);
{% endhighlight %}
To check that an element hasn't been assigned any one of many values, an array can be passed
as the value:
{% highlight php %}
dontSeeInFormFields('.form-class', [
'fieldName' => [
'This value shouldn\'t be set',
'And this value shouldn\'t be set',
],
]);
{% endhighlight %}
Additionally, checkbox values can be checked with a boolean.
{% highlight php %}
dontSeeInFormFields('#form-id', [
'checkbox1' => true, // fails if checked
'checkbox2' => false, // fails if unchecked
]);
{% endhighlight %}
#### dontSeeInSession
* `param string` $attribute
* `param mixed` $value
* `return void`
Assert that a session attribute does not exist, or is not equal to the passed value.
{% highlight php %}
dontSeeInSession('attribute');
$I->dontSeeInSession('attribute', 'value');
{% endhighlight %}
#### dontSeeInSource
* `param string` $raw
* `return void`
Checks that the current page contains the given string in its
raw source code.
{% highlight php %}
dontSeeInSource('');
{% endhighlight %}
#### dontSeeInTitle
* `param ` $title
* `return mixed|void`
Checks that the page title does not contain the given string.
#### dontSeeLink
* `param string` $text
* `param string` $url
* `return void`
Checks that the page doesn't contain a link with the given string.
If the second parameter is given, only links with a matching "href" attribute will be checked.
{% highlight php %}
dontSeeLink('Logout'); // I suppose user is not logged in
$I->dontSeeLink('Checkout now', '/store/cart.php');
{% endhighlight %}
#### dontSeeMissingTranslations
* `return void`
Asserts that no missing translations were found.
{% highlight php %}
dontSeeMissingTranslations();
{% endhighlight %}
#### dontSeeNotificationIsSent
* `return void`
Checks that no notification was sent.
The check is based on `\Symfony\Component\Notifier\EventListener\NotificationLoggerListener`, which means:
If your app performs an HTTP redirect, you need to suppress it using [stopFollowingRedirects()](#stopFollowingRedirects) first; otherwise this check will *always* pass.
{% highlight php %}
dontSeeNotificationIsSent();
{% endhighlight %}
#### dontSeeOptionIsSelected
* `param ` $selector
* `param ` $optionText
* `return mixed|void`
Checks that the given option is not selected.
{% highlight php %}
dontSeeOptionIsSelected('#form input[name=payment]', 'Visa');
{% endhighlight %}
#### dontSeeOrphanEvent
* `param class-string|list|null` $expected Event class(es) that must **not** appear as orphan.
* `return void`
Verifies that there were no orphan events during the test.
An orphan event is an event that was triggered by manually executing the
{@link https://symfony.com/doc/current/components/event_dispatcher.html#dispatch-the-event dispatch()}
method of the EventDispatcher but was not handled by any listener after it was dispatched.
{% highlight php %}
dontSeeOrphanEvent();
$I->dontSeeOrphanEvent('App\MyEvent');
$I->dontSeeOrphanEvent(['App\MyEvent', 'App\MyOtherEvent']);
{% endhighlight %}
#### dontSeeRememberedAuthentication
* `return void`
Check that user is not authenticated with the 'remember me' option.
{% highlight php %}
dontSeeRememberedAuthentication();
{% endhighlight %}
#### dontSeeRenderedTemplate
* `param string` $template
* `return void`
Asserts that a template was not rendered in the response.
{% highlight php %}
dontSeeRenderedTemplate('home.html.twig');
{% endhighlight %}
#### dontSeeResponseCodeIs
* `param int` $code
* `return void`
Checks that response code is equal to value provided.
{% highlight php %}
dontSeeResponseCodeIs(200);
// recommended \Codeception\Util\HttpCode
$I->dontSeeResponseCodeIs(\Codeception\Util\HttpCode::OK);
{% endhighlight %}
#### dontSeeViolatedConstraint
* `param object` $subject
* `param ?string` $propertyPath
* `param ?string` $constraint
* `return void`
Asserts that the given subject passes validation.
This assertion does not concern the exact number of violations.
{% highlight php %}
dontSeeViolatedConstraint($subject);
$I->dontSeeViolatedConstraint($subject, 'propertyName');
$I->dontSeeViolatedConstraint($subject, 'propertyName', 'Symfony\Validator\ConstraintClass');
{% endhighlight %}
#### fillField
* `param ` $field
* `param ` $value
* `return void`
Fills a text field or textarea with the given string.
{% highlight php %}
fillField("//input[@type='text']", "Hello World!");
$I->fillField(['name' => 'email'], 'jon@example.com');
{% endhighlight %}
#### followRedirect
* `return void`
Follow pending redirect if there is one.
{% highlight php %}
followRedirect();
{% endhighlight %}
#### getMailerEvent
* `param int` $index
* `param ?string` $transport
* `return ?\Symfony\Component\Mailer\Event\MessageEvent`
Returns the mailer event at the specified index.
{% highlight php %}
getMailerEvent();
{% endhighlight %}
#### getNotifierEvent
* `param int` $index
* `param ?string` $transportName
* `return ?\Symfony\Component\Notifier\Event\MessageEvent`
Returns the notifier event at the specified index.
{% highlight php %}
getNotifierEvent();
{% endhighlight %}
#### getNotifierEvents
* `param ?string` $transportName
* `return MessageEvent[]`
#### getNotifierMessage
* `param int` $index
* `param ?string` $transportName
* `return ?\Symfony\Component\Notifier\Message\MessageInterface`
Returns the notifier message at the specified index.
{% highlight php %}
getNotifierMessage();
{% endhighlight %}
#### getNotifierMessages
* `param ?string` $transportName
* `return MessageInterface[]`
#### goToLogoutPath
* `return void`
Go to the configured logout url (by default: `/logout`).
This method includes redirection to the destination page configured after logout.
See the Symfony documentation on ['Logging Out'](https://symfony.com/doc/current/security.html#logging-out).
#### grabAttributeFrom
* `param ` $cssOrXpath
* `param string` $attribute
* `return mixed`
Returns the value of the given attribute value from the given HTML element. For some attributes, the string `true` is returned instead of their literal value (e.g. `disabled="disabled"` or `required="required"`).
Fails if the element is not found. Returns `null` if the attribute is not present on the element.
{% highlight php %}
grabAttributeFrom('#tooltip', 'title');
{% endhighlight %}
#### grabCookie
* `param string` $cookie
* `param array` $params
* `return mixed`
Grabs a cookie value.
You can set additional cookie params like `domain`, `path` in array passed as last argument.
If the cookie is set by an ajax request (XMLHttpRequest), there might be some delay caused by the browser, so try `$I->wait(0.1)`.
#### grabDefinedTranslationsCount
* `return int` The count of defined translations.
Grabs the count of defined translations.
{% highlight php %}
grabDefinedTranslations();
{% endhighlight %}
#### grabFromCurrentUrl
* `param ?string` $uri
* `return mixed`
Executes the given regular expression against the current URI and returns the first capturing group.
If no parameters are provided, the full URI is returned.
{% highlight php %}
grabFromCurrentUrl('~^/user/(\d+)/~');
$uri = $I->grabFromCurrentUrl();
{% endhighlight %}
#### grabLastSentEmail
* `return ?\Symfony\Component\Mime\Email`
Returns the last sent email.
The function is based on `\Symfony\Component\Mailer\EventListener\MessageLoggerListener`, which means:
If your app performs an HTTP redirect after sending the email, you need to suppress it using [stopFollowingRedirects()](#stopFollowingRedirects) first.
See also: [grabSentEmails()](https://codeception.com/docs/modules/Symfony#grabSentEmails)
{% highlight php %}
grabLastSentEmail();
$address = $email->getTo()[0];
$I->assertSame('john_doe@example.com', $address->getAddress());
{% endhighlight %}
#### grabLastSentNotification
* `return ?\Symfony\Component\Notifier\Message\MessageInterface`
Returns the last sent notification.
The check is based on `\Symfony\Component\Notifier\EventListener\NotificationLoggerListener`, which means:
If your app performs an HTTP redirect after sending the notification, you need to suppress it using [stopFollowingRedirects()](#stopFollowingRedirects) first.
See also: [grabSentNotifications()](https://codeception.com/docs/modules/Symfony#grabSentNotifications)
{% highlight php %}
grabLastSentNotification();
$I->assertSame('Subject', $message->getSubject());
{% endhighlight %}
#### grabMultiple
* `param ` $cssOrXpath
* `param ?string` $attribute
* `return string[]`
Grabs either the text content, or attribute values, of nodes
matched by $cssOrXpath and returns them as an array.
{% highlight html %}
First
Second
Third
{% endhighlight %}
{% highlight php %}
grabMultiple('a');
// would return ['#first', '#second', '#third']
$aLinks = $I->grabMultiple('a', 'href');
{% endhighlight %}
#### grabNumRecords
* `param class-string` $entityClass Fully-qualified entity class name
* `param array` $criteria
* `return int`
Returns the number of rows that match the given criteria for the
specified Doctrine entity.
{% highlight php %}
grabNumRecords(User::class, ['status' => 'active']);
{% endhighlight %}
#### grabPageSource
* `throws \Codeception\Exception\ModuleException` if no page was opened.
* `return string` Current page source code.
Grabs current page source code.
#### grabParameter
* `param string` $parameterName
* `return array|bool|string|int|float|UnitEnum|null
Grabs a Symfony parameter
{% highlight php %}
grabParameter('app.business_name');
{% endhighlight %}
This only works for explicitly set parameters (just using `bind` for Symfony's dependency injection is not enough).
#### grabRepository
* `param object|class-string` $mixed
* `return EntityRepository`
Obtains the Doctrine entity repository {@see EntityRepository}
for a given entity, repository class or interface.
{% highlight php %}
grabRepository($user); // entity object
$I->grabRepository(User::class); // entity class
$I->grabRepository(UserRepository::class); // concrete repo
$I->grabRepository(UserRepositoryInterface::class); // interface
{% endhighlight %}
#### grabSentEmails
* `return \Symfony\Component\Mime\RawMessage[]`
Returns an array of all sent emails.
The function is based on `\Symfony\Component\Mailer\EventListener\MessageLoggerListener`, which means:
If your app performs an HTTP redirect after sending the email, you need to suppress it using [stopFollowingRedirects()](#stopFollowingRedirects) first.
See also: [grabLastSentEmail()](https://codeception.com/docs/modules/Symfony#grabLastSentEmail)
{% highlight php %}
grabSentEmails();
{% endhighlight %}
#### grabSentNotifications
* `return MessageInterface[]`
Returns an array of all sent notifications.
The check is based on `\Symfony\Component\Notifier\EventListener\NotificationLoggerListener`, which means:
If your app performs an HTTP redirect after sending the notification, you need to suppress it using [stopFollowingRedirects()](#stopFollowingRedirects) first.
See also: [grabLastSentNotification()](https://codeception.com/docs/modules/Symfony#grabLastSentNotification)
{% highlight php %}
grabSentNotifications();
{% endhighlight %}
#### grabService
* `part` services
* `template` T of object
* `param string|class-string` $serviceId
* `return ($serviceId` is class-string ? T : object)
Grabs a service from the Symfony dependency injection container (DIC).
In the "test" environment, Symfony uses a special `test.service_container`.
See the "[Public Versus Private Services](https://symfony.com/doc/current/service_container/alias_private.html#marking-services-as-public-private)" documentation.
Services that aren't injected anywhere in your app, need to be defined as `public` to be accessible by Codeception.
{% highlight php %}
grabService('doctrine');
{% endhighlight %}
#### grabTextFrom
* `param ` $cssOrXPathOrRegex
* `return mixed`
Finds and returns the text contents of the given element.
If a fuzzy locator is used, the element is found using CSS, XPath,
and by matching the full page source by regular expression.
{% highlight php %}
grabTextFrom('h1');
$heading = $I->grabTextFrom('descendant-or-self::h1');
$value = $I->grabTextFrom('~grabValueFrom('Name');
$name = $I->grabValueFrom('input[name=username]');
$name = $I->grabValueFrom('descendant-or-self::form/descendant::input[@name = 'username']');
$name = $I->grabValueFrom(['name' => 'username']);
{% endhighlight %}
#### haveHttpHeader
* `param string` $name the name of the request header
* `param string` $value the value to set it to for subsequent
requests
* `return void`
Sets the HTTP header to the passed value - which is used on
subsequent HTTP requests through PhpBrowser.
Example:
{% highlight php %}
haveHttpHeader('X-Requested-With', 'Codeception');
$I->amOnPage('test-headers.php');
{% endhighlight %}
To use special chars in Header Key use HTML Character Entities:
Example:
Header with underscore - 'Client_Id'
should be represented as - 'Client_Id' or 'Client_Id'
{% highlight php %}
haveHttpHeader('Client_Id', 'Codeception');
{% endhighlight %}
#### haveServerParameter
* `param string` $name
* `param string` $value
* `return void`
Sets SERVER parameter valid for all next requests.
{% highlight php %}
$I->haveServerParameter('name', 'value');
{% endhighlight %}
#### invalidateCachedRouter
* `return void`
Invalidate previously cached routes.
#### logout
* `return void`
Alias method for [`logoutProgrammatically()`](https://codeception.com/docs/modules/Symfony#logoutProgrammatically)
{% highlight php %}
logout();
{% endhighlight %}
#### logoutProgrammatically
* `return void`
Invalidates the current user's session and expires the session cookies.
This method does not include any redirects after logging out.
{% highlight php %}
logoutProgrammatically();
{% endhighlight %}
#### makeHtmlSnapshot
* `param ?string` $name
* `return void`
Use this method within an [interactive pause](https://codeception.com/docs/02-GettingStarted#Interactive-Pause) to save the HTML source code of the current page.
{% highlight php %}
makeHtmlSnapshot('edit_page');
// saved to: tests/_output/debug/edit_page.html
$I->makeHtmlSnapshot();
// saved to: tests/_output/debug/2017-05-26_14-24-11_4b3403665fea6.html
{% endhighlight %}
#### moveBack
* `param int` $numberOfSteps (default value 1)
* `return void`
Moves back in history.
#### persistPermanentService
* `part` services
* `param non-empty-string` $serviceName
* `return void`
Get service $serviceName and add it to the lists of persistent services,
making that service persistent between tests.
#### persistService
* `part` services
* `param non-empty-string` $serviceName
* `return void`
Get service $serviceName and add it to the lists of persistent services.
#### rebootClientKernel
* `return void`
Reboots the client's kernel.
Can be used to manually reboot the kernel when 'rebootable_client' is set to false.
{% highlight php %}
rebootClientKernel();
// Perform other requests
{% endhighlight %}
#### resetCookie
* `param ` $cookie
* `param ` $params
* `return mixed|void`
Unsets cookie with the given name.
You can set additional cookie params like `domain`, `path` in array passed as last argument.
#### runSymfonyConsoleCommand
* `param string` $command The console command to execute.
* `param array` $parameters
* `param list` $consoleInputs Inputs for interactive questions.
* `param int` $expectedExitCode Expected exit code.
* `return string` Console output (stdout).
Run Symfony console command, grab response and return as string.
Recommended to use for functional testing.
Note: The command execution is isolated to bypass global application events, preventing unintended side effects.
{% highlight php %}
runSymfonyConsoleCommand('hello:world', ['arg' => 'argValue', 'opt1' => 'optValue'], ['input']);
{% endhighlight %}
#### see
* `param string` $text
* `param array|string` $selector optional
* `return void`
Checks that the current page contains the given string (case insensitive).
You can specify a specific HTML element (via CSS or XPath) as the second
parameter to only search within that element.
{% highlight php %}
see('Logout'); // I can suppose user is logged in
$I->see('Sign Up', 'h1'); // I can suppose it's a signup page
$I->see('Sign Up', '//body/h1'); // with XPath
$I->see('Sign Up', ['css' => 'body h1']); // with strict CSS locator
{% endhighlight %}
Note that the search is done after stripping all HTML tags from the body,
so `$I->see('strong')` will return true for strings like:
- `
I am Stronger than thou
` - `<script>document.createElement('strong');</script>` But will *not* be true for strings like: - `Home` - `Home`
- ``
For checking the raw source code, use `seeInSource()`.
#### seeAllTranslationsDefined
* `return void`
Asserts that there are no missing translations and no fallback translations.
{% highlight php %}
seeAllTranslationsDefined();
{% endhighlight %}
#### seeAuthentication
* `return void`
Checks that a user is authenticated.
{% highlight php %}
seeAuthentication();
{% endhighlight %}
#### seeCheckboxIsChecked
* `param ` $checkbox
* `return void`
Checks that the specified checkbox is checked.
{% highlight php %}
seeCheckboxIsChecked('#agree'); // I suppose user agreed to terms
$I->seeCheckboxIsChecked('#signup_form input[type=checkbox]'); // I suppose user agreed to terms, If there is only one checkbox in form.
$I->seeCheckboxIsChecked('//form/input[@type=checkbox and @name=agree]');
{% endhighlight %}
#### seeCookie
* `param ` $cookie
* `param ` $params
* `return mixed|void`
Checks that a cookie with the given name is set.
You can set additional cookie params like `domain`, `path` as array passed in last argument.
{% highlight php %}
seeCookie('PHPSESSID');
{% endhighlight %}
#### seeCurrentActionIs
* `param non-empty-string` $action
* `return void`
Checks that current page matches action
{% highlight php %}
seeCurrentActionIs('PostController::index');
$I->seeCurrentActionIs('HomeController');
{% endhighlight %}
#### seeCurrentRouteIs
* `param string` $routeName
* `param array` $params
* `return void`
Checks that current url matches route.
{% highlight php %}
seeCurrentRouteIs('posts.index');
$I->seeCurrentRouteIs('posts.show', ['id' => 8]);
{% endhighlight %}
#### seeCurrentTemplateIs
* `param string` $expectedTemplate
* `return void`
Asserts that the current template matches the expected template.
{% highlight php %}
seeCurrentTemplateIs('home.html.twig');
{% endhighlight %}
#### seeCurrentUrlEquals
* `param string` $uri
* `return void`
Checks that the current URL (path) is equal to the given string.
{% highlight php %}
seeCurrentUrlEquals('/');
{% endhighlight %}
#### seeCurrentUrlMatches
* `param string` $uri
* `return void`
Checks that the current URL (path) matches the given regular expression.
{% highlight php %}
seeCurrentUrlMatches('~^/users/\d+$~');
{% endhighlight %}
#### seeDefaultLocaleIs
* `param string` $expectedLocale The expected default locale
* `return void`
Asserts that the default locale is the expected one.
{% highlight php %}
seeDefaultLocaleIs('en');
{% endhighlight %}
#### seeElement
* `param ` $selector
* `param array` $attributes
* `return void`
Checks that the given element exists on the page and is visible.
You can also specify expected attributes of this element.
Only works if `` tag is present.
{% highlight php %}
seeElement('.error');
$I->seeElement('//form/input[1]');
$I->seeElement('input', ['name' => 'login']);
$I->seeElement('input', ['value' => '123456']);
// strict locator in first arg, attributes in second
$I->seeElement(['css' => 'form input'], ['name' => 'login']);
{% endhighlight %}
#### seeEmailIsSent
* `param int` $expectedCount The expected number of emails sent
* `return void`
Checks if the given number of emails was sent (default `$expectedCount`: 1).
The check is based on `\Symfony\Component\Mailer\EventListener\MessageLoggerListener`, which means:
If your app performs an HTTP redirect after sending the email, you need to suppress it using [stopFollowingRedirects()](#stopFollowingRedirects) first.
Limitation:
If your mail is sent in a Symfony console command and you start that command in your test with [$I->runShellCommand()](https://codeception.com/docs/modules/Cli#runShellCommand),
Codeception will not notice it.
As a more professional alternative, we recommend Mailpit (see [Addons](https://codeception.com/addons)), which also lets you test the content of the mail.
{% highlight php %}
seeEmailIsSent(2);
{% endhighlight %}
#### seeEvent
* `param class-string|list` $expected Fully-qualified class-name(s) of the expected event(s).
* `return void`
Verifies that at least one of the given events **was** dispatched (regular **or** orphan).
{% highlight php %}
seeEvent('App\MyEvent');
$I->seeEvent(['App\MyEvent', 'App\MyOtherEvent']);
{% endhighlight %}
#### seeEventListenerIsCalled
* `param class-string|object|list` $expected Listeners (class-strings or object instances).
* `param string|list` $events Event name(s) (empty = any).
* `return void`
Verifies that one or more **listeners** were called during the test.
{% highlight php %}
seeEventListenerIsCalled('App\MyEventListener');
$I->seeEventListenerIsCalled(['App\MyEventListener', 'App\MyOtherEventListener']);
$I->seeEventListenerIsCalled('App\MyEventListener', 'my.event');
$I->seeEventListenerIsCalled('App\MyEventListener', ['my.event', 'my.other.event']);
{% endhighlight %}
#### seeEventTriggered
@deprecated
* `param class-string|object|list` $expected
* `return void`
Verifies that one or more event listeners were called during the test.
{% highlight php %}
seeEventTriggered('App\MyEvent');
$I->seeEventTriggered(new App\Events\MyEvent());
$I->seeEventTriggered(['App\MyEvent', 'App\MyOtherEvent']);
{% endhighlight %}
#### seeFallbackLocalesAre
* `param string[]` $expectedLocales The expected fallback locales
* `return void`
Asserts that the fallback locales match the expected ones.
{% highlight php %}
seeFallbackLocalesAre(['es', 'fr']);
{% endhighlight %}
#### seeFallbackTranslationsCountLessThan
* `param int` $limit Maximum count of fallback translations
* `return void`
Asserts that the count of fallback translations is less than the given limit.
{% highlight php %}
seeFallbackTranslationsCountLessThan(10);
{% endhighlight %}
#### seeFormErrorMessage
* `param string` $field
* `param ?string` $message
* `return void`
Verifies that a form field has an error.
You can specify the expected error message as second parameter.
{% highlight php %}
seeFormErrorMessage('username');
$I->seeFormErrorMessage('username', 'Username is empty');
{% endhighlight %}
#### seeFormErrorMessages
* `param array` $expectedErrors
* `return void`
Verifies that multiple fields on a form have errors.
Use a list of field names when you only need to assert that each field
has at least one validation error:
{% highlight php %}
seeFormErrorMessages(['telephone', 'address']);
{% endhighlight %}
Use an associative array to also verify the error text for one or more
fields. The expected message is matched as a substring, so partial
fragments are allowed:
{% highlight php %}
seeFormErrorMessages([
'address' => 'The address is too long',
'telephone' => 'too short',
]);
{% endhighlight %}
You can mix both styles in the same call. If a field maps to `null`,
only the existence of an error is checked for that field:
{% highlight php %}
seeFormErrorMessages([
'telephone' => 'too short',
'address' => null,
'postal code',
]);
{% endhighlight %}
#### seeFormHasErrors
* `return void`
Verifies that there are one or more errors bound to the submitted form.
{% highlight php %}
seeFormHasErrors();
{% endhighlight %}
#### seeInCurrentRoute
* `param string` $routeName
* `return void`
Checks that current url matches route.
Unlike seeCurrentRouteIs, this can match without exact route parameters
{% highlight php %}
seeInCurrentRoute('my_blog_pages');
{% endhighlight %}
#### seeInCurrentUrl
* `param string` $uri
* `return void`
Checks that current URI contains the given string.
{% highlight php %}
seeInCurrentUrl('home');
// to match: /users/1
$I->seeInCurrentUrl('/users/');
{% endhighlight %}
#### seeInField
* `param string|array` $field
* `param ` $value
* `return void`
Checks that the given input field or textarea *equals* (i.e. not just contains) the given value.
Fields are matched by label text, the "name" attribute, CSS, or XPath.
{% highlight php %}
seeInField('Body','Type your comment here');
$I->seeInField('form textarea[name=body]','Type your comment here');
$I->seeInField('form input[type=hidden]','hidden_value');
$I->seeInField('#searchform input','Search');
$I->seeInField('//form/*[@name=search]','Search');
$I->seeInField(['name' => 'search'], 'Search');
{% endhighlight %}
#### seeInFormFields
* `param ` $formSelector
* `param array` $params
* `return void`
Checks if the array of form parameters (name => value) are set on the form matched with the
passed selector.
{% highlight php %}
seeInFormFields('form[name=myform]', [
'input1' => 'value',
'input2' => 'other value',
]);
{% endhighlight %}
For multi-select elements, or to check values of multiple elements with the same name, an
array may be passed:
{% highlight php %}
seeInFormFields('.form-class', [
'multiselect' => [
'value1',
'value2',
],
'checkbox[]' => [
'a checked value',
'another checked value',
],
]);
{% endhighlight %}
Additionally, checkbox values can be checked with a boolean.
{% highlight php %}
seeInFormFields('#form-id', [
'checkbox1' => true, // passes if checked
'checkbox2' => false, // passes if unchecked
]);
{% endhighlight %}
Pair this with submitForm for quick testing magic.
{% highlight php %}
'value',
'field2' => 'another value',
'checkbox1' => true,
// ...
];
$I->submitForm('//form[@id=my-form]', $form, 'submitButton');
// $I->amOnPage('/path/to/form-page') may be needed
$I->seeInFormFields('//form[@id=my-form]', $form);
{% endhighlight %}
#### seeInSession
* `param string` $attribute
* `param mixed` $value
* `return void`
Assert that a session attribute exists.
{% highlight php %}
seeInSession('attribute');
$I->seeInSession('attribute', 'value');
{% endhighlight %}
#### seeInSource
* `param string` $raw
* `return void`
Checks that the current page contains the given string in its
raw source code.
{% highlight php %}
seeInSource('');
{% endhighlight %}
#### seeInTitle
* `param ` $title
* `return mixed|void`
Checks that the page title contains the given string.
{% highlight php %}
seeInTitle('Blog - Post #1');
{% endhighlight %}
#### seeLink
* `param string` $text
* `param ?string` $url
* `return void`
Checks that there's a link with the specified text.
Give a full URL as the second parameter to match links with that exact URL.
{% highlight php %}
seeLink('Logout'); // matches Logout
$I->seeLink('Logout','/logout'); // matches Logout
{% endhighlight %}
#### seeMissingTranslationsCountLessThan
* `param int` $limit Maximum count of missing translations
* `return void`
Asserts that the count of missing translations is less than the given limit.
{% highlight php %}
seeMissingTranslationsCountLessThan(5);
{% endhighlight %}
#### seeNotificationIsSent
* `param int` $expectedCount The expected number of notifications sent
* `return void`
Checks if the given number of notifications was sent (default `$expectedCount`: 1).
The check is based on `\Symfony\Component\Notifier\EventListener\NotificationLoggerListener`, which means:
If your app performs an HTTP redirect after sending the notification, you need to suppress it using [stopFollowingRedirects()](#stopFollowingRedirects) first.
{% highlight php %}
seeNotificationIsSent(2);
{% endhighlight %}
#### seeNumRecords
* `param int` $expectedNum Expected count
* `param class-string` $className Entity class
* `param array` $criteria
* `return void`
Asserts that a given number of records exists for the entity.
'id' is the default search parameter.
{% highlight php %}
seeNumRecords(1, User::class, ['name' => 'davert']);
$I->seeNumRecords(80, User::class);
{% endhighlight %}
#### seeNumberOfElements
* `param ` $selector
* `param int|int[]` $expected
* `return void`
Checks that there are a certain number of elements matched by the given locator on the page.
{% highlight php %}
seeNumberOfElements('tr', 10);
$I->seeNumberOfElements('tr', [0,10]); // between 0 and 10 elements
{% endhighlight %}
#### seeOptionIsSelected
* `param ` $selector
* `param ` $optionText
* `return mixed|void`
Checks that the given option is selected.
{% highlight php %}
seeOptionIsSelected('#form input[name=payment]', 'Visa');
{% endhighlight %}
#### seeOrphanEvent
* `param class-string|list` $expected Event class-name(s) expected to be orphan.
* `return void`
Verifies that one or more orphan events **were** dispatched during the test.
An orphan event is an event that was triggered by manually executing the
{@link https://symfony.com/doc/current/components/event_dispatcher.html#dispatch-the-event dispatch()}
method of the EventDispatcher but was not handled by any listener after it was dispatched.
{% highlight php %}
seeOrphanEvent('App\MyEvent');
$I->seeOrphanEvent(['App\MyEvent', 'App\MyOtherEvent']);
{% endhighlight %}
#### seePageIsAvailable
* `param string|null` $url The URL of the page to check. If null, the current page is checked.
* `return void`
Verifies that a page is available.
By default, it checks the current page. Specify the `$url` parameter to change the page being checked.
{% highlight php %}
amOnPage('/dashboard');
$I->seePageIsAvailable();
$I->seePageIsAvailable('/dashboard'); // Same as above
{% endhighlight %}
#### seePageNotFound
* `return void`
Asserts that current page has 404 response status code.
#### seePageRedirectsTo
* `param string` $page
* `param string` $redirectsTo
* `return void`
Navigates to a page and verifies that it redirects to another page.
{% highlight php %}
seePageRedirectsTo('/admin', '/login');
{% endhighlight %}
#### seeRememberedAuthentication
* `return void`
Checks that a user is authenticated with the 'remember me' option.
{% highlight php %}
seeRememberedAuthentication();
{% endhighlight %}
#### seeRenderedTemplate
* `param string` $template
* `return void`
Asserts that a template was rendered in the response.
That includes templates built with [inheritance](https://twig.symfony.com/doc/3.x/templates.html#template-inheritance).
{% highlight php %}
seeRenderedTemplate('home.html.twig');
$I->seeRenderedTemplate('layout.html.twig');
{% endhighlight %}
#### seeRequestTimeIsLessThan
* `param int|float` $expectedMilliseconds The expected time in milliseconds
* `return void`
Asserts that the time a request lasted is less than expected.
If the page performed an HTTP redirect, only the time of the last request will be taken into account.
You can modify this behavior using [stopFollowingRedirects()](https://codeception.com/docs/modules/Symfony#stopFollowingRedirects) first.
Also, note that using code coverage can significantly increase the time it takes to resolve a request,
which could lead to unreliable results when used together.
It is recommended to set [`rebootable_client`](https://codeception.com/docs/modules/Symfony#Config) to `true` (=default),
cause otherwise this assertion gives false results if you access multiple pages in a row, or if your app performs a redirect.
#### seeResponseCodeIs
* `param int` $code
* `return void`
Checks that response code is equal to value provided.
{% highlight php %}
seeResponseCodeIs(200);
// recommended \Codeception\Util\HttpCode
$I->seeResponseCodeIs(\Codeception\Util\HttpCode::OK);
{% endhighlight %}
#### seeResponseCodeIsBetween
* `param int` $from
* `param int` $to
* `return void`
Checks that response code is between a certain range. Between actually means [from <= CODE <= to]
#### seeResponseCodeIsClientError
* `return void`
Checks that the response code is 4xx
#### seeResponseCodeIsRedirection
* `return void`
Checks that the response code 3xx
#### seeResponseCodeIsServerError
* `return void`
Checks that the response code is 5xx
#### seeResponseCodeIsSuccessful
* `return void`
Checks that the response code 2xx
#### seeSessionHasValues
* `param array` $bindings
* `return void`
Assert that the session has a given list of values.
{% highlight php %}
seeSessionHasValues(['key1', 'key2']);
$I->seeSessionHasValues(['key1' => 'value1', 'key2' => 'value2']);
{% endhighlight %}
#### seeUserHasRole
* `param string` $role
* `return void`
Check that the current user has a role
{% highlight php %}
seeUserHasRole('ROLE_ADMIN');
{% endhighlight %}
#### seeUserHasRoles
* `param string[]` $roles
* `return void`
Verifies that the current user has multiple roles
{% highlight php %}
seeUserHasRoles(['ROLE_USER', 'ROLE_ADMIN']);
{% endhighlight %}
#### seeUserPasswordDoesNotNeedRehash
* `param UserInterface|null` $user
* `return void`
Checks that the user's password would not benefit from rehashing.
If the user is not provided, it is taken from the current session.
You might use this function after performing tasks like registering a user or submitting a password update form.
{% highlight php %}
seeUserPasswordDoesNotNeedRehash();
$I->seeUserPasswordDoesNotNeedRehash($user);
{% endhighlight %}
#### seeViolatedConstraint
* `param object` $subject
* `param ?string` $propertyPath
* `param ?string` $constraint
* `return void`
Asserts that the given subject fails validation.
This assertion does not concern the exact number of violations.
{% highlight php %}
seeViolatedConstraint($subject);
$I->seeViolatedConstraint($subject, 'propertyName');
$I->seeViolatedConstraint($subject, 'propertyName', 'Symfony\Validator\ConstraintClass');
{% endhighlight %}
#### seeViolatedConstraintMessage
* `param string` $expected
* `param object` $subject
* `param string` $propertyPath
* `return void`
Asserts that a constraint violation message or a part of it is present in the subject's violations.
{% highlight php %}
seeViolatedConstraintMessage('too short', $user, 'address');
{% endhighlight %}
#### seeViolatedConstraintsCount
* `param int` $expected
* `param object` $subject
* `param ?string` $propertyPath
* `param ?string` $constraint
* `return void`
Asserts the exact number of violations for the given subject.
{% highlight php %}
seeViolatedConstraintsCount(3, $subject);
$I->seeViolatedConstraintsCount(2, $subject, 'propertyName');
{% endhighlight %}
#### selectOption
* `param ` $select
* `param ` $option
* `return void`
Selects an option in a select tag or in radio button group.
{% highlight php %}
selectOption('form select[name=account]', 'Premium');
$I->selectOption('form input[name=payment]', 'Monthly');
$I->selectOption('//form/select[@name=account]', 'Monthly');
{% endhighlight %}
Provide an array for the second argument to select multiple options:
{% highlight php %}
selectOption('Which OS do you use?', ['Windows', 'Linux']);
{% endhighlight %}
Or provide an associative array for the second argument to specifically define which selection method should be used:
{% highlight php %}
selectOption('Which OS do you use?', ['text' => 'Windows']); // Only search by text 'Windows'
$I->selectOption('Which OS do you use?', ['value' => 'windows']); // Only search by value 'windows'
{% endhighlight %}
#### sendAjaxGetRequest
* `param string` $uri
* `param array` $params
* `return void`
Sends an ajax GET request with the passed parameters.
See `sendAjaxPostRequest()`
#### sendAjaxPostRequest
* `param string` $uri
* `param array` $params
* `return void`
Sends an ajax POST request with the passed parameters.
The appropriate HTTP header is added automatically:
`X-Requested-With: XMLHttpRequest`
Example:
{% highlight php %}
sendAjaxPostRequest('/add-task', ['task' => 'lorem ipsum']);
{% endhighlight %}
Some frameworks (e.g. Symfony) create field names in the form of an "array":
``
In this case you need to pass the fields like this:
{% highlight php %}
sendAjaxPostRequest('/add-task', ['form' => [
'task' => 'lorem ipsum',
'category' => 'miscellaneous',
]]);
{% endhighlight %}
#### sendAjaxRequest
* `param string` $method
* `param string` $uri
* `param array` $params
* `return void`
Sends an ajax request, using the passed HTTP method.
See `sendAjaxPostRequest()`
Example:
{% highlight php %}
sendAjaxRequest('PUT', '/posts/7', ['title' => 'new title']);
{% endhighlight %}
#### setCookie
* `param ` $name
* `param ` $val
* `param ` $params
* `return mixed|void`
Sets a cookie with the given name and value.
You can set additional cookie params like `domain`, `path`, `expires`, `secure` in array passed as last argument.
{% highlight php %}
setCookie('PHPSESSID', 'el4ukv0kqbvoirg7nkp4dncpk3');
{% endhighlight %}
#### setMaxRedirects
* `param int` $maxRedirects
* `return void`
Sets the maximum number of redirects that the Client can follow.
{% highlight php %}
setMaxRedirects(2);
{% endhighlight %}
#### setServerParameters
* `param array` $params
* `return void`
Sets SERVER parameters valid for all next requests.
this will remove old ones.
{% highlight php %}
$I->setServerParameters([]);
{% endhighlight %}
#### startFollowingRedirects
* `return void`
Enables automatic redirects to be followed by the client.
{% highlight php %}
startFollowingRedirects();
{% endhighlight %}
#### stopFollowingRedirects
* `return void`
Prevents automatic redirects to be followed by the client.
{% highlight php %}
stopFollowingRedirects();
{% endhighlight %}
#### submitForm
* `param ` $selector
* `param array` $params
* `param ?string` $button
* `return void`
Submits the given form on the page, with the given form
values. Pass the form field's values as an array in the second
parameter.
Although this function can be used as a short-hand version of
`fillField()`, `selectOption()`, `click()` etc. it has some important
differences:
* Only field *names* may be used, not CSS/XPath selectors nor field labels
* If a field is sent to this function that does *not* exist on the page,
it will silently be added to the HTTP request. This is helpful for testing
some types of forms, but be aware that you will *not* get an exception
like you would if you called `fillField()` or `selectOption()` with
a missing field.
Fields that are not provided will be filled by their values from the page,
or from any previous calls to `fillField()`, `selectOption()` etc.
You don't need to click the 'Submit' button afterwards.
This command itself triggers the request to form's action.
You can optionally specify which button's value to include
in the request with the last parameter (as an alternative to
explicitly setting its value in the second parameter), as
button values are not otherwise included in the request.
Examples:
{% highlight php %}
submitForm('#login', [
'login' => 'davert',
'password' => '123456'
]);
// or
$I->submitForm('#login', [
'login' => 'davert',
'password' => '123456'
], 'submitButtonName');
{% endhighlight %}
For example, given this sample "Sign Up" form:
{% highlight html %}
Login:
Password:
Do you agree to our terms?
Subscribe to our newsletter?
Select pricing plan: Free Paid {% endhighlight %} You could write the following to submit it: {% highlight php %} submitForm( '#userForm', [ 'user' => [ 'login' => 'Davert', 'password' => '123456', 'agree' => true ] ], 'submitButton' ); {% endhighlight %} Note that "2" will be the submitted value for the "plan" field, as it is the selected option. To uncheck the pre-checked checkbox "newsletter", call `$I->uncheckOption(['name' => 'user[newsletter]']);` *before*, then submit the form as shown here (i.e. without the "newsletter" field in the `$params` array). You can also emulate a JavaScript submission by not specifying any buttons in the third parameter to submitForm. {% highlight php %} submitForm( '#userForm', [ 'user' => [ 'login' => 'Davert', 'password' => '123456', 'agree' => true ] ] ); {% endhighlight %} This function works well when paired with `seeInFormFields()` for quickly testing CRUD interfaces and form validation logic. {% highlight php %} 'value', 'field2' => 'another value', 'checkbox1' => true, // ... ]; $I->submitForm('#my-form', $form, 'submitButton'); // $I->amOnPage('/path/to/form-page') may be needed $I->seeInFormFields('#my-form', $form); {% endhighlight %} Parameter values can be set to arrays for multiple input fields of the same name, or multi-select combo boxes. For checkboxes, you can use either the string value or boolean `true`/`false` which will be replaced by the checkbox's value in the DOM. {% highlight php %} submitForm('#my-form', [ 'field1' => 'value', 'checkbox' => [ 'value of first checkbox', 'value of second checkbox', ], 'otherCheckboxes' => [ true, false, false ], 'multiselect' => [ 'first option value', 'second option value' ] ]); {% endhighlight %} Mixing string and boolean values for a checkbox's value is not supported and may produce unexpected results. Field names ending in `[]` must be passed without the trailing square bracket characters, and must contain an array for its value. This allows submitting multiple values with the same name, consider: {% highlight php %} submitForm('#my-form', [ 'field[]' => 'value', 'field[]' => 'another value', // 'field[]' is already a defined key ]); {% endhighlight %} The solution is to pass an array value: {% highlight php %} submitForm('#my-form', [ 'field' => [ 'value', 'another value', ] ]); {% endhighlight %} #### submitSymfonyForm * `param string` $name The `name` attribute of the ``. You cannot use an array as a selector here. * `param array` $fields * `return void` Submits a form by specifying the form name only once. Use this function instead of [`$I->submitForm()`](#submitForm) to avoid repeating the form name in the field selectors. If you have customized the names of the field selectors, use `$I->submitForm()` for full control. {% highlight php %} submitSymfonyForm('login_form', [ '[email]' => 'john_doe@example.com', '[password]' => 'secretForest' ]); {% endhighlight %} #### switchToIframe * `param string` $name * `return void` Switch to iframe or frame on the page. Example: {% highlight html %} <iframe name="another_frame" src="http://example.com"> {% endhighlight %} {% highlight php %} switchToIframe("another_frame"); {% endhighlight %} #### uncheckOption * `param ` $option * `return void` Unticks a checkbox. {% highlight php %} uncheckOption('#notify'); {% endhighlight %} #### unpersistService * `part` services * `param non-empty-string` $serviceName * `return void` Remove service $serviceName from the lists of persistent services. #### unsetHttpHeader * `param string` $name the name of the header to unset. * `return void` Unsets a HTTP header (that was originally added by [haveHttpHeader()](#haveHttpHeader)), so that subsequent requests will not send it anymore. Example: {% highlight php %} haveHttpHeader('X-Requested-With', 'Codeception'); $I->amOnPage('test-headers.php'); // ... $I->unsetHeader('X-Requested-With'); $I->amOnPage('some-other-page.php'); {% endhighlight %}
Password:
Do you agree to our terms?
Subscribe to our newsletter?
Select pricing plan: Free Paid {% endhighlight %} You could write the following to submit it: {% highlight php %} submitForm( '#userForm', [ 'user' => [ 'login' => 'Davert', 'password' => '123456', 'agree' => true ] ], 'submitButton' ); {% endhighlight %} Note that "2" will be the submitted value for the "plan" field, as it is the selected option. To uncheck the pre-checked checkbox "newsletter", call `$I->uncheckOption(['name' => 'user[newsletter]']);` *before*, then submit the form as shown here (i.e. without the "newsletter" field in the `$params` array). You can also emulate a JavaScript submission by not specifying any buttons in the third parameter to submitForm. {% highlight php %} submitForm( '#userForm', [ 'user' => [ 'login' => 'Davert', 'password' => '123456', 'agree' => true ] ] ); {% endhighlight %} This function works well when paired with `seeInFormFields()` for quickly testing CRUD interfaces and form validation logic. {% highlight php %} 'value', 'field2' => 'another value', 'checkbox1' => true, // ... ]; $I->submitForm('#my-form', $form, 'submitButton'); // $I->amOnPage('/path/to/form-page') may be needed $I->seeInFormFields('#my-form', $form); {% endhighlight %} Parameter values can be set to arrays for multiple input fields of the same name, or multi-select combo boxes. For checkboxes, you can use either the string value or boolean `true`/`false` which will be replaced by the checkbox's value in the DOM. {% highlight php %} submitForm('#my-form', [ 'field1' => 'value', 'checkbox' => [ 'value of first checkbox', 'value of second checkbox', ], 'otherCheckboxes' => [ true, false, false ], 'multiselect' => [ 'first option value', 'second option value' ] ]); {% endhighlight %} Mixing string and boolean values for a checkbox's value is not supported and may produce unexpected results. Field names ending in `[]` must be passed without the trailing square bracket characters, and must contain an array for its value. This allows submitting multiple values with the same name, consider: {% highlight php %} submitForm('#my-form', [ 'field[]' => 'value', 'field[]' => 'another value', // 'field[]' is already a defined key ]); {% endhighlight %} The solution is to pass an array value: {% highlight php %} submitForm('#my-form', [ 'field' => [ 'value', 'another value', ] ]); {% endhighlight %} #### submitSymfonyForm * `param string` $name The `name` attribute of the ``. You cannot use an array as a selector here. * `param array` $fields * `return void` Submits a form by specifying the form name only once. Use this function instead of [`$I->submitForm()`](#submitForm) to avoid repeating the form name in the field selectors. If you have customized the names of the field selectors, use `$I->submitForm()` for full control. {% highlight php %} submitSymfonyForm('login_form', [ '[email]' => 'john_doe@example.com', '[password]' => 'secretForest' ]); {% endhighlight %} #### switchToIframe * `param string` $name * `return void` Switch to iframe or frame on the page. Example: {% highlight html %} <iframe name="another_frame" src="http://example.com"> {% endhighlight %} {% highlight php %} switchToIframe("another_frame"); {% endhighlight %} #### uncheckOption * `param ` $option * `return void` Unticks a checkbox. {% highlight php %} uncheckOption('#notify'); {% endhighlight %} #### unpersistService * `part` services * `param non-empty-string` $serviceName * `return void` Remove service $serviceName from the lists of persistent services. #### unsetHttpHeader * `param string` $name the name of the header to unset. * `return void` Unsets a HTTP header (that was originally added by [haveHttpHeader()](#haveHttpHeader)), so that subsequent requests will not send it anymore. Example: {% highlight php %} haveHttpHeader('X-Requested-With', 'Codeception'); $I->amOnPage('test-headers.php'); // ... $I->unsetHeader('X-Requested-With'); $I->amOnPage('some-other-page.php'); {% endhighlight %}
Module reference is taken from the source code. Help us to improve documentation. Edit module reference