mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2024-09-22 17:31:35 +02:00
2724 lines
88 KiB
PHP
2724 lines
88 KiB
PHP
<?php //[STAMP] fd572cb1f679911978b9f48a842ed64b
|
|
namespace _generated;
|
|
|
|
// This class was automatically generated by build task
|
|
// You should not change it manually as it will be overwritten on next build
|
|
// @codingStandardsIgnoreFile
|
|
|
|
use Codeception\Module\WebDriver;
|
|
use Codeception\Module\Db;
|
|
use Helper\Acceptance;
|
|
|
|
trait AcceptanceTesterActions
|
|
{
|
|
/**
|
|
* @return \Codeception\Scenario
|
|
*/
|
|
abstract protected function getScenario();
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Changes the subdomain for the 'url' configuration parameter.
|
|
* Does not open a page; use `amOnPage` for that.
|
|
*
|
|
* ``` php
|
|
* <?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/
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $subdomain
|
|
*
|
|
* @return mixed
|
|
* @see \Codeception\Module\WebDriver::amOnSubdomain()
|
|
*/
|
|
public function amOnSubdomain($subdomain) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Condition('amOnSubdomain', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Takes a screenshot of the current window and saves it to `tests/_output/debug`.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->amOnPage('/user/edit');
|
|
* $I->makeScreenshot('edit_page');
|
|
* // saved to: tests/_output/debug/edit_page.png
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $name
|
|
* @see \Codeception\Module\WebDriver::makeScreenshot()
|
|
*/
|
|
public function makeScreenshot($name) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('makeScreenshot', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Resize the current window.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->resizeWindow(800, 600);
|
|
*
|
|
* ```
|
|
*
|
|
* @param int $width
|
|
* @param int $height
|
|
* @see \Codeception\Module\WebDriver::resizeWindow()
|
|
*/
|
|
public function resizeWindow($width, $height) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('resizeWindow', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* 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.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->seeCookie('PHPSESSID');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $cookie
|
|
* @param array $params
|
|
* @return mixed
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::seeCookie()
|
|
*/
|
|
public function canSeeCookie($cookie, $params = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeCookie', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* 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.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->seeCookie('PHPSESSID');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $cookie
|
|
* @param array $params
|
|
* @return mixed
|
|
* @see \Codeception\Module\WebDriver::seeCookie()
|
|
*/
|
|
public function seeCookie($cookie, $params = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCookie', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* 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.
|
|
*
|
|
* @param $cookie
|
|
*
|
|
* @param array $params
|
|
* @return mixed
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::dontSeeCookie()
|
|
*/
|
|
public function cantSeeCookie($cookie, $params = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeCookie', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* 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.
|
|
*
|
|
* @param $cookie
|
|
*
|
|
* @param array $params
|
|
* @return mixed
|
|
* @see \Codeception\Module\WebDriver::dontSeeCookie()
|
|
*/
|
|
public function dontSeeCookie($cookie, $params = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeCookie', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Sets a cookie with the given name and value.
|
|
* You can set additional cookie params like `domain`, `path`, `expire`, `secure` in array passed as last argument.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->setCookie('PHPSESSID', 'el4ukv0kqbvoirg7nkp4dncpk3');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $name
|
|
* @param $val
|
|
* @param array $params
|
|
*
|
|
* @return mixed
|
|
* @see \Codeception\Module\WebDriver::setCookie()
|
|
*/
|
|
public function setCookie($cookie, $value, $params = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('setCookie', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Unsets cookie with the given name.
|
|
* You can set additional cookie params like `domain`, `path` in array passed as last argument.
|
|
*
|
|
* @param $cookie
|
|
*
|
|
* @param array $params
|
|
* @return mixed
|
|
* @see \Codeception\Module\WebDriver::resetCookie()
|
|
*/
|
|
public function resetCookie($cookie, $params = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('resetCookie', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Grabs a cookie value.
|
|
* You can set additional cookie params like `domain`, `path` in array passed as last argument.
|
|
*
|
|
* @param $cookie
|
|
*
|
|
* @param array $params
|
|
* @return mixed
|
|
* @see \Codeception\Module\WebDriver::grabCookie()
|
|
*/
|
|
public function grabCookie($cookie, $params = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('grabCookie', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Open web page at the given absolute URL and sets its hostname as the base host.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->amOnUrl('http://codeception.com');
|
|
* $I->amOnPage('/quickstart'); // moves to http://codeception.com/quickstart
|
|
* ?>
|
|
* ```
|
|
* @see \Codeception\Module\WebDriver::amOnUrl()
|
|
*/
|
|
public function amOnUrl($url) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Condition('amOnUrl', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Opens the page for the given relative URI.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* // opens front page
|
|
* $I->amOnPage('/');
|
|
* // opens /register page
|
|
* $I->amOnPage('/register');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $page
|
|
* @see \Codeception\Module\WebDriver::amOnPage()
|
|
*/
|
|
public function amOnPage($page) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Condition('amOnPage', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the current page contains the given string.
|
|
* Specify a locator as the second parameter to match a specific region.
|
|
*
|
|
* ``` php
|
|
* <?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
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $text
|
|
* @param null $selector
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::see()
|
|
*/
|
|
public function canSee($text, $selector = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('see', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the current page contains the given string.
|
|
* Specify a locator as the second parameter to match a specific region.
|
|
*
|
|
* ``` php
|
|
* <?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
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $text
|
|
* @param null $selector
|
|
* @see \Codeception\Module\WebDriver::see()
|
|
*/
|
|
public function see($text, $selector = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('see', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the current page doesn't contain the text specified.
|
|
* Give a locator as the second parameter to match a specific region.
|
|
*
|
|
* ```php
|
|
* <?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
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $text
|
|
* @param null $selector
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::dontSee()
|
|
*/
|
|
public function cantSee($text, $selector = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSee', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the current page doesn't contain the text specified.
|
|
* Give a locator as the second parameter to match a specific region.
|
|
*
|
|
* ```php
|
|
* <?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
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $text
|
|
* @param null $selector
|
|
* @see \Codeception\Module\WebDriver::dontSee()
|
|
*/
|
|
public function dontSee($text, $selector = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSee', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the page source contains the given string.
|
|
*
|
|
* ```php
|
|
* <?php
|
|
* $I->seeInPageSource('<link rel="apple-touch-icon"');
|
|
* ```
|
|
*
|
|
* @param $text
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::seeInPageSource()
|
|
*/
|
|
public function canSeeInPageSource($text) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInPageSource', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the page source contains the given string.
|
|
*
|
|
* ```php
|
|
* <?php
|
|
* $I->seeInPageSource('<link rel="apple-touch-icon"');
|
|
* ```
|
|
*
|
|
* @param $text
|
|
* @see \Codeception\Module\WebDriver::seeInPageSource()
|
|
*/
|
|
public function seeInPageSource($text) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInPageSource', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the page source doesn't contain the given string.
|
|
*
|
|
* @param $text
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::dontSeeInPageSource()
|
|
*/
|
|
public function cantSeeInPageSource($text) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInPageSource', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the page source doesn't contain the given string.
|
|
*
|
|
* @param $text
|
|
* @see \Codeception\Module\WebDriver::dontSeeInPageSource()
|
|
*/
|
|
public function dontSeeInPageSource($text) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeInPageSource', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* 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.
|
|
*
|
|
* ``` php
|
|
* <?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']);
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $link
|
|
* @param $context
|
|
* @see \Codeception\Module\WebDriver::click()
|
|
*/
|
|
public function click($link, $context = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('click', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* 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.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->seeLink('Logout'); // matches <a href="#">Logout</a>
|
|
* $I->seeLink('Logout','/logout'); // matches <a href="/logout">Logout</a>
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $text
|
|
* @param null $url
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::seeLink()
|
|
*/
|
|
public function canSeeLink($text, $url = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeLink', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* 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.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->seeLink('Logout'); // matches <a href="#">Logout</a>
|
|
* $I->seeLink('Logout','/logout'); // matches <a href="/logout">Logout</a>
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $text
|
|
* @param null $url
|
|
* @see \Codeception\Module\WebDriver::seeLink()
|
|
*/
|
|
public function seeLink($text, $url = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeLink', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* 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.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->dontSeeLink('Logout'); // I suppose user is not logged in
|
|
* $I->dontSeeLink('Checkout now', '/store/cart.php');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $text
|
|
* @param null $url
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::dontSeeLink()
|
|
*/
|
|
public function cantSeeLink($text, $url = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeLink', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* 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.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->dontSeeLink('Logout'); // I suppose user is not logged in
|
|
* $I->dontSeeLink('Checkout now', '/store/cart.php');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $text
|
|
* @param null $url
|
|
* @see \Codeception\Module\WebDriver::dontSeeLink()
|
|
*/
|
|
public function dontSeeLink($text, $url = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeLink', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that current URI contains the given string.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* // to match: /home/dashboard
|
|
* $I->seeInCurrentUrl('home');
|
|
* // to match: /users/1
|
|
* $I->seeInCurrentUrl('/users/');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $uri
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::seeInCurrentUrl()
|
|
*/
|
|
public function canSeeInCurrentUrl($uri) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInCurrentUrl', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that current URI contains the given string.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* // to match: /home/dashboard
|
|
* $I->seeInCurrentUrl('home');
|
|
* // to match: /users/1
|
|
* $I->seeInCurrentUrl('/users/');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $uri
|
|
* @see \Codeception\Module\WebDriver::seeInCurrentUrl()
|
|
*/
|
|
public function seeInCurrentUrl($uri) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInCurrentUrl', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the current URL is equal to the given string.
|
|
* Unlike `seeInCurrentUrl`, this only matches the full URL.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* // to match root url
|
|
* $I->seeCurrentUrlEquals('/');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $uri
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::seeCurrentUrlEquals()
|
|
*/
|
|
public function canSeeCurrentUrlEquals($uri) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeCurrentUrlEquals', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the current URL is equal to the given string.
|
|
* Unlike `seeInCurrentUrl`, this only matches the full URL.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* // to match root url
|
|
* $I->seeCurrentUrlEquals('/');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $uri
|
|
* @see \Codeception\Module\WebDriver::seeCurrentUrlEquals()
|
|
*/
|
|
public function seeCurrentUrlEquals($uri) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCurrentUrlEquals', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the current URL matches the given regular expression.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* // to match root url
|
|
* $I->seeCurrentUrlMatches('~$/users/(\d+)~');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $uri
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::seeCurrentUrlMatches()
|
|
*/
|
|
public function canSeeCurrentUrlMatches($uri) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeCurrentUrlMatches', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the current URL matches the given regular expression.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* // to match root url
|
|
* $I->seeCurrentUrlMatches('~$/users/(\d+)~');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $uri
|
|
* @see \Codeception\Module\WebDriver::seeCurrentUrlMatches()
|
|
*/
|
|
public function seeCurrentUrlMatches($uri) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCurrentUrlMatches', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the current URI doesn't contain the given string.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->dontSeeInCurrentUrl('/users/');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $uri
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::dontSeeInCurrentUrl()
|
|
*/
|
|
public function cantSeeInCurrentUrl($uri) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInCurrentUrl', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the current URI doesn't contain the given string.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->dontSeeInCurrentUrl('/users/');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $uri
|
|
* @see \Codeception\Module\WebDriver::dontSeeInCurrentUrl()
|
|
*/
|
|
public function dontSeeInCurrentUrl($uri) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeInCurrentUrl', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the current URL doesn't equal the given string.
|
|
* Unlike `dontSeeInCurrentUrl`, this only matches the full URL.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* // current url is not root
|
|
* $I->dontSeeCurrentUrlEquals('/');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $uri
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::dontSeeCurrentUrlEquals()
|
|
*/
|
|
public function cantSeeCurrentUrlEquals($uri) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeCurrentUrlEquals', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the current URL doesn't equal the given string.
|
|
* Unlike `dontSeeInCurrentUrl`, this only matches the full URL.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* // current url is not root
|
|
* $I->dontSeeCurrentUrlEquals('/');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $uri
|
|
* @see \Codeception\Module\WebDriver::dontSeeCurrentUrlEquals()
|
|
*/
|
|
public function dontSeeCurrentUrlEquals($uri) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeCurrentUrlEquals', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that current url doesn't match the given regular expression.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* // to match root url
|
|
* $I->dontSeeCurrentUrlMatches('~$/users/(\d+)~');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $uri
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::dontSeeCurrentUrlMatches()
|
|
*/
|
|
public function cantSeeCurrentUrlMatches($uri) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeCurrentUrlMatches', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that current url doesn't match the given regular expression.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* // to match root url
|
|
* $I->dontSeeCurrentUrlMatches('~$/users/(\d+)~');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $uri
|
|
* @see \Codeception\Module\WebDriver::dontSeeCurrentUrlMatches()
|
|
*/
|
|
public function dontSeeCurrentUrlMatches($uri) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeCurrentUrlMatches', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Executes the given regular expression against the current URI and returns the first match.
|
|
* If no parameters are provided, the full URI is returned.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $user_id = $I->grabFromCurrentUrl('~$/user/(\d+)/~');
|
|
* $uri = $I->grabFromCurrentUrl();
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param null $uri
|
|
*
|
|
* @internal param $url
|
|
* @return mixed
|
|
* @see \Codeception\Module\WebDriver::grabFromCurrentUrl()
|
|
*/
|
|
public function grabFromCurrentUrl($uri = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('grabFromCurrentUrl', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the specified checkbox is checked.
|
|
*
|
|
* ``` php
|
|
* <?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]');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $checkbox
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::seeCheckboxIsChecked()
|
|
*/
|
|
public function canSeeCheckboxIsChecked($checkbox) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeCheckboxIsChecked', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the specified checkbox is checked.
|
|
*
|
|
* ``` php
|
|
* <?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]');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $checkbox
|
|
* @see \Codeception\Module\WebDriver::seeCheckboxIsChecked()
|
|
*/
|
|
public function seeCheckboxIsChecked($checkbox) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCheckboxIsChecked', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Check that the specified checkbox is unchecked.
|
|
*
|
|
* ``` php
|
|
* <?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.
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $checkbox
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::dontSeeCheckboxIsChecked()
|
|
*/
|
|
public function cantSeeCheckboxIsChecked($checkbox) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeCheckboxIsChecked', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Check that the specified checkbox is unchecked.
|
|
*
|
|
* ``` php
|
|
* <?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.
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $checkbox
|
|
* @see \Codeception\Module\WebDriver::dontSeeCheckboxIsChecked()
|
|
*/
|
|
public function dontSeeCheckboxIsChecked($checkbox) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeCheckboxIsChecked', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the given input field or textarea contains the given value.
|
|
* For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
|
|
*
|
|
* ``` php
|
|
* <?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');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $field
|
|
* @param $value
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::seeInField()
|
|
*/
|
|
public function canSeeInField($field, $value) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInField', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the given input field or textarea contains the given value.
|
|
* For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
|
|
*
|
|
* ``` php
|
|
* <?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');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $field
|
|
* @param $value
|
|
* @see \Codeception\Module\WebDriver::seeInField()
|
|
*/
|
|
public function seeInField($field, $value) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInField', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* 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.
|
|
*
|
|
* ``` php
|
|
* <?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');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $field
|
|
* @param $value
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::dontSeeInField()
|
|
*/
|
|
public function cantSeeInField($field, $value) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInField', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* 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.
|
|
*
|
|
* ``` php
|
|
* <?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');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $field
|
|
* @param $value
|
|
* @see \Codeception\Module\WebDriver::dontSeeInField()
|
|
*/
|
|
public function dontSeeInField($field, $value) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeInField', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks if the array of form parameters (name => value) are set on the form matched with the
|
|
* passed selector.
|
|
*
|
|
* ``` php
|
|
* <?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
|
|
* <?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
|
|
* <?php
|
|
* $I->seeInFormFields('#form-id', [
|
|
* 'checkbox1' => true, // passes if checked
|
|
* 'checkbox2' => false, // passes if unchecked
|
|
* ]);
|
|
* ?>
|
|
* ```
|
|
*
|
|
* Pair this with submitForm for quick testing magic.
|
|
*
|
|
* ``` php
|
|
* <?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);
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $formSelector
|
|
* @param $params
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::seeInFormFields()
|
|
*/
|
|
public function canSeeInFormFields($formSelector, $params) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInFormFields', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks if the array of form parameters (name => value) are set on the form matched with the
|
|
* passed selector.
|
|
*
|
|
* ``` php
|
|
* <?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
|
|
* <?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
|
|
* <?php
|
|
* $I->seeInFormFields('#form-id', [
|
|
* 'checkbox1' => true, // passes if checked
|
|
* 'checkbox2' => false, // passes if unchecked
|
|
* ]);
|
|
* ?>
|
|
* ```
|
|
*
|
|
* Pair this with submitForm for quick testing magic.
|
|
*
|
|
* ``` php
|
|
* <?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);
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $formSelector
|
|
* @param $params
|
|
* @see \Codeception\Module\WebDriver::seeInFormFields()
|
|
*/
|
|
public function seeInFormFields($formSelector, $params) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInFormFields', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks if the array of form parameters (name => value) are not set on the form matched with
|
|
* the passed selector.
|
|
*
|
|
* ``` php
|
|
* <?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
|
|
* <?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
|
|
* <?php
|
|
* $I->dontSeeInFormFields('#form-id', [
|
|
* 'checkbox1' => true, // fails if checked
|
|
* 'checkbox2' => false, // fails if unchecked
|
|
* ]);
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $formSelector
|
|
* @param $params
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::dontSeeInFormFields()
|
|
*/
|
|
public function cantSeeInFormFields($formSelector, $params) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInFormFields', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks if the array of form parameters (name => value) are not set on the form matched with
|
|
* the passed selector.
|
|
*
|
|
* ``` php
|
|
* <?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
|
|
* <?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
|
|
* <?php
|
|
* $I->dontSeeInFormFields('#form-id', [
|
|
* 'checkbox1' => true, // fails if checked
|
|
* 'checkbox2' => false, // fails if unchecked
|
|
* ]);
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $formSelector
|
|
* @param $params
|
|
* @see \Codeception\Module\WebDriver::dontSeeInFormFields()
|
|
*/
|
|
public function dontSeeInFormFields($formSelector, $params) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeInFormFields', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Selects an option in a select tag or in radio button group.
|
|
*
|
|
* ``` php
|
|
* <?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
|
|
* <?php
|
|
* $I->selectOption('Which OS do you use?', array('Windows','Linux'));
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $select
|
|
* @param $option
|
|
* @see \Codeception\Module\WebDriver::selectOption()
|
|
*/
|
|
public function selectOption($select, $option) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('selectOption', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
*
|
|
* @see \Codeception\Module\WebDriver::unselectOption()
|
|
*/
|
|
public function unselectOption($select, $option) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('unselectOption', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Ticks a checkbox. For radio buttons, use the `selectOption` method instead.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->checkOption('#agree');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $option
|
|
* @see \Codeception\Module\WebDriver::checkOption()
|
|
*/
|
|
public function checkOption($option) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('checkOption', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Unticks a checkbox.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->uncheckOption('#notify');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $option
|
|
* @see \Codeception\Module\WebDriver::uncheckOption()
|
|
*/
|
|
public function uncheckOption($option) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('uncheckOption', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Fills a text field or textarea with the given string.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->fillField("//input[@type='text']", "Hello World!");
|
|
* $I->fillField(['name' => 'email'], 'jon@mail.com');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $field
|
|
* @param $value
|
|
* @see \Codeception\Module\WebDriver::fillField()
|
|
*/
|
|
public function fillField($field, $value) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('fillField', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Attaches a file relative to the Codeception data directory to the given file upload field.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* // file is stored in 'tests/_data/prices.xls'
|
|
* $I->attachFile('input[@type="file"]', 'prices.xls');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $field
|
|
* @param $filename
|
|
* @see \Codeception\Module\WebDriver::attachFile()
|
|
*/
|
|
public function attachFile($field, $filename) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('attachFile', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Grabs all visible text from the current page.
|
|
*
|
|
* @return string
|
|
* @see \Codeception\Module\WebDriver::getVisibleText()
|
|
*/
|
|
public function getVisibleText() {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('getVisibleText', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* 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.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $heading = $I->grabTextFrom('h1');
|
|
* $heading = $I->grabTextFrom('descendant-or-self::h1');
|
|
* $value = $I->grabTextFrom('~<input value=(.*?)]~sgi'); // match with a regex
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $cssOrXPathOrRegex
|
|
*
|
|
* @return mixed
|
|
* @see \Codeception\Module\WebDriver::grabTextFrom()
|
|
*/
|
|
public function grabTextFrom($cssOrXPathOrRegex) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('grabTextFrom', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Grabs the value of the given attribute value from the given element.
|
|
* Fails if element is not found.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->grabAttributeFrom('#tooltip', 'title');
|
|
* ?>
|
|
* ```
|
|
*
|
|
*
|
|
* @param $cssOrXpath
|
|
* @param $attribute
|
|
* @internal param $element
|
|
* @return mixed
|
|
* @see \Codeception\Module\WebDriver::grabAttributeFrom()
|
|
*/
|
|
public function grabAttributeFrom($cssOrXpath, $attribute) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('grabAttributeFrom', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Finds the value for the given form field.
|
|
* If a fuzzy locator is used, the field is found by field name, CSS, and XPath.
|
|
*
|
|
* ``` php
|
|
* <?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']);
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $field
|
|
*
|
|
* @return mixed
|
|
* @see \Codeception\Module\WebDriver::grabValueFrom()
|
|
*/
|
|
public function grabValueFrom($field) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('grabValueFrom', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
*
|
|
* @see \Codeception\Module\WebDriver::grabMultiple()
|
|
*/
|
|
public function grabMultiple($cssOrXpath, $attribute = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('grabMultiple', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the given element exists on the page and is visible.
|
|
* You can also specify expected attributes of this element.
|
|
*
|
|
* ``` php
|
|
* <?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']);
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $selector
|
|
* @param array $attributes
|
|
* @return
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::seeElement()
|
|
*/
|
|
public function canSeeElement($selector, $attributes = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeElement', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the given element exists on the page and is visible.
|
|
* You can also specify expected attributes of this element.
|
|
*
|
|
* ``` php
|
|
* <?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']);
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $selector
|
|
* @param array $attributes
|
|
* @return
|
|
* @see \Codeception\Module\WebDriver::seeElement()
|
|
*/
|
|
public function seeElement($selector, $attributes = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeElement', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the given element is invisible or not present on the page.
|
|
* You can also specify expected attributes of this element.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->dontSeeElement('.error');
|
|
* $I->dontSeeElement('//form/input[1]');
|
|
* $I->dontSeeElement('input', ['name' => 'login']);
|
|
* $I->dontSeeElement('input', ['value' => '123456']);
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $selector
|
|
* @param array $attributes
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::dontSeeElement()
|
|
*/
|
|
public function cantSeeElement($selector, $attributes = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeElement', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the given element is invisible or not present on the page.
|
|
* You can also specify expected attributes of this element.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->dontSeeElement('.error');
|
|
* $I->dontSeeElement('//form/input[1]');
|
|
* $I->dontSeeElement('input', ['name' => 'login']);
|
|
* $I->dontSeeElement('input', ['value' => '123456']);
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $selector
|
|
* @param array $attributes
|
|
* @see \Codeception\Module\WebDriver::dontSeeElement()
|
|
*/
|
|
public function dontSeeElement($selector, $attributes = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeElement', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the given element exists on the page, even it is invisible.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->seeElementInDOM('//form/input[type=hidden]');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $selector
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::seeElementInDOM()
|
|
*/
|
|
public function canSeeElementInDOM($selector, $attributes = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeElementInDOM', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the given element exists on the page, even it is invisible.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->seeElementInDOM('//form/input[type=hidden]');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $selector
|
|
* @see \Codeception\Module\WebDriver::seeElementInDOM()
|
|
*/
|
|
public function seeElementInDOM($selector, $attributes = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeElementInDOM', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Opposite of `seeElementInDOM`.
|
|
*
|
|
* @param $selector
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::dontSeeElementInDOM()
|
|
*/
|
|
public function cantSeeElementInDOM($selector, $attributes = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeElementInDOM', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Opposite of `seeElementInDOM`.
|
|
*
|
|
* @param $selector
|
|
* @see \Codeception\Module\WebDriver::dontSeeElementInDOM()
|
|
*/
|
|
public function dontSeeElementInDOM($selector, $attributes = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeElementInDOM', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that there are a certain number of elements matched by the given locator on the page.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->seeNumberOfElements('tr', 10);
|
|
* $I->seeNumberOfElements('tr', [0,10]); //between 0 and 10 elements
|
|
* ?>
|
|
* ```
|
|
* @param $selector
|
|
* @param mixed $expected :
|
|
* - string: strict number
|
|
* - array: range of numbers [0,10]
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::seeNumberOfElements()
|
|
*/
|
|
public function canSeeNumberOfElements($selector, $expected) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeNumberOfElements', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that there are a certain number of elements matched by the given locator on the page.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->seeNumberOfElements('tr', 10);
|
|
* $I->seeNumberOfElements('tr', [0,10]); //between 0 and 10 elements
|
|
* ?>
|
|
* ```
|
|
* @param $selector
|
|
* @param mixed $expected :
|
|
* - string: strict number
|
|
* - array: range of numbers [0,10]
|
|
* @see \Codeception\Module\WebDriver::seeNumberOfElements()
|
|
*/
|
|
public function seeNumberOfElements($selector, $expected) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeNumberOfElements', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the given option is selected.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->seeOptionIsSelected('#form input[name=payment]', 'Visa');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $selector
|
|
* @param $optionText
|
|
*
|
|
* @return mixed
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::seeOptionIsSelected()
|
|
*/
|
|
public function canSeeOptionIsSelected($selector, $optionText) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeOptionIsSelected', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the given option is selected.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->seeOptionIsSelected('#form input[name=payment]', 'Visa');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $selector
|
|
* @param $optionText
|
|
*
|
|
* @return mixed
|
|
* @see \Codeception\Module\WebDriver::seeOptionIsSelected()
|
|
*/
|
|
public function seeOptionIsSelected($selector, $optionText) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeOptionIsSelected', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the given option is not selected.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->dontSeeOptionIsSelected('#form input[name=payment]', 'Visa');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $selector
|
|
* @param $optionText
|
|
*
|
|
* @return mixed
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::dontSeeOptionIsSelected()
|
|
*/
|
|
public function cantSeeOptionIsSelected($selector, $optionText) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeOptionIsSelected', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the given option is not selected.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->dontSeeOptionIsSelected('#form input[name=payment]', 'Visa');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $selector
|
|
* @param $optionText
|
|
*
|
|
* @return mixed
|
|
* @see \Codeception\Module\WebDriver::dontSeeOptionIsSelected()
|
|
*/
|
|
public function dontSeeOptionIsSelected($selector, $optionText) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeOptionIsSelected', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the page title contains the given string.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->seeInTitle('Blog - Post #1');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $title
|
|
*
|
|
* @return mixed
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::seeInTitle()
|
|
*/
|
|
public function canSeeInTitle($title) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInTitle', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the page title contains the given string.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->seeInTitle('Blog - Post #1');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $title
|
|
*
|
|
* @return mixed
|
|
* @see \Codeception\Module\WebDriver::seeInTitle()
|
|
*/
|
|
public function seeInTitle($title) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInTitle', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the page title does not contain the given string.
|
|
*
|
|
* @param $title
|
|
*
|
|
* @return mixed
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::dontSeeInTitle()
|
|
*/
|
|
public function cantSeeInTitle($title) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInTitle', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the page title does not contain the given string.
|
|
*
|
|
* @param $title
|
|
*
|
|
* @return mixed
|
|
* @see \Codeception\Module\WebDriver::dontSeeInTitle()
|
|
*/
|
|
public function dontSeeInTitle($title) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeInTitle', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Accepts the active JavaScript native popup window, as created by `window.alert`|`window.confirm`|`window.prompt`.
|
|
* Don't confuse popups with modal windows, as created by [various libraries](http://jster.net/category/windows-modals-popups).
|
|
* @see \Codeception\Module\WebDriver::acceptPopup()
|
|
*/
|
|
public function acceptPopup() {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('acceptPopup', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Dismisses the active JavaScript popup, as created by `window.alert`|`window.confirm`|`window.prompt`.
|
|
* @see \Codeception\Module\WebDriver::cancelPopup()
|
|
*/
|
|
public function cancelPopup() {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('cancelPopup', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the active JavaScript popup, as created by `window.alert`|`window.confirm`|`window.prompt`, contains the given string.
|
|
*
|
|
* @param $text
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\WebDriver::seeInPopup()
|
|
*/
|
|
public function canSeeInPopup($text) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInPopup', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks that the active JavaScript popup, as created by `window.alert`|`window.confirm`|`window.prompt`, contains the given string.
|
|
*
|
|
* @param $text
|
|
* @see \Codeception\Module\WebDriver::seeInPopup()
|
|
*/
|
|
public function seeInPopup($text) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInPopup', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Enters text into a native JavaScript prompt popup, as created by `window.prompt`.
|
|
*
|
|
* @param $keys
|
|
* @see \Codeception\Module\WebDriver::typeInPopup()
|
|
*/
|
|
public function typeInPopup($keys) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('typeInPopup', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Reloads the current page.
|
|
* @see \Codeception\Module\WebDriver::reloadPage()
|
|
*/
|
|
public function reloadPage() {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('reloadPage', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Moves back in history.
|
|
* @see \Codeception\Module\WebDriver::moveBack()
|
|
*/
|
|
public function moveBack() {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('moveBack', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Moves forward in history.
|
|
* @see \Codeception\Module\WebDriver::moveForward()
|
|
*/
|
|
public function moveForward() {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('moveForward', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* 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.
|
|
*
|
|
* Skipped fields will be filled by their values from the page.
|
|
* You don't need to click the 'Submit' button afterwards.
|
|
* This command itself triggers the request to form's action.
|
|
*
|
|
* You can optionally specify what 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
|
|
* <?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:
|
|
*
|
|
* ``` html
|
|
* <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>
|
|
* ```
|
|
*
|
|
* You could write the following to submit it:
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->submitForm(
|
|
* '#userForm',
|
|
* [
|
|
* 'user[login]' => 'Davert',
|
|
* 'user[password]' => '123456',
|
|
* 'user[agree]' => true
|
|
* ],
|
|
* 'submitButton'
|
|
* );
|
|
* ```
|
|
* Note that "2" will be the submitted value for the "plan" field, as it is
|
|
* the selected option.
|
|
*
|
|
* Also note that this differs from PhpBrowser, in that
|
|
* ```'user' => [ 'login' => 'Davert' ]``` is not supported at the moment.
|
|
* Named array keys *must* be included in the name as above.
|
|
*
|
|
* Pair this with seeInFormFields for quick testing magic.
|
|
*
|
|
* ``` php
|
|
* <?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);
|
|
* ?>
|
|
* ```
|
|
*
|
|
* Parameter values must be set to arrays for multiple input fields
|
|
* of the same name, or multi-select combo boxes. For checkboxes,
|
|
* either the string value can be used, or boolean values which will
|
|
* be replaced by the checkbox's value in the DOM.
|
|
*
|
|
* ``` php
|
|
* <?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
|
|
* $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',
|
|
* ]
|
|
* ]);
|
|
* ```
|
|
* @param $selector
|
|
* @param $params
|
|
* @param $button
|
|
* @see \Codeception\Module\WebDriver::submitForm()
|
|
*/
|
|
public function submitForm($selector, $params, $button = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('submitForm', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Waits up to $timeout seconds for the given element to change.
|
|
* Element "change" is determined by a callback function which is called repeatedly until the return value evaluates to true.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* use \Facebook\WebDriver\WebDriverElement
|
|
* $I->waitForElementChange('#menu', function(WebDriverElement $el) {
|
|
* return $el->isDisplayed();
|
|
* }, 100);
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $element
|
|
* @param \Closure $callback
|
|
* @param int $timeout seconds
|
|
* @throws \Codeception\Exception\ElementNotFound
|
|
* @see \Codeception\Module\WebDriver::waitForElementChange()
|
|
*/
|
|
public function waitForElementChange($element, $callback, $timeout = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('waitForElementChange', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Waits up to $timeout seconds for an element to appear on the page.
|
|
* If the element doesn't appear, a timeout exception is thrown.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->waitForElement('#agree_button', 30); // secs
|
|
* $I->click('#agree_button');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $element
|
|
* @param int $timeout seconds
|
|
* @throws \Exception
|
|
* @see \Codeception\Module\WebDriver::waitForElement()
|
|
*/
|
|
public function waitForElement($element, $timeout = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('waitForElement', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Waits up to $timeout seconds for the given element to be visible on the page.
|
|
* If element doesn't appear, a timeout exception is thrown.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->waitForElementVisible('#agree_button', 30); // secs
|
|
* $I->click('#agree_button');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $element
|
|
* @param int $timeout seconds
|
|
* @throws \Exception
|
|
* @see \Codeception\Module\WebDriver::waitForElementVisible()
|
|
*/
|
|
public function waitForElementVisible($element, $timeout = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('waitForElementVisible', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Waits up to $timeout seconds for the given element to become invisible.
|
|
* If element stays visible, a timeout exception is thrown.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->waitForElementNotVisible('#agree_button', 30); // secs
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $element
|
|
* @param int $timeout seconds
|
|
* @throws \Exception
|
|
* @see \Codeception\Module\WebDriver::waitForElementNotVisible()
|
|
*/
|
|
public function waitForElementNotVisible($element, $timeout = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('waitForElementNotVisible', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Waits up to $timeout seconds for the given string to appear on the page.
|
|
* Can also be passed a selector to search in.
|
|
* If the given text doesn't appear, a timeout exception is thrown.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->waitForText('foo', 30); // secs
|
|
* $I->waitForText('foo', 30, '.title'); // secs
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param string $text
|
|
* @param int $timeout seconds
|
|
* @param null $selector
|
|
* @throws \Exception
|
|
* @see \Codeception\Module\WebDriver::waitForText()
|
|
*/
|
|
public function waitForText($text, $timeout = null, $selector = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('waitForText', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Wait for $timeout seconds.
|
|
*
|
|
* @param int $timeout secs
|
|
* @throws \Codeception\Exception\TestRuntimeException
|
|
* @see \Codeception\Module\WebDriver::wait()
|
|
*/
|
|
public function wait($timeout) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('wait', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Low-level API method.
|
|
* If Codeception commands are not enough, this allows you to use Selenium WebDriver methods directly:
|
|
*
|
|
* ``` php
|
|
* $I->executeInSelenium(function(\Facebook\WebDriver\RemoteWebDriver $webdriver) {
|
|
* $webdriver->get('http://google.com');
|
|
* });
|
|
* ```
|
|
*
|
|
* This runs in the context of the [RemoteWebDriver class](https://github.com/facebook/php-webdriver/blob/master/lib/remote/RemoteWebDriver.php).
|
|
* Try not to use this command on a regular basis.
|
|
* If Codeception lacks a feature you need, please implement it and submit a patch.
|
|
*
|
|
* @param callable $function
|
|
* @see \Codeception\Module\WebDriver::executeInSelenium()
|
|
*/
|
|
public function executeInSelenium($function) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('executeInSelenium', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Switch to another window identified by name.
|
|
*
|
|
* The window can only be identified by name. If the $name parameter is blank, the parent window will be used.
|
|
*
|
|
* Example:
|
|
* ``` html
|
|
* <input type="button" value="Open window" onclick="window.open('http://example.com', 'another_window')">
|
|
* ```
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->click("Open window");
|
|
* # switch to another window
|
|
* $I->switchToWindow("another_window");
|
|
* # switch to parent window
|
|
* $I->switchToWindow();
|
|
* ?>
|
|
* ```
|
|
*
|
|
* If the window has no name, the only way to access it is via the `executeInSelenium()` method, like so:
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->executeInSelenium(function (\Facebook\WebDriver\RemoteWebDriver $webdriver) {
|
|
* $handles=$webdriver->getWindowHandles();
|
|
* $last_window = end($handles);
|
|
* $webdriver->switchTo()->window($last_window);
|
|
* });
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param string|null $name
|
|
* @see \Codeception\Module\WebDriver::switchToWindow()
|
|
*/
|
|
public function switchToWindow($name = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('switchToWindow', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Switch to another frame on the page.
|
|
*
|
|
* Example:
|
|
* ``` html
|
|
* <iframe name="another_frame" src="http://example.com">
|
|
*
|
|
* ```
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* # switch to iframe
|
|
* $I->switchToIFrame("another_frame");
|
|
* # switch to parent page
|
|
* $I->switchToIFrame();
|
|
*
|
|
* ```
|
|
*
|
|
* @param string|null $name
|
|
* @see \Codeception\Module\WebDriver::switchToIFrame()
|
|
*/
|
|
public function switchToIFrame($name = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('switchToIFrame', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Executes JavaScript and waits up to $timeout seconds for it to return true.
|
|
*
|
|
* In this example we will wait up to 60 seconds for all jQuery AJAX requests to finish.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->waitForJS("return $.active == 0;", 60);
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param string $script
|
|
* @param int $timeout seconds
|
|
* @see \Codeception\Module\WebDriver::waitForJS()
|
|
*/
|
|
public function waitForJS($script, $timeout = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('waitForJS', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Executes custom JavaScript.
|
|
*
|
|
* This example uses jQuery to get a value and assigns that value to a PHP variable:
|
|
*
|
|
* ```php
|
|
* <?php
|
|
* $myVar = $I->executeJS('return $("#myField").val()');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $script
|
|
* @return mixed
|
|
* @see \Codeception\Module\WebDriver::executeJS()
|
|
*/
|
|
public function executeJS($script) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('executeJS', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Maximizes the current window.
|
|
* @see \Codeception\Module\WebDriver::maximizeWindow()
|
|
*/
|
|
public function maximizeWindow() {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('maximizeWindow', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Performs a simple mouse drag-and-drop operation.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->dragAndDrop('#drag', '#drop');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param string $source (CSS ID or XPath)
|
|
* @param string $target (CSS ID or XPath)
|
|
* @see \Codeception\Module\WebDriver::dragAndDrop()
|
|
*/
|
|
public function dragAndDrop($source, $target) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('dragAndDrop', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Move mouse over the first element matched by the given locator.
|
|
* If the second and third parameters are given, then the mouse is moved to an offset of the element's top-left corner.
|
|
* Otherwise, the mouse is moved to the center of the element.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->moveMouseOver(['css' => '.checkout'], 20, 50);
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param string $cssOrXPath css or xpath of the web element
|
|
* @param int $offsetX
|
|
* @param int $offsetY
|
|
*
|
|
* @throws \Codeception\Exception\ElementNotFound
|
|
* @see \Codeception\Module\WebDriver::moveMouseOver()
|
|
*/
|
|
public function moveMouseOver($cssOrXPath, $offsetX = null, $offsetY = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('moveMouseOver', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Performs contextual click with the right mouse button on an element.
|
|
*
|
|
* @param $cssOrXPath
|
|
* @throws \Codeception\Exception\ElementNotFound
|
|
* @see \Codeception\Module\WebDriver::clickWithRightButton()
|
|
*/
|
|
public function clickWithRightButton($cssOrXPath) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('clickWithRightButton', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Pauses test execution in debug mode.
|
|
* To proceed test press "ENTER" in console.
|
|
*
|
|
* This method is useful while writing tests, since it allows you to inspect the current page in the middle of a test case.
|
|
* @see \Codeception\Module\WebDriver::pauseExecution()
|
|
*/
|
|
public function pauseExecution() {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('pauseExecution', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Performs a double-click on an element matched by CSS or XPath.
|
|
*
|
|
* @param $cssOrXPath
|
|
* @throws \Codeception\Exception\ElementNotFound
|
|
* @see \Codeception\Module\WebDriver::doubleClick()
|
|
*/
|
|
public function doubleClick($cssOrXPath) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('doubleClick', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Presses the given key on the given element.
|
|
* To specify a character and modifier (e.g. ctrl, alt, shift, meta), pass an array for $char with
|
|
* the modifier as the first element and the character as the second.
|
|
* For special keys use key constants from WebDriverKeys class.
|
|
*
|
|
* ``` php
|
|
* <?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); //=>''
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $element
|
|
* @param $char Can be char or array with modifier. You can provide several chars.
|
|
* @throws \Codeception\Exception\ElementNotFound
|
|
* @see \Codeception\Module\WebDriver::pressKey()
|
|
*/
|
|
public function pressKey($element, $char) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('pressKey', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Append the given text to the given element.
|
|
* Can also add a selection to a select box.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->appendField('#mySelectbox', 'SelectValue');
|
|
* $I->appendField('#myTextField', 'appended');
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param string $field
|
|
* @param string $value
|
|
* @throws \Codeception\Exception\ElementNotFound
|
|
* @see \Codeception\Module\WebDriver::appendField()
|
|
*/
|
|
public function appendField($field, $value) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('appendField', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Saves current cookies into named snapshot in order to restore them in other tests
|
|
* This is useful to save session state between tests.
|
|
* For example, if user needs log in to site for each test this scenario can be executed once
|
|
* while other tests can just restore saved cookies.
|
|
*
|
|
* ``` php
|
|
* <?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');
|
|
* }
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $name
|
|
* @return mixed
|
|
* @see \Codeception\Module\WebDriver::saveSessionSnapshot()
|
|
*/
|
|
public function saveSessionSnapshot($name) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('saveSessionSnapshot', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Loads cookies from saved snapshot.
|
|
*
|
|
* @param $name
|
|
* @see saveSessionSnapshot
|
|
* @return mixed
|
|
* @see \Codeception\Module\WebDriver::loadSessionSnapshot()
|
|
*/
|
|
public function loadSessionSnapshot($name) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('loadSessionSnapshot', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Inserts SQL record into database. This record will be erased after the test.
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->haveInDatabase('users', array('name' => 'miles', 'email' => 'miles@davis.com'));
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param $table
|
|
* @param array $data
|
|
*
|
|
* @return integer $id
|
|
* @see \Codeception\Module\Db::haveInDatabase()
|
|
*/
|
|
public function haveInDatabase($table, $data) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('haveInDatabase', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks if a row with given column values exists.
|
|
* Provide table name and column values.
|
|
*
|
|
* Example:
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->seeInDatabase('users', array('name' => 'Davert', 'email' => 'davert@mail.com'));
|
|
*
|
|
* ```
|
|
* Will generate:
|
|
*
|
|
* ``` sql
|
|
* SELECT COUNT(*) FROM `users` WHERE `name` = 'Davert' AND `email` = 'davert@mail.com'
|
|
* ```
|
|
* Fails if no such user found.
|
|
*
|
|
* @param $table
|
|
* @param array $criteria
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\Db::seeInDatabase()
|
|
*/
|
|
public function canSeeInDatabase($table, $criteria = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInDatabase', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Checks if a row with given column values exists.
|
|
* Provide table name and column values.
|
|
*
|
|
* Example:
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->seeInDatabase('users', array('name' => 'Davert', 'email' => 'davert@mail.com'));
|
|
*
|
|
* ```
|
|
* Will generate:
|
|
*
|
|
* ``` sql
|
|
* SELECT COUNT(*) FROM `users` WHERE `name` = 'Davert' AND `email` = 'davert@mail.com'
|
|
* ```
|
|
* Fails if no such user found.
|
|
*
|
|
* @param $table
|
|
* @param array $criteria
|
|
* @see \Codeception\Module\Db::seeInDatabase()
|
|
*/
|
|
public function seeInDatabase($table, $criteria = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInDatabase', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Asserts that found number of records in database
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->seeNumRecords(1, 'users', ['name' => 'davert'])
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param int $num Expected number
|
|
* @param string $table Table name
|
|
* @param array $criteria Search criteria [Optional]
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\Db::seeNumRecords()
|
|
*/
|
|
public function canSeeNumRecords($num, $table, $criteria = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeNumRecords', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Asserts that found number of records in database
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->seeNumRecords(1, 'users', ['name' => 'davert'])
|
|
* ?>
|
|
* ```
|
|
*
|
|
* @param int $num Expected number
|
|
* @param string $table Table name
|
|
* @param array $criteria Search criteria [Optional]
|
|
* @see \Codeception\Module\Db::seeNumRecords()
|
|
*/
|
|
public function seeNumRecords($num, $table, $criteria = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeNumRecords', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Effect is opposite to ->seeInDatabase
|
|
*
|
|
* Checks if there is no record with such column values in database.
|
|
* Provide table name and column values.
|
|
*
|
|
* Example:
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->dontSeeInDatabase('users', array('name' => 'Davert', 'email' => 'davert@mail.com'));
|
|
*
|
|
* ```
|
|
* Will generate:
|
|
*
|
|
* ``` sql
|
|
* SELECT COUNT(*) FROM `users` WHERE `name` = 'Davert' AND `email` = 'davert@mail.com'
|
|
* ```
|
|
* Fails if such user was found.
|
|
*
|
|
* @param $table
|
|
* @param array $criteria
|
|
* Conditional Assertion: Test won't be stopped on fail
|
|
* @see \Codeception\Module\Db::dontSeeInDatabase()
|
|
*/
|
|
public function cantSeeInDatabase($table, $criteria = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInDatabase', func_get_args()));
|
|
}
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Effect is opposite to ->seeInDatabase
|
|
*
|
|
* Checks if there is no record with such column values in database.
|
|
* Provide table name and column values.
|
|
*
|
|
* Example:
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $I->dontSeeInDatabase('users', array('name' => 'Davert', 'email' => 'davert@mail.com'));
|
|
*
|
|
* ```
|
|
* Will generate:
|
|
*
|
|
* ``` sql
|
|
* SELECT COUNT(*) FROM `users` WHERE `name` = 'Davert' AND `email` = 'davert@mail.com'
|
|
* ```
|
|
* Fails if such user was found.
|
|
*
|
|
* @param $table
|
|
* @param array $criteria
|
|
* @see \Codeception\Module\Db::dontSeeInDatabase()
|
|
*/
|
|
public function dontSeeInDatabase($table, $criteria = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeInDatabase', func_get_args()));
|
|
}
|
|
|
|
|
|
/**
|
|
* [!] Method is generated. Documentation taken from corresponding module.
|
|
*
|
|
* Fetches a single column value from a database.
|
|
* Provide table name, desired column and criteria.
|
|
*
|
|
* Example:
|
|
*
|
|
* ``` php
|
|
* <?php
|
|
* $mail = $I->grabFromDatabase('users', 'email', array('name' => 'Davert'));
|
|
*
|
|
* ```
|
|
*
|
|
* @version 1.1
|
|
*
|
|
* @param $table
|
|
* @param $column
|
|
* @param array $criteria
|
|
*
|
|
* @return mixed
|
|
* @see \Codeception\Module\Db::grabFromDatabase()
|
|
*/
|
|
public function grabFromDatabase($table, $column, $criteria = null) {
|
|
return $this->getScenario()->runStep(new \Codeception\Step\Action('grabFromDatabase', func_get_args()));
|
|
}
|
|
}
|