| layout | title |
|---|---|
doc |
PhpBrowser - Codeception - Documentation |
If you use Codeception installed using composer, install this module with the following command:
{% highlight yaml %} composer require --dev codeception/module-phpbrowser
{% endhighlight %}
Alternatively, you can enable PhpBrowser module in suite configuration file and run
{% highlight yaml %} codecept init upgrade4
{% endhighlight %}
This module was bundled with Codeception 2 and 3, but since version 4 it is necessary to install it separately.
Some modules are bundled with PHAR files.
Warning. Using PHAR file and composer in the same project can cause unexpected errors.
Uses Guzzle to interact with your application over CURL. Module works over CURL and requires PHP CURL extension to be enabled.
Use to perform web acceptance tests with non-javascript browser.
If test fails stores last shown page in 'output' dir.
- Maintainer: davert
- Stability: stable
- Contact: codeception@codeception.com
- url required - start url of your app
- headers - default headers are set before each test.
- handler (default: curl) - Guzzle handler to use. By default curl is used, also possible to pass
stream, or any valid class name as Handler. - middleware - Guzzle middlewares to add. An array of valid callables is required.
- curl - curl options
- cookies - ...
- auth - ...
- verify - ...
- .. those and other Guzzle Request options
modules:
enabled:
- PhpBrowser:
url: 'http://localhost'
auth: ['admin', '123345']
curl:
CURLOPT_RETURNTRANSFER: true
cookies:
cookie-1:
Name: userName
Value: john.doe
cookie-2:
Name: authToken
Value: 1abcd2345
Domain: subdomain.domain.com
Path: /admin/
Expires: 1292177455
Secure: true
HttpOnly: false
All SSL certification checks are disabled by default. Use Guzzle request options to configure certifications and others.
Those properties and methods are expected to be used in Helper classes:
Properties:
guzzle- contains Guzzle client instance:\GuzzleHttp\Clientclient- Symfony BrowserKit instance.
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('PhpBrowser')->_findElements('.items'); $els = $this->getModule('PhpBrowser')->_findElements(['name' => 'username']); $editLinks = $this->getModule('PhpBrowser')->_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('PhpBrowser')->_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('PhpBrowser')->_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('PhpBrowser')->_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('PhpBrowser')->_savePageSource(codecept_output_dir().'page.html'); {% endhighlight %} #### amHttpAuthenticated * `param ` $username * `param ` $password * `return void` Authenticates user for HTTP_AUTH #### amOnPage * `param string` $page * `return void` Opens the page for the given relative URI. {% highlight php %} amOnPage('/'); // opens /register page $I->amOnPage('/register'); {% endhighlight %} #### amOnSubdomain * `param ` $subdomain * `return void` Changes the subdomain for the 'url' configuration parameter. Does not open a page; use `amOnPage` for that. {% highlight php %} amOnSubdomain('user'); $I->amOnPage('/'); // moves to https://user.mysite.com/ {% endhighlight %} #### amOnUrl * `param ` $url * `return void` Open web page at the given absolute URL and sets its hostname as the base host. {% highlight php %} amOnUrl('https://codeception.com'); $I->amOnPage('/quickstart'); // moves to https://codeception.com/quickstart {% 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 * `param string` $name the name of the header to delete. * `return void` Deletes the header with the passed name. Subsequent requests will not have the deleted header in its request. Example: {% highlight php %} haveHttpHeader('X-Requested-With', 'Codeception'); $I->amOnPage('test-headers.php'); // ... $I->deleteHeader('X-Requested-With'); $I->amOnPage('some-other-page.php'); {% endhighlight %} #### 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()`.
#### 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 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 doesn't match the given regular expression.
{% highlight php %}
dontSeeCurrentUrlMatches('~^/users/(\d+)~');
{% 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 %}
#### dontSeeInCurrentUrl
* `param string` $uri
* `return void`
Checks that the current URI 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 %}
#### 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 %}
#### 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 %}
#### 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 %}
#### executeInGuzzle
* `param \Closure` $function
* `return mixed`
Low-level API method.
If Codeception commands are not enough, use [Guzzle HTTP Client](https://guzzlephp.org/) methods directly
Example:
{% highlight php %}
executeInGuzzle(function (\GuzzleHttp\Client $client) {
$client->get('/get', ['query' => ['foo' => 'bar']]);
});
{% endhighlight %}
It is not recommended to use this command on a regular basis.
If Codeception lacks important Guzzle Client methods, implement them and submit patches.
#### 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 %}
#### grabAttributeFrom
* `param ` $cssOrXpath
* `param string` $attribute
* `return mixed`
Grabs the value of the given attribute value from the given element.
Fails if element is not found.
{% 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)`.
#### 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 %}
#### 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 %}
#### grabPageSource
* `throws ModuleException` if no page was opened.
* `return string` Current page source code.
Grabs current page source code.
#### 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 %}
#### 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.
#### 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.
#### 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()`.
#### 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 %}
#### seeCurrentUrlEquals
* `param string` $uri
* `return void`
Checks that the current URL is equal to the given string.
Unlike `seeInCurrentUrl`, this only matches the full URL.
{% highlight php %}
seeCurrentUrlEquals('/');
{% endhighlight %}
#### seeCurrentUrlMatches
* `param string` $uri
* `return void`
Checks that the current URL matches the given regular expression.
{% highlight php %}
seeCurrentUrlMatches('~^/users/(\d+)~');
{% 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.
{% 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 %}
#### 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]', string $form, 'submitButton');
// $I->amOnPage('/path/to/form-page') may be needed
$I->seeInFormFields('//form[@id=my-form]', string $form);
{% 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 %}
#### 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 %}
#### seePageNotFound
* `return void`
Asserts that current page has 404 response status code.
#### 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
#### 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?', array('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?', array('text' => 'Windows')); // Only search by text 'Windows'
$I->selectOption('Which OS do you use?', array('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 %}
#### setHeader
* `param string` $name
* `param string` $value
* `return void`
Alias to `haveHttpHeader`
#### 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 %} #### 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 %}
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 %} #### 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 %}
Module reference is taken from the source code. Help us to improve documentation. Edit module reference