HumHub Documentation (unofficial)

__construct()

Module constructor.

Parameters

$moduleContainer : ModuleContainer

$config : array<string|int, mixed>|null = null

_after()

**HOOK** executed after test

Parameters

$test : TestInterface

_afterStep()

**HOOK** executed after step

Parameters

$step : Step

_afterSuite()

**HOOK** executed after suite

_backupSession()

Returns current WebDriver session for saving

_before()

**HOOK** executed before test

Parameters

$test : TestInterface

_beforeStep()

**HOOK** executed before step

Parameters

$step : Step

_beforeSuite()

**HOOK** executed before suite

Parameters

$settings : array<string|int, mixed> = []

_capabilities()

Change capabilities of WebDriver. Should be executed before starting a new browser session.

<?php // in helper
public function _before(TestInterface $test)
{
    $this->getModule('WebDriver')->_capabilities(function($currentCapabilities) {
        // or new \Facebook\WebDriver\Remote\DesiredCapabilities();
        return \Facebook\WebDriver\Remote\DesiredCapabilities::firefox();
    });
}

modules:
    enabled:
        - \Helper\Acceptance
        - WebDriver

<?php // inside Helper\Acceptance
public function _before(TestInterface $test)
{
     $name = $test->getMetadata()->getName();
     $this->getModule('WebDriver')->_capabilities(function($currentCapabilities) use ($name) {
         $currentCapabilities['name'] = $name;
         return $currentCapabilities;
     });
}

Parameters

$capabilityFunction : Closure

_closeSession()

Manually closes current WebDriver session.

<?php
$this->getModule('WebDriver')->_closeSession();

// close a specific session
$webDriver = $this->getModule('WebDriver')->webDriver;
$this->getModule('WebDriver')->_closeSession($webDriver);

Parameters

$webDriver : mixed = null

(optional) a specific webdriver session instance

_conflicts()

Returns class name or interface of module which can conflict with current.

_failed()

**HOOK** executed when test fails but before `_after`

Parameters

$test : TestInterface

$fail : mixed

_findClickable()

Locates a clickable element.

<?php
$module = $this->getModule('WebDriver');
$page = $module->webDriver;

// search a link or button on a page
$el = $module->_findClickable($page, 'Click Me');

// search a link or button within an element
$topBar = $module->_findElements('.top-bar')[0];
$el = $module->_findClickable($topBar, 'Click Me');

Parameters

$page : RemoteWebDriver

WebDriver instance or an element to search within

$link : mixed

a link text or locator to click

_findElements()

Locates element using available Codeception locator types:

<?php
$els = $this->getModule('{{MODULE_NAME}}')->_findElements('.items');
$els = $this->getModule('{{MODULE_NAME}}')->_findElements(['name' => 'username']);

$editLinks = $this->getModule('{{MODULE_NAME}}')->_findElements(['link' => 'Edit']);
// now you can iterate over $editLinks and check that all them have valid hrefs

Parameters

$locator : mixed

_getConfig()

Get config values or specific config item.

Parameters

$key : mixed = null

_getCurrentUri()

Uri of currently opened page.

Tags

throws

ModuleException

_getName()

Returns a module name for a Module, a class name for Helper

_getUrl()

Returns URL of a host.

Tags

throws

ModuleConfigException

_hasRequiredFields()

Checks if a module has required fields

_initialize()

**HOOK** triggered after module is created and configuration is loaded

_initializeSession()

Manually starts a new browser session.

<?php
$this->getModule('WebDriver')->_initializeSession();

_loadSession()

Loads current RemoteWebDriver instance as a session

Parameters

$session : RemoteWebDriver

_reconfigure()

Allows to redefine config for a specific test.

<?php
// cleanup DB only for specific group of tests
public function _before(Test $test) {
    if (in_array('cleanup', $test->getMetadata()->getGroups()) {
        $this->getModule('Db')->_reconfigure(['cleanup' => true]);
    }
}

Parameters

$config : mixed

Tags

throws

ModuleConfigException

throws

ModuleException

_requires()

Returns list of classes and corresponding packages required for this module

_resetConfig()

Reverts config changed by `_reconfigure`

_restart()

Restarts a web browser.

<?php
// inside a Helper
$this->getModule('WebDriver')->_restart(); // just restart
$this->getModule('WebDriver')->_restart(['browser' => $browser]); // reconfigure + restart

Parameters

$config : array<string|int, mixed> = []

_saveElementScreenshot()

Parameters

$selector : mixed

$filename : mixed

_savePageSource()

Saves HTML source of a page to a file

Parameters

$filename : mixed

_saveScreenshot()

Saves screenshot of current page to a file

$this->getModule('{{MODULE_NAME}}')->_saveScreenshot(codecept_output_dir().'screenshot_1.png');

Parameters

$filename : mixed

_setConfig()

Allows to define initial module config.

<?php
public function _beforeSuite($settings = []) {
    $this->getModule('otherModule')->_setConfig($this->myOtherConfig);
}

Parameters

$config : mixed

Tags

throws

ModuleConfigException

throws

ModuleException

acceptPopup()

Accepts the active JavaScript native popup window, as created by `window.alert`|`window.confirm`|`window.prompt`.

amOnPage()

Opens the page for the given relative URI.

<?php
// opens front page
$I->amOnPage('/');
// opens /register page
$I->amOnPage('/register');

Parameters

$page : mixed

amOnSubdomain()

Changes the subdomain for the 'url' configuration parameter.

<?php
// If config is: 'http://mysite.com'
// or config is: 'http://www.mysite.com'
// or config is: 'http://company.mysite.com'

$I->amOnSubdomain('user');
$I->amOnPage('/');
// moves to http://user.mysite.com/
?>

Parameters

$subdomain : mixed

amOnUrl()

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

<?php
$I->amOnUrl('https://codeception.com');
$I->amOnPage('/quickstart'); // moves to https://codeception.com/quickstart
?>

Parameters

$url : mixed

appendField()

Append the given text to the given element.

<?php
$I->appendField('#mySelectbox', 'SelectValue');
$I->appendField('#myTextField', 'appended');
?>

Parameters

$field : string

$value : string

Tags

throws

ElementNotFound

attachFile()

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

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

Parameters

$field : mixed

$filename : mixed

cancelPopup()

Dismisses the active JavaScript popup, as created by `window.alert`, `window.confirm`, or `window.prompt`.

checkOption()

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

<?php
$I->checkOption('#agree');
?>

Parameters

$option : mixed

clearField()

Clears given field which isn't empty.

<?php
$I->clearField('#username');

Parameters

$field : mixed

click()

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

<?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

clickWithLeftButton()

Performs click with the left mouse button on an element.

<?php
$I->clickWithLeftButton(['css' => '.checkout']);
$I->clickWithLeftButton(null, 20, 50);
$I->clickWithLeftButton(['css' => '.checkout'], 20, 50);
?>

Parameters

$cssOrXPath : string = null

css or xpath of the web element (body by default).

$offsetX : int = null

$offsetY : int = null

Tags

throws

ElementNotFound

clickWithRightButton()

Performs contextual click with the right mouse button on an element.

<?php
$I->clickWithRightButton(['css' => '.checkout']);
$I->clickWithRightButton(null, 20, 50);
$I->clickWithRightButton(['css' => '.checkout'], 20, 50);
?>

Parameters

$cssOrXPath : string = null

css or xpath of the web element (body by default).

$offsetX : int = null

$offsetY : int = null

Tags

throws

ElementNotFound

closeTab()

Closes current browser tab and switches to previous active tab.

<?php
$I->closeTab();

debugWebDriverLogs()

Print out latest Selenium Logs in debug mode

Parameters

$test : TestInterface = null

deleteSessionSnapshot()

Deletes session snapshot.

Parameters

$name : mixed

dontSee()

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

<?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

Parameters

$text : mixed

$selector : mixed = null

optional

dontSeeCheckboxIsChecked()

Check that the specified checkbox is unchecked.

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

Parameters

$cookie : mixed

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

dontSeeCurrentUrlEquals()

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

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

Parameters

$uri : mixed

dontSeeCurrentUrlMatches()

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

<?php
// to match root url
$I->dontSeeCurrentUrlMatches('~^/users/(\d+)~');
?>

Parameters

$uri : mixed

dontSeeElement()

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

<?php
$I->dontSeeElement('.error');
$I->dontSeeElement('//form/input[1]');
$I->dontSeeElement('input', ['name' => 'login']);
$I->dontSeeElement('input', ['value' => '123456']);
?>

Parameters

$selector : mixed

$attributes : mixed = []

dontSeeElementInDOM()

Opposite of `seeElementInDOM`.

Parameters

$selector : mixed

$attributes : array<string|int, mixed> = []

dontSeeInCurrentUrl()

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

<?php
$I->dontSeeInCurrentUrl('/users/');
?>

Parameters

$uri : mixed

dontSeeInField()

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

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

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

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

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

Parameters

$formSelector : mixed

$params : array<string|int, mixed>

dontSeeInPageSource()

Checks that the page source doesn't contain the given string.

Parameters

$text : mixed

dontSeeInPopup()

Checks that the active JavaScript popup, as created by `window.alert`|`window.confirm`|`window.prompt`, does NOT contain the given string.

Parameters

$text : mixed

Tags

throws

ModuleException

dontSeeInSource()

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

<?php
$I->dontSeeInSource('<h1>Green eggs &amp; ham</h1>');

Parameters

$raw : mixed

dontSeeInTitle()

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

Parameters

$title : mixed

dontSeeLink()

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

<?php
$I->dontSeeLink('Logout'); // I suppose user is not logged in
$I->dontSeeLink('Checkout now', '/store/cart.php');
?>

Parameters

$text : mixed

$url : mixed = null

optional

dontSeeOptionIsSelected()

Checks that the given option is not selected.

<?php
$I->dontSeeOptionIsSelected('#form input[name=payment]', 'Visa');
?>

Parameters

$selector : mixed

$optionText : mixed

doubleClick()

Performs a double-click on an element matched by CSS or XPath.

Parameters

$cssOrXPath : mixed

Tags

throws

ElementNotFound

dragAndDrop()

Performs a simple mouse drag-and-drop operation.

<?php
$I->dragAndDrop('#drag', '#drop');
?>

Parameters

$source : string

(CSS ID or XPath)

$target : string

(CSS ID or XPath)

executeAsyncJS()

Executes asynchronous JavaScript.

// wait for 1200 milliseconds my running `setTimeout`
* $I->executeAsyncJS('setTimeout(arguments[0], 1200)');

$seconds = 1200; // or seconds are passed as argument
$I->executeAsyncJS('setTimeout(arguments[1], arguments[0])', [$seconds]);

Parameters

$script : mixed

$arguments : array<string|int, mixed> = []

executeInSelenium()

Low-level API method.

$I->executeInSelenium(function(\Facebook\WebDriver\Remote\RemoteWebDriver $webdriver) {
  $webdriver->get('http://google.com');
});

Parameters

$function : callable

executeJS()

Executes custom JavaScript.

<?php
$myVar = $I->executeJS('return $("#myField").val()');

// additional arguments can be passed as array
// Example shows `Hello World` alert:
$I->executeJS("window.alert(arguments[0])", ['Hello world']);

Parameters

$script : mixed

$arguments : array<string|int, mixed> = []

fillField()

Fills a text field or textarea with the given string.

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

<?php
$I->grabAttributeFrom('#tooltip', 'title');
?>

Parameters

$cssOrXpath : mixed

$attribute : mixed

grabCookie()

Grabs a cookie value.

Parameters

$cookie : mixed

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

grabFromCurrentUrl()

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

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

Parameters

$uri : mixed = null

optional

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>

<?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

grabPageSource()

Grabs current page source code.

Tags

throws

ModuleException

if no page was opened.

grabTextFrom()

Finds and returns the text contents of the given element.

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

<?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

loadSessionSnapshot()

Loads cookies from a saved snapshot.

Parameters

$name : mixed

makeElementScreenshot()

Takes a screenshot of an element of the current window and saves it to `tests/_output/debug`.

<?php
$I->amOnPage('/user/edit');
$I->makeElementScreenshot('#dialog', 'edit_page');
// saved to: tests/_output/debug/edit_page.png
$I->makeElementScreenshot('#dialog');
// saved to: tests/_output/debug/2017-05-26_14-24-11_4b3403665fea6.png

Parameters

$selector : mixed

$name : mixed = null

makeHtmlSnapshot()

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.

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

Parameters

$name : mixed = null

makeScreenshot()

Takes a screenshot of the current window and saves it to `tests/_output/debug`.

<?php
$I->amOnPage('/user/edit');
$I->makeScreenshot('edit_page');
// saved to: tests/_output/debug/edit_page.png
$I->makeScreenshot();
// saved to: tests/_output/debug/2017-05-26_14-24-11_4b3403665fea6.png

Parameters

$name : mixed = null

maximizeWindow()

Maximizes the current window.

moveBack()

Moves back in history.

moveForward()

Moves forward in history.

moveMouseOver()

Move mouse over the first element matched by the given locator.

<?php
$I->moveMouseOver(['css' => '.checkout']);
$I->moveMouseOver(null, 20, 50);
$I->moveMouseOver(['css' => '.checkout'], 20, 50);
?>

Parameters

$cssOrXPath : string = null

css or xpath of the web element

$offsetX : int = null

$offsetY : int = null

Tags

throws

ElementNotFound

openNewTab()

Opens a new browser tab and switches to it.

<?php
$I->openNewTab();

performOn()

Waits for element and runs a sequence of actions inside its context.

<?php
$I->performOn($el, ['see' => 'text']);

<?php
$I->performOn('.model', ActionSequence::build()
    ->see('Warning')
    ->see('Are you sure you want to delete this?')
    ->click('Yes')
);

<?php
$I->performOn('.rememberMe', function (WebDriver $I) {
     $I->see('Remember me next time');
     $I->seeElement('#LoginForm_rememberMe');
     $I->dontSee('Login');
});

Parameters

$element : mixed

$actions : mixed

$timeout : int = 10

pressKey()

Presses the given key on the given element.

<?php
// <input id="page" value="old" />
$I->pressKey('#page','a'); // => olda
$I->pressKey('#page',array('ctrl','a'),'new'); //=> new
$I->pressKey('#page',array('shift','111'),'1','x'); //=> old!!!1x
$I->pressKey('descendant-or-self::*[@id='page']','u'); //=> oldu
$I->pressKey('#name', array('ctrl', 'a'), \Facebook\WebDriver\WebDriverKeys::DELETE); //=>''
?>

Parameters

$element : mixed

$char : mixed

string|array Can be char or array with modifier. You can provide several chars.

Tags

throws

ElementNotFound

reloadPage()

Reloads the current page.

resetCookie()

Unsets cookie with the given name.

Parameters

$cookie : mixed

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

resizeWindow()

Resize the current window.

<?php
$I->resizeWindow(800, 600);

Parameters

$width : int

$height : int

saveSessionSnapshot()

Saves current cookies into named snapshot in order to restore them in other tests This is useful to save session state between tests.

<?php
// inside AcceptanceTester class:

public function login()
{
     // if snapshot exists - skipping login
     if ($I->loadSessionSnapshot('login')) return;

     // logging in
     $I->amOnPage('/login');
     $I->fillField('name', 'jon');
     $I->fillField('password', '123345');
     $I->click('Login');

     // saving snapshot
     $I->saveSessionSnapshot('login');
}
?>

Parameters

$name : mixed

scrollTo()

Move to the middle of the given element matched by the given locator.

<?php
$I->scrollTo(['css' => '.checkout'], 20, 50);
?>

Parameters

$selector : mixed

$offsetX : int = null

$offsetY : int = null

see()

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

<?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

Parameters

$text : mixed

$selector : mixed = null

optional

seeCheckboxIsChecked()

Checks that the specified checkbox is checked.

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

<?php
$I->seeCookie('PHPSESSID');
?>

Parameters

$cookie : mixed

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

seeCurrentUrlEquals()

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

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

Parameters

$uri : mixed

seeCurrentUrlMatches()

Checks that the current URL matches the given regular expression.

<?php
// to match root url
$I->seeCurrentUrlMatches('~^/users/(\d+)~');
?>

Parameters

$uri : mixed

seeElement()

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

<?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 : mixed = []

seeElementInDOM()

Checks that the given element exists on the page, even it is invisible.

<?php
$I->seeElementInDOM('//form/input[type=hidden]');
?>

Parameters

$selector : mixed

$attributes : array<string|int, mixed> = []

seeInCurrentUrl()

Checks that current URI contains the given string.

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

Parameters

$uri : mixed

seeInField()

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

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

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

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

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

<?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 : array<string|int, mixed>

seeInPageSource()

Checks that the page source contains the given string.

<?php
$I->seeInPageSource('<link rel="apple-touch-icon"');

Parameters

$text : mixed

seeInPopup()

Checks that the active JavaScript popup, as created by `window.alert`|`window.confirm`|`window.prompt`, contains the given string.

Parameters

$text : mixed

Tags

throws

ModuleException

seeInSource()

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

<?php
$I->seeInSource('<h1>Green eggs &amp; ham</h1>');

Parameters

$raw : mixed

seeInTitle()

Checks that the page title contains the given string.

<?php
$I->seeInTitle('Blog - Post #1');
?>

Parameters

$title : mixed

seeLink()

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

<?php
$I->seeLink('Logout'); // matches <a href="#">Logout</a>
$I->seeLink('Logout','/logout'); // matches <a href="/logout">Logout</a>
?>

Parameters

$text : mixed

$url : mixed = null

optional

seeNumberOfElements()

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

<?php
$I->seeNumberOfElements('tr', 10);
$I->seeNumberOfElements('tr', [0,10]); // between 0 and 10 elements
?>

Parameters

$selector : mixed

$expected : mixed

int or int[]

seeNumberOfElementsInDOM()

Parameters

$selector : mixed

$expected : mixed

seeNumberOfTabs()

Checks current number of opened tabs

<?php
$I->seeNumberOfTabs(2);

Parameters

$number : mixed

number of tabs

seeOptionIsSelected()

Checks that the given option is selected.

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

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

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

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

<?php
$I->setCookie('PHPSESSID', 'el4ukv0kqbvoirg7nkp4dncpk3');
?>

Parameters

$cookie : mixed

$value : mixed

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

$showDebug : mixed = true

submitForm()

Submits the given form on the page, optionally with the given form values. Give the form fields values as an array. Note that hidden fields can't be accessed.

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

<form action="/sign_up">
    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/>
    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>

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

<?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);
?>

<?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',
     ]
]);
?>

$I->submitForm('#my-form', [
    'field[]' => 'value',
    'field[]' => 'another value', // 'field[]' is already a defined key
]);

// this way both values are submitted
$I->submitForm('#my-form', [
    'field' => [
        'value',
        'another value',
    ]
]);

<input type="submit" name="submitButton" value="Submit" />

Parameters

$selector : mixed

$params : mixed

$button : mixed = null

switchToFrame()

Switch to another frame on the page.

<frame name="another_frame" id="fr1" src="http://example.com">

<?php
# switch to frame by name
$I->switchToFrame("another_frame");
# switch to frame by CSS or XPath
$I->switchToFrame("#fr1");
# switch to parent page
$I->switchToFrame();

Parameters

$locator : string|null = null

(name, CSS or XPath)

switchToIFrame()

Switch to another iframe on the page.

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

<?php
# switch to iframe by name
$I->switchToIFrame("another_frame");
# switch to iframe by CSS or XPath
$I->switchToIFrame("#fr1");
# switch to parent page
$I->switchToIFrame();

Parameters

$locator : string|null = null

(name, CSS or XPath)

switchToNextTab()

Switches to next browser tab.

<?php
// switch to next tab
$I->switchToNextTab();
// switch to 2nd next tab
$I->switchToNextTab(2);

Parameters

$offset : int = 1

1

switchToPreviousTab()

Switches to previous browser tab.

<?php
// switch to previous tab
$I->switchToPreviousTab();
// switch to 2nd previous tab
$I->switchToPreviousTab(2);

Parameters

$offset : int = 1

1

switchToWindow()

Switch to another window identified by name.

<input type="button" value="Open window" onclick="window.open('http://example.com', 'another_window')">

<?php
$I->click("Open window");
# switch to another window
$I->switchToWindow("another_window");
# switch to parent window
$I->switchToWindow();
?>

<?php
$I->executeInSelenium(function (\Facebook\WebDriver\Remote\RemoteWebDriver $webdriver) {
     $handles=$webdriver->getWindowHandles();
     $last_window = end($handles);
     $webdriver->switchTo()->window($last_window);
});
?>

Parameters

$name : string|null = null

type()

Type in characters on active element.

<?php
// activate input element
$I->click('#input');

// type text in active element
$I->type('Hello world');

// type text with a 1sec delay between chars
$I->type('Hello World', 1);

Parameters

$text : mixed

$delay : mixed = 0

[sec]

typeInPopup()

Enters text into a native JavaScript prompt popup, as created by `window.prompt`.

Parameters

$keys : mixed

Tags

throws

ModuleException

uncheckOption()

Unticks a checkbox.

<?php
$I->uncheckOption('#notify');
?>

Parameters

$option : mixed

unselectOption()

Unselect an option in the given select box.

Parameters

$select : mixed

$option : mixed

wait()

Wait for $timeout seconds.

Parameters

$timeout : int|float

secs

Tags

throws

TestRuntimeException

waitForElement()

Waits up to $timeout seconds for an element to appear on the page.

<?php
$I->waitForElement('#agree_button', 30); // secs
$I->click('#agree_button');
?>

Parameters

$element : mixed

$timeout : int = 10

seconds

Tags

throws

Exception

waitForElementChange()

Waits up to $timeout seconds for the given element to change.

<?php
use \Facebook\WebDriver\WebDriverElement
$I->waitForElementChange('#menu', function(WebDriverElement $el) {
    return $el->isDisplayed();
}, 100);
?>

Parameters

$element : mixed

$callback : Closure

$timeout : int = 30

seconds

Tags

throws

ElementNotFound

waitForElementClickable()

Waits up to $timeout seconds for the given element to be clickable.

<?php
$I->waitForElementClickable('#agree_button', 30); // secs
$I->click('#agree_button');
?>

Parameters

$element : mixed

$timeout : int = 10

seconds

Tags

throws

Exception

waitForElementNotVisible()

Waits up to $timeout seconds for the given element to become invisible.

<?php
$I->waitForElementNotVisible('#agree_button', 30); // secs
?>

Parameters

$element : mixed

$timeout : int = 10

seconds

Tags

throws

Exception

waitForElementVisible()

Waits up to $timeout seconds for the given element to be visible on the page.

<?php
$I->waitForElementVisible('#agree_button', 30); // secs
$I->click('#agree_button');
?>

Parameters

$element : mixed

$timeout : int = 10

seconds

Tags

throws

Exception

waitForJS()

Executes JavaScript and waits up to $timeout seconds for it to return true.

<?php
$I->waitForJS("return $.active == 0;", 60);
?>

Parameters

$script : string

$timeout : int = 5

seconds

waitForText()

Waits up to $timeout seconds for the given string to appear on the page.

<?php
$I->waitForText('foo', 30); // secs
$I->waitForText('foo', 30, '.title'); // secs
?>

Parameters

$text : string

$timeout : int = 10

seconds

$selector : string = null

optional

Tags

throws

Exception