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.
Public API
Those properties and methods are expected to be used in Helper classes:
Properties:
  
guzzle - contains Guzzle client instance: \GuzzleHttp\Client
  
client - Symfony BrowserKit instance.
Actions
_findElements
hidden API method, expected to be used from Helper classes
  
param mixed $locator
  
return iterable
Locates element using available Codeception locator types:
  
XPath
  
Strict Locator
Use it in Helpers or GroupObject or Extension classes:
$els = $this->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

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

Returns content of the last response Use it in Helpers when you want to retrieve response of request performed by another module.

_loadPage

hidden API method, expected to be used from Helper classes

Opens a page with arbitrary request parameters.

Useful for testing multi-step forms on a specific step.

_request

hidden API method, expected to be used from Helper classes

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.

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

Saves page source of to a file

$this->getModule('PhpBrowser')->_savePageSource(codecept_output_dir().'page.html');

amHttpAuthenticated

Authenticates user for HTTP_AUTH

amOnPage

Opens the page for the given relative URI.

amOnSubdomain

Changes the subdomain for the ‘url’ configuration parameter.

Does not open a page; use amOnPage for that.

amOnUrl

Open web page at the given absolute URL and sets its hostname as the base host.

attachFile

Attaches a file relative to the Codeception _data directory to the given file upload field.

checkOption

Ticks a checkbox. For radio buttons, use the selectOption method instead.

click

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.

deleteHeader

@deprecated

dontSee

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.

Note that the search is done after stripping all HTML tags from the body, so $I->dontSee('strong') will fail on strings like:

But will ignore strings like:

For checking the raw source code, use seeInSource() .

dontSeeCheckboxIsChecked

Check that the specified checkbox is unchecked.

dontSeeCookie

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

Checks that the current URL doesn’t equal the given string.

Unlike dontSeeInCurrentUrl , this only matches the full URL.

dontSeeCurrentUrlMatches

Checks that current url doesn’t match the given regular expression.

dontSeeElement

Checks that the given element is invisible or not present on the page.

You can also specify expected attributes of this element.

dontSeeInCurrentUrl

Checks that the current URI doesn’t contain the given string.

dontSeeInField

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.

dontSeeInFormFields

Checks if the array of form parameters (name => value) are not set on the form matched with the passed selector.

To check that an element hasn’t been assigned any one of many values, an array can be passed as the value:

Additionally, checkbox values can be checked with a boolean.

dontSeeInSource

Checks that the current page contains the given string in its raw source code.

dontSeeInTitle

Checks that the page title does not contain the given string.

dontSeeLink

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.

dontSeeOptionIsSelected

Checks that the given option is not selected.

dontSeeResponseCodeIs

Checks that response code is equal to value provided.

executeInGuzzle

Low-level API method.

If Codeception commands are not enough, use Guzzle HTTP Client methods directly

Example:

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

Fills a text field or textarea with the given string.

followRedirect

Follow pending redirect if there is one.

grabAttributeFrom

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.

grabCookie

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

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.

grabMultiple

Grabs either the text content, or attribute values, of nodes matched by $cssOrXpath and returns them as an array.

<a href="#first">First</a>
<a href="#second">Second</a>
<a href="#third">Third</a>

grabPageSource

Grabs current page source code.

grabTextFrom

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.

grabValueFrom

Finds the value for the given form field.

If a fuzzy locator is used, the field is found by field name, CSS, and XPath.

haveHttpHeader

Sets the HTTP header to the passed value - which is used on subsequent HTTP requests through PhpBrowser.

Example:

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’

haveServerParameter

Sets SERVER parameter valid for all next requests.

$I->haveServerParameter('name', 'value');

makeHtmlSnapshot

Use this method within an interactive pause to save the HTML source code of the current page.

moveBack

Moves back in history.

resetCookie

Unsets cookie with the given name.

You can set additional cookie params like domain , path in array passed as last argument.

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.

Note that the search is done after stripping all HTML tags from the body, so $I->see('strong') will return true for strings like:

But will not be true for strings like:

For checking the raw source code, use seeInSource() .

seeCheckboxIsChecked

Checks that the specified checkbox is checked.

seeCookie

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.

seeCurrentUrlEquals

Checks that the current URL is equal to the given string.

Unlike seeInCurrentUrl , this only matches the full URL.

seeCurrentUrlMatches

Checks that the current URL matches the given regular expression.

seeElement

Checks that the given element exists on the page and is visible.

You can also specify expected attributes of this element. Only works if <html> tag is present.

seeInCurrentUrl

Checks that current URI contains the given string.

seeInField

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.

seeInFormFields

Checks if the array of form parameters (name => value) are set on the form matched with the passed selector.

For multi-select elements, or to check values of multiple elements with the same name, an array may be passed:

Additionally, checkbox values can be checked with a boolean.

Pair this with submitForm for quick testing magic.

seeInSource

Checks that the current page contains the given string in its raw source code.

seeInTitle

Checks that the page title contains the given string.

seeLink

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.

seeNumberOfElements

Checks that there are a certain number of elements matched by the given locator on the page.

seeOptionIsSelected

Checks that the given option is selected.

seePageNotFound

Asserts that current page has 404 response status code.

seeResponseCodeIs

Checks that response code is equal to value provided.

seeResponseCodeIsBetween

Checks that response code is between a certain range. Between actually means [from <= CODE <= to]

seeResponseCodeIsClientError

Checks that the response code is 4xx

seeResponseCodeIsRedirection

Checks that the response code 3xx

seeResponseCodeIsServerError

Checks that the response code is 5xx

seeResponseCodeIsSuccessful

Checks that the response code 2xx

selectOption

Selects an option in a select tag or in radio button group.

Provide an array for the second argument to select multiple options:

Or provide an associative array for the second argument to specifically define which selection method should be used:

sendAjaxGetRequest

Sends an ajax GET request with the passed parameters.

See sendAjaxPostRequest()

sendAjaxPostRequest

Sends an ajax POST request with the passed parameters.

The appropriate HTTP header is added automatically: X-Requested-With: XMLHttpRequest Example:

Some frameworks (e.g. Symfony) create field names in the form of an “array”: <input type="text" name="form[task]"> In this case you need to pass the fields like this:

sendAjaxRequest

Sends an ajax request, using the passed HTTP method.

See sendAjaxPostRequest() Example:

setCookie

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.

setHeader

Alias to haveHttpHeader

setMaxRedirects

Sets the maximum number of redirects that the Client can follow.

setServerParameters

Sets SERVER parameters valid for all next requests.

this will remove old ones.

$I->setServerParameters([]);

startFollowingRedirects

Enables automatic redirects to be followed by the client.

stopFollowingRedirects

Prevents automatic redirects to be followed by the client.

submitForm

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:

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:

For example, given this sample “Sign Up” form:

<form id="userForm">
    Login:
    <input type="text" name="user[login]" /><br/>
    Password:
    <input type="password" name="user[password]" /><br/>
    Do you agree to our terms?
    <input type="checkbox" name="user[agree]" /><br/>
    Subscribe to our newsletter?
    <input type="checkbox" name="user[newsletter]" value="1" checked="checked" /><br/>
    Select pricing plan:
    <select name="plan">
        <option value="1">Free</option>
        <option value="2" selected="selected">Paid</option>
    </select>
    <input type="submit" name="submitButton" value="Submit" />
</form>

You could write the following to submit it:

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.

This function works well when paired with seeInFormFields() for quickly testing CRUD interfaces and form validation logic.

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.

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:

The solution is to pass an array value:

switchToIframe

Switch to iframe or frame on the page.

Example:

<iframe name="another_frame" src="http://example.com">

uncheckOption

Unticks a checkbox.

unsetHttpHeader

Unsets a HTTP header (that was originally added by haveHttpHeader() ), so that subsequent requests will not send it anymore.

Example: