HumHub Documentation (unofficial)

Web
in

Table of Contents

Methods

amOnPage()  : mixed
Opens the page for the given relative URI.
attachFile()  : mixed
Attaches a file relative to the Codeception `_data` directory to the given file upload field.
checkOption()  : mixed
Ticks a checkbox. For radio buttons, use the `selectOption` method instead.
click()  : mixed
Perform a click on a link or a button, given by a locator.
dontSee()  : mixed
Checks that the current page doesn't contain the text specified (case insensitive).
dontSeeCheckboxIsChecked()  : mixed
Check that the specified checkbox is unchecked.
dontSeeCookie()  : mixed
Checks that there isn't a cookie with the given name.
dontSeeCurrentUrlEquals()  : mixed
Checks that the current URL doesn't equal the given string.
dontSeeCurrentUrlMatches()  : mixed
Checks that current url doesn't match the given regular expression.
dontSeeElement()  : mixed
Checks that the given element is invisible or not present on the page.
dontSeeInCurrentUrl()  : mixed
Checks that the current URI doesn't contain the given string.
dontSeeInField()  : mixed
Checks that an input field or textarea doesn't contain the given value.
dontSeeInFormFields()  : mixed
Checks if the array of form parameters (name => value) are not set on the form matched with the passed selector.
dontSeeInSource()  : mixed
Checks that the current page contains the given string in its raw source code.
dontSeeInTitle()  : mixed
Checks that the page title does not contain the given string.
dontSeeLink()  : mixed
Checks that the page doesn't contain a link with the given string.
dontSeeOptionIsSelected()  : mixed
Checks that the given option is not selected.
fillField()  : mixed
Fills a text field or textarea with the given string.
grabAttributeFrom()  : mixed
Grabs the value of the given attribute value from the given element.
grabCookie()  : mixed
Grabs a cookie value.
grabFromCurrentUrl()  : mixed
Executes the given regular expression against the current URI and returns the first capturing group.
grabMultiple()  : array<string|int, string>
Grabs either the text content, or attribute values, of nodes matched by $cssOrXpath and returns them as an array.
grabPageSource()  : string
Grabs current page source code.
grabTextFrom()  : mixed
Finds and returns the text contents of the given element.
grabValueFrom()  : mixed
Finds the value for the given form field.
resetCookie()  : mixed
Unsets cookie with the given name.
see()  : mixed
Checks that the current page contains the given string (case insensitive).
seeCheckboxIsChecked()  : mixed
Checks that the specified checkbox is checked.
seeCookie()  : mixed
Checks that a cookie with the given name is set.
seeCurrentUrlEquals()  : mixed
Checks that the current URL is equal to the given string.
seeCurrentUrlMatches()  : mixed
Checks that the current URL matches the given regular expression.
seeElement()  : mixed
Checks that the given element exists on the page and is visible.
seeInCurrentUrl()  : mixed
Checks that current URI contains the given string.
seeInField()  : mixed
Checks that the given input field or textarea *equals* (i.e. not just contains) the given value.
seeInFormFields()  : mixed
Checks if the array of form parameters (name => value) are set on the form matched with the passed selector.
seeInSource()  : mixed
Checks that the current page contains the given string in its raw source code.
seeInTitle()  : mixed
Checks that the page title contains the given string.
seeLink()  : mixed
Checks that there's a link with the specified text.
seeNumberOfElements()  : mixed
Checks that there are a certain number of elements matched by the given locator on the page.
seeOptionIsSelected()  : mixed
Checks that the given option is selected.
selectOption()  : mixed
Selects an option in a select tag or in radio button group.
setCookie()  : mixed
Sets a cookie with the given name and value.
submitForm()  : mixed
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.
uncheckOption()  : mixed
Unticks a checkbox.

Methods

amOnPage()

Opens the page for the given relative URI.

public amOnPage(string $page) : mixed 
<?php
// opens front page
$I->amOnPage('/');
// opens /register page
$I->amOnPage('/register');
Parameters
$page : string

attachFile()

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

public attachFile(mixed $field, mixed $filename) : mixed 
<?php
// file is stored in 'tests/_data/prices.xls'
$I->attachFile('input[@type="file"]', 'prices.xls');
?>
Parameters
$field : mixed
$filename : mixed

checkOption()

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

public checkOption(mixed $option) : mixed 
<?php
$I->checkOption('#agree');
?>
Parameters
$option : mixed

click()

Perform a click on a link or a button, given by a locator.

public click(mixed $link[, mixed $context = null ]) : mixed

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.

<?php
// simple link
$I->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']);
?>
Parameters
$link : mixed
$context : mixed = null

dontSee()

Checks that the current page doesn't contain the text specified (case insensitive).

public dontSee(string $text[, array<string|int, mixed>|string $selector = null ]) : mixed

Give a locator as the second parameter to match a specific region.

<?php
$I->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

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

  • <p>I am Stronger than thou</p>
  • <script>document.createElement('strong');</script>

But will ignore strings like:

  • <strong>Home</strong>
  • <div class="strong">Home</strong>
  • <!-- strong -->

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

Parameters
$text : string
$selector : array<string|int, mixed>|string = null

optional

dontSeeCheckboxIsChecked()

Check that the specified checkbox is unchecked.

public dontSeeCheckboxIsChecked(mixed $checkbox) : mixed 
<?php
$I->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.
?>
Parameters
$checkbox : mixed

dontSeeCookie()

Checks that there isn't a cookie with the given name.

public dontSeeCookie(mixed $cookie[, array<string|int, mixed> $params = [] ]) : mixed

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

Parameters
$cookie : mixed
$params : array<string|int, mixed> = []

dontSeeCurrentUrlEquals()

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

public dontSeeCurrentUrlEquals(string $uri) : mixed

Unlike dontSeeInCurrentUrl, this only matches the full URL.

<?php
// current url is not root
$I->dontSeeCurrentUrlEquals('/');
?>
Parameters
$uri : string

dontSeeCurrentUrlMatches()

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

public dontSeeCurrentUrlMatches(string $uri) : mixed 
<?php
// to match root url
$I->dontSeeCurrentUrlMatches('~^/users/(\d+)~');
?>
Parameters
$uri : string

dontSeeElement()

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

public dontSeeElement(mixed $selector[, array<string|int, mixed> $attributes = [] ]) : mixed

You can also specify expected attributes of this element.

<?php
$I->dontSeeElement('.error');
$I->dontSeeElement('//form/input[1]');
$I->dontSeeElement('input', ['name' => 'login']);
$I->dontSeeElement('input', ['value' => '123456']);
?>
Parameters
$selector : mixed
$attributes : array<string|int, mixed> = []

dontSeeInCurrentUrl()

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

public dontSeeInCurrentUrl(string $uri) : mixed 
<?php
$I->dontSeeInCurrentUrl('/users/');
?>
Parameters
$uri : string

dontSeeInField()

Checks that an input field or textarea doesn't contain the given value.

public dontSeeInField(mixed $field, mixed $value) : mixed

For fuzzy locators, the field is matched by label text, CSS and XPath.

<?php
$I->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');
?>
Parameters
$field : mixed
$value : mixed

dontSeeInFormFields()

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

public dontSeeInFormFields(mixed $formSelector, mixed $params) : mixed 
<?php
$I->dontSeeInFormFields('form[name=myform]', [
     'input1' => 'non-existent value',
     'input2' => 'other non-existent value',
]);
?>

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

<?php
$I->dontSeeInFormFields('.form-class', [
     'fieldName' => [
         'This value shouldn\'t be set',
         'And this value shouldn\'t be set',
     ],
]);
?>

Additionally, checkbox values can be checked with a boolean.

<?php
$I->dontSeeInFormFields('#form-id', [
     'checkbox1' => true,        // fails if checked
     'checkbox2' => false,       // fails if unchecked
]);
?>
Parameters
$formSelector : mixed
$params : mixed

dontSeeInSource()

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

public dontSeeInSource(mixed $raw) : mixed 
<?php
$I->dontSeeInSource('<h1>Green eggs &amp; ham</h1>');
Parameters
$raw : mixed

dontSeeInTitle()

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

public dontSeeInTitle(mixed $title) : mixed
Parameters
$title : mixed

dontSeeLink()

Checks that the page doesn't contain a link with the given string.

public dontSeeLink(string $text[, string $url = null ]) : mixed

If the second parameter is given, only links with a matching "href" attribute will be checked.

<?php
$I->dontSeeLink('Logout'); // I suppose user is not logged in
$I->dontSeeLink('Checkout now', '/store/cart.php');
?>
Parameters
$text : string
$url : string = null

optional

dontSeeOptionIsSelected()

Checks that the given option is not selected.

public dontSeeOptionIsSelected(mixed $selector, mixed $optionText) : mixed 
<?php
$I->dontSeeOptionIsSelected('#form input[name=payment]', 'Visa');
?>
Parameters
$selector : mixed
$optionText : mixed

fillField()

Fills a text field or textarea with the given string.

public fillField(mixed $field, mixed $value) : mixed 
<?php
$I->fillField("//input[@type='text']", "Hello World!");
$I->fillField(['name' => 'email'], 'jon@example.com');
?>
Parameters
$field : mixed
$value : mixed

grabAttributeFrom()

Grabs the value of the given attribute value from the given element.

public grabAttributeFrom(mixed $cssOrXpath, mixed $attribute) : mixed

Fails if element is not found.

<?php
$I->grabAttributeFrom('#tooltip', 'title');
?>
Parameters
$cssOrXpath : mixed
$attribute : mixed

grabCookie()

Grabs a cookie value.

public grabCookie(mixed $cookie[, array<string|int, mixed> $params = [] ]) : mixed

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).

Parameters
$cookie : mixed
$params : array<string|int, mixed> = []

grabFromCurrentUrl()

Executes the given regular expression against the current URI and returns the first capturing group.

public grabFromCurrentUrl([string $uri = null ]) : mixed

If no parameters are provided, the full URI is returned.

<?php
$user_id = $I->grabFromCurrentUrl('~^/user/(\d+)/~');
$uri = $I->grabFromCurrentUrl();
?>
Parameters
$uri : string = null

optional

grabMultiple()

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

public grabMultiple(mixed $cssOrXpath[, mixed $attribute = null ]) : array<string|int, string> 
<a href="#first">First</a>
<a href="#second">Second</a>
<a href="#third">Third</a>

<?php
// would return ['First', 'Second', 'Third']
$aLinkText = $I->grabMultiple('a');

// would return ['#first', '#second', '#third']
$aLinks = $I->grabMultiple('a', 'href');
?>
Parameters
$cssOrXpath : mixed
$attribute : mixed = null
Return values
array<string|int, string>

grabPageSource()

Grabs current page source code.

public grabPageSource() : string
Return values
string —

Current page source code.

grabTextFrom()

Finds and returns the text contents of the given element.

public grabTextFrom(mixed $cssOrXPathOrRegex) : mixed

If a fuzzy locator is used, the element is found using CSS, XPath, and by matching the full page source by regular expression.

<?php
$heading = $I->grabTextFrom('h1');
$heading = $I->grabTextFrom('descendant-or-self::h1');
$value = $I->grabTextFrom('~<input value=(.*?)]~sgi'); // match with a regex
?>
Parameters
$cssOrXPathOrRegex : mixed

grabValueFrom()

Finds the value for the given form field.

public grabValueFrom(mixed $field) : mixed

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

<?php
$name = $I->grabValueFrom('Name');
$name = $I->grabValueFrom('input[name=username]');
$name = $I->grabValueFrom('descendant-or-self::form/descendant::input[@name = 'username']');
$name = $I->grabValueFrom(['name' => 'username']);
?>
Parameters
$field : mixed

resetCookie()

Unsets cookie with the given name.

public resetCookie(mixed $cookie[, array<string|int, mixed> $params = [] ]) : mixed

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

Parameters
$cookie : mixed
$params : array<string|int, mixed> = []

see()

Checks that the current page contains the given string (case insensitive).

public see(string $text[, array<string|int, mixed>|string $selector = null ]) : mixed

You can specify a specific HTML element (via CSS or XPath) as the second parameter to only search within that element.

<?php
$I->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

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

  • <p>I am Stronger than thou</p>
  • <script>document.createElement('strong');</script>

But will not be true for strings like:

  • <strong>Home</strong>
  • <div class="strong">Home</strong>
  • <!-- strong -->

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

Parameters
$text : string
$selector : array<string|int, mixed>|string = null

optional

seeCheckboxIsChecked()

Checks that the specified checkbox is checked.

public seeCheckboxIsChecked(mixed $checkbox) : mixed 
<?php
$I->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]');
?>
Parameters
$checkbox : mixed

seeCookie()

Checks that a cookie with the given name is set.

public seeCookie(mixed $cookie[, array<string|int, mixed> $params = [] ]) : mixed

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

<?php
$I->seeCookie('PHPSESSID');
?>
Parameters
$cookie : mixed
$params : array<string|int, mixed> = []

seeCurrentUrlEquals()

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

public seeCurrentUrlEquals(string $uri) : mixed

Unlike seeInCurrentUrl, this only matches the full URL.

<?php
// to match root url
$I->seeCurrentUrlEquals('/');
?>
Parameters
$uri : string

seeCurrentUrlMatches()

Checks that the current URL matches the given regular expression.

public seeCurrentUrlMatches(string $uri) : mixed 
<?php
// to match root url
$I->seeCurrentUrlMatches('~^/users/(\d+)~');
?>
Parameters
$uri : string

seeElement()

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

public seeElement(mixed $selector[, array<string|int, mixed> $attributes = [] ]) : mixed

You can also specify expected attributes of this element.

<?php
$I->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']);
?>
Parameters
$selector : mixed
$attributes : array<string|int, mixed> = []
Tags
@return

seeInCurrentUrl()

Checks that current URI contains the given string.

public seeInCurrentUrl(string $uri) : mixed 
<?php
// to match: /home/dashboard
$I->seeInCurrentUrl('home');
// to match: /users/1
$I->seeInCurrentUrl('/users/');
?>
Parameters
$uri : string

seeInField()

Checks that the given input field or textarea *equals* (i.e. not just contains) the given value.

public seeInField(mixed $field, mixed $value) : mixed

Fields are matched by label text, the "name" attribute, CSS, or XPath.

<?php
$I->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');
?>
Parameters
$field : mixed
$value : mixed

seeInFormFields()

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

public seeInFormFields(mixed $formSelector, mixed $params) : mixed 
<?php
$I->seeInFormFields('form[name=myform]', [
     'input1' => 'value',
     'input2' => 'other value',
]);
?>

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

<?php
$I->seeInFormFields('.form-class', [
     'multiselect' => [
         'value1',
         'value2',
     ],
     'checkbox[]' => [
         'a checked value',
         'another checked value',
     ],
]);
?>

Additionally, checkbox values can be checked with a boolean.

<?php
$I->seeInFormFields('#form-id', [
     'checkbox1' => true,        // passes if checked
     'checkbox2' => false,       // passes if unchecked
]);
?>

Pair this with submitForm for quick testing magic.

<?php
$form = [
     'field1' => '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);
?>
Parameters
$formSelector : mixed
$params : mixed

seeInSource()

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

public seeInSource(mixed $raw) : mixed 
<?php
$I->seeInSource('<h1>Green eggs &amp; ham</h1>');
Parameters
$raw : mixed

seeInTitle()

Checks that the page title contains the given string.

public seeInTitle(mixed $title) : mixed 
<?php
$I->seeInTitle('Blog - Post #1');
?>
Parameters
$title : mixed

seeLink()

Checks that there's a link with the specified text.

public seeLink(string $text[, string $url = null ]) : mixed

Give a full URL as the second parameter to match links with that exact URL.

<?php
$I->seeLink('Logout'); // matches <a href="#">Logout</a>
$I->seeLink('Logout','/logout'); // matches <a href="/logout">Logout</a>
?>
Parameters
$text : string
$url : string = null

optional

seeNumberOfElements()

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

public seeNumberOfElements(mixed $selector, mixed $expected) : mixed 
<?php
$I->seeNumberOfElements('tr', 10);
$I->seeNumberOfElements('tr', [0,10]); // between 0 and 10 elements
?>
Parameters
$selector : mixed
$expected : mixed

int or int[]

seeOptionIsSelected()

Checks that the given option is selected.

public seeOptionIsSelected(mixed $selector, mixed $optionText) : mixed 
<?php
$I->seeOptionIsSelected('#form input[name=payment]', 'Visa');
?>
Parameters
$selector : mixed
$optionText : mixed

selectOption()

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

public selectOption(mixed $select, mixed $option) : mixed 
<?php
$I->selectOption('form select[name=account]', 'Premium');
$I->selectOption('form input[name=payment]', 'Monthly');
$I->selectOption('//form/select[@name=account]', 'Monthly');
?>

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

<?php
$I->selectOption('Which OS do you use?', array('Windows','Linux'));
?>

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

<?php
$I->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'
?>
Parameters
$select : mixed
$option : mixed

setCookie()

Sets a cookie with the given name and value.

public setCookie(mixed $name, mixed $val[, array<string|int, mixed> $params = [] ]) : mixed

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

<?php
$I->setCookie('PHPSESSID', 'el4ukv0kqbvoirg7nkp4dncpk3');
?>
Parameters
$name : mixed
$val : mixed
$params : array<string|int, mixed> = []

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.

public submitForm(mixed $selector, mixed $params[, mixed $button = null ]) : mixed

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:

<?php
$I->submitForm('#login', [
    'login' => 'davert',
    'password' => '123456'
]);
// or
$I->submitForm('#login', [
    'login' => 'davert',
    'password' => '123456'
], 'submitButtonName');

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:

<?php
$I->submitForm(
    '#userForm',
    [
        'user' => [
            'login' => 'Davert',
            'password' => '123456',
            'agree' => true
        ]
    ],
    'submitButton'
);

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.

<?php
$I->submitForm(
    '#userForm',
    [
        'user' => [
            'login' => 'Davert',
            'password' => '123456',
            'agree' => true
        ]
    ]
);

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

<?php
$form = [
     'field1' => '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);

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.

<?php
$I->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'
     ]
]);

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:

<?php
// This will NOT work correctly
$I->submitForm('#my-form', [
    'field[]' => 'value',
    'field[]' => 'another value',  // 'field[]' is already a defined key
]);

The solution is to pass an array value:

<?php
// This way both values are submitted
$I->submitForm('#my-form', [
    'field' => [
        'value',
        'another value',
    ]
]);
Parameters
$selector : mixed
$params : mixed
$button : mixed = null

uncheckOption()

Unticks a checkbox.

public uncheckOption(mixed $option) : mixed 
<?php
$I->uncheckOption('#notify');
?>
Parameters
$option : mixed 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results