Home`
- * - ``
- *
- * For checking the raw source code, use `seeInSource()`.
*
* @param $text
* @param null $selector
@@ -383,29 +330,16 @@ trait AcceptanceTesterActions
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
- * Checks that the current page doesn't contain the text specified (case insensitive).
+ * Checks that the current page doesn't contain the text specified.
* Give a locator as the second parameter to match a specific region.
*
* ```php
* dontSee('Login'); // I can suppose user is already logged in
- * $I->dontSee('Sign Up','h1'); // I can suppose it's not a signup page
- * $I->dontSee('Sign Up','//body/h1'); // with XPath
+ * $I->dontSee('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
+ * ?>
* ```
- *
- * Note that the search is done after stripping all HTML tags from the body,
- * so `$I->dontSee('strong')` will fail on strings like:
- *
- * - `
`
- * - ``
- *
- * But will ignore strings like:
- *
- * - `
Home`
- * - ``
- *
- * For checking the raw source code, use `seeInSource()`.
*
* @param $text
* @param null $selector
@@ -416,80 +350,6 @@ trait AcceptanceTesterActions
}
- /**
- * [!] Method is generated. Documentation taken from corresponding module.
- *
- * Checks that the current page contains the given string in its
- * raw source code.
- *
- * ``` php
- * seeInSource('
Green eggs & ham
');
- * ```
- *
- * @param $raw
- * Conditional Assertion: Test won't be stopped on fail
- * @see \Codeception\Module\WebDriver::seeInSource()
- */
- public function canSeeInSource($raw) {
- return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInSource', func_get_args()));
- }
- /**
- * [!] Method is generated. Documentation taken from corresponding module.
- *
- * Checks that the current page contains the given string in its
- * raw source code.
- *
- * ``` php
- * seeInSource('
Green eggs & ham
');
- * ```
- *
- * @param $raw
- * @see \Codeception\Module\WebDriver::seeInSource()
- */
- public function seeInSource($raw) {
- return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInSource', func_get_args()));
- }
-
-
- /**
- * [!] Method is generated. Documentation taken from corresponding module.
- *
- * Checks that the current page contains the given string in its
- * raw source code.
- *
- * ```php
- * dontSeeInSource('
Green eggs & ham
');
- * ```
- *
- * @param $raw
- * Conditional Assertion: Test won't be stopped on fail
- * @see \Codeception\Module\WebDriver::dontSeeInSource()
- */
- public function cantSeeInSource($raw) {
- return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInSource', func_get_args()));
- }
- /**
- * [!] Method is generated. Documentation taken from corresponding module.
- *
- * Checks that the current page contains the given string in its
- * raw source code.
- *
- * ```php
- * dontSeeInSource('
Green eggs & ham
');
- * ```
- *
- * @param $raw
- * @see \Codeception\Module\WebDriver::dontSeeInSource()
- */
- public function dontSeeInSource($raw) {
- return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeInSource', func_get_args()));
- }
-
-
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
@@ -1565,28 +1425,7 @@ trait AcceptanceTesterActions
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
- * Grabs either the text content, or attribute values, of nodes
- * matched by $cssOrXpath and returns them as an array.
- *
- * ```html
- *
First
- *
Second
- *
Third
- * ```
- *
- * ```php
- * grabMultiple('a');
- *
- * // would return ['#first', '#second', '#third']
- * $aLinks = $I->grabMultiple('a', 'href');
- * ?>
- * ```
- *
- * @param $cssOrXpath
- * @param $attribute
- * @return string[]
+ *
* @see \Codeception\Module\WebDriver::grabMultiple()
*/
public function grabMultiple($cssOrXpath, $attribute = null) {
@@ -1801,27 +1640,6 @@ trait AcceptanceTesterActions
}
- /**
- * [!] Method is generated. Documentation taken from corresponding module.
- *
- *
- * Conditional Assertion: Test won't be stopped on fail
- * @see \Codeception\Module\WebDriver::seeNumberOfElementsInDOM()
- */
- public function canSeeNumberOfElementsInDOM($selector, $expected) {
- return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeNumberOfElementsInDOM', func_get_args()));
- }
- /**
- * [!] Method is generated. Documentation taken from corresponding module.
- *
- *
- * @see \Codeception\Module\WebDriver::seeNumberOfElementsInDOM()
- */
- public function seeNumberOfElementsInDOM($selector, $expected) {
- return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeNumberOfElementsInDOM', func_get_args()));
- }
-
-
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
@@ -2139,13 +1957,13 @@ trait AcceptanceTesterActions
* ```
* 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
* 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', [
@@ -2645,7 +2463,34 @@ trait AcceptanceTesterActions
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
- * @param string $name
+ * 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
+ * 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) {
@@ -2656,8 +2501,11 @@ trait AcceptanceTesterActions
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
- * @param string $name
- * @return bool
+ * Loads cookies from saved snapshot.
+ *
+ * @param $name
+ * @see saveSessionSnapshot
+ * @return mixed
* @see \Codeception\Module\WebDriver::loadSessionSnapshot()
*/
public function loadSessionSnapshot($name) {
@@ -2668,7 +2516,7 @@ trait AcceptanceTesterActions
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
- * Inserts an SQL record into a database. This record will be erased after the test.
+ * Inserts SQL record into database. This record will be erased after the test.
*
* ``` php
*
* ```
*
- * @param int $expectedNumber Expected number
+ * @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($expectedNumber, $table, $criteria = null) {
+ 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 the given number of records were found in the database.
+ * Asserts that found number of records in database
*
* ``` php
*
* ```
*
- * @param int $expectedNumber Expected number
+ * @param int $num Expected number
* @param string $table Table name
* @param array $criteria Search criteria [Optional]
* @see \Codeception\Module\Db::seeNumRecords()
*/
- public function seeNumRecords($expectedNumber, $table, $criteria = null) {
+ public function seeNumRecords($num, $table, $criteria = null) {
return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeNumRecords', func_get_args()));
}
@@ -2790,7 +2638,7 @@ trait AcceptanceTesterActions
*
* Effect is opposite to ->seeInDatabase
*
- * Asserts that there is no record with the given column values in a database.
+ * Checks if there is no record with such column values in database.
* Provide table name and column values.
*
* Example:
@@ -2820,7 +2668,7 @@ trait AcceptanceTesterActions
*
* Effect is opposite to ->seeInDatabase
*
- * Asserts that there is no record with the given column values in a database.
+ * Checks if there is no record with such column values in database.
* Provide table name and column values.
*
* Example:
diff --git a/tests/_support/_generated/FunctionalTesterActions.php b/tests/_support/_generated/FunctionalTesterActions.php
index a3980a806784..edf786bc5c7e 100644
--- a/tests/_support/_generated/FunctionalTesterActions.php
+++ b/tests/_support/_generated/FunctionalTesterActions.php
@@ -1,4 +1,4 @@
-amOnPage('/');
* // opens /register page
* $I->amOnPage('/register');
+ * ?>
* ```
*
* @param $page
@@ -216,31 +217,16 @@ trait FunctionalTesterActions
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
- * Checks that the current page contains the given string (case insensitive).
- *
- * You can specify a specific HTML element (via CSS or XPath) as the second
- * parameter to only search within that element.
+ * Checks that the current page contains the given string.
+ * Specify a locator as the second parameter to match a specific region.
*
* ``` php
* see('Logout'); // I can suppose user is logged in
- * $I->see('Sign Up', 'h1'); // I can suppose it's a signup page
- * $I->see('Sign Up', '//body/h1'); // with XPath
+ * $I->see('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
+ * ?>
* ```
- *
- * Note that the search is done after stripping all HTML tags from the body,
- * so `$I->see('strong')` will return true for strings like:
- *
- * - `
I am Stronger than thou
`
- * - ``
- *
- * But will *not* be true for strings like:
- *
- * - `
Home`
- * - `
Home`
- * - ``
- *
- * For checking the raw source code, use `seeInSource()`.
*
* @param $text
* @param null $selector
@@ -253,31 +239,16 @@ trait FunctionalTesterActions
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
- * Checks that the current page contains the given string (case insensitive).
- *
- * You can specify a specific HTML element (via CSS or XPath) as the second
- * parameter to only search within that element.
+ * Checks that the current page contains the given string.
+ * Specify a locator as the second parameter to match a specific region.
*
* ``` php
* see('Logout'); // I can suppose user is logged in
- * $I->see('Sign Up', 'h1'); // I can suppose it's a signup page
- * $I->see('Sign Up', '//body/h1'); // with XPath
+ * $I->see('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
+ * ?>
* ```
- *
- * Note that the search is done after stripping all HTML tags from the body,
- * so `$I->see('strong')` will return true for strings like:
- *
- * - `
I am Stronger than thou
`
- * - ``
- *
- * But will *not* be true for strings like:
- *
- * - `
Home`
- * - `
Home`
- * - ``
- *
- * For checking the raw source code, use `seeInSource()`.
*
* @param $text
* @param null $selector
@@ -291,29 +262,16 @@ trait FunctionalTesterActions
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
- * Checks that the current page doesn't contain the text specified (case insensitive).
+ * Checks that the current page doesn't contain the text specified.
* Give a locator as the second parameter to match a specific region.
*
* ```php
* dontSee('Login'); // I can suppose user is already logged in
- * $I->dontSee('Sign Up','h1'); // I can suppose it's not a signup page
- * $I->dontSee('Sign Up','//body/h1'); // with XPath
+ * $I->dontSee('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
+ * ?>
* ```
- *
- * Note that the search is done after stripping all HTML tags from the body,
- * so `$I->dontSee('strong')` will fail on strings like:
- *
- * - `
I am Stronger than thou
`
- * - ``
- *
- * But will ignore strings like:
- *
- * - `
Home`
- * - `
Home`
- * - ``
- *
- * For checking the raw source code, use `seeInSource()`.
*
* @param $text
* @param null $selector
@@ -326,29 +284,16 @@ trait FunctionalTesterActions
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
- * Checks that the current page doesn't contain the text specified (case insensitive).
+ * Checks that the current page doesn't contain the text specified.
* Give a locator as the second parameter to match a specific region.
*
* ```php
* dontSee('Login'); // I can suppose user is already logged in
- * $I->dontSee('Sign Up','h1'); // I can suppose it's not a signup page
- * $I->dontSee('Sign Up','//body/h1'); // with XPath
+ * $I->dontSee('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
+ * ?>
* ```
- *
- * Note that the search is done after stripping all HTML tags from the body,
- * so `$I->dontSee('strong')` will fail on strings like:
- *
- * - `
I am Stronger than thou
`
- * - ``
- *
- * But will ignore strings like:
- *
- * - `
Home`
- * - `
Home`
- * - ``
- *
- * For checking the raw source code, use `seeInSource()`.
*
* @param $text
* @param null $selector
@@ -359,80 +304,6 @@ trait FunctionalTesterActions
}
- /**
- * [!] Method is generated. Documentation taken from corresponding module.
- *
- * Checks that the current page contains the given string in its
- * raw source code.
- *
- * ``` php
- * seeInSource('
Green eggs & ham
');
- * ```
- *
- * @param $raw
- * Conditional Assertion: Test won't be stopped on fail
- * @see \Codeception\Lib\InnerBrowser::seeInSource()
- */
- public function canSeeInSource($raw) {
- return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInSource', func_get_args()));
- }
- /**
- * [!] Method is generated. Documentation taken from corresponding module.
- *
- * Checks that the current page contains the given string in its
- * raw source code.
- *
- * ``` php
- * seeInSource('
Green eggs & ham
');
- * ```
- *
- * @param $raw
- * @see \Codeception\Lib\InnerBrowser::seeInSource()
- */
- public function seeInSource($raw) {
- return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInSource', func_get_args()));
- }
-
-
- /**
- * [!] Method is generated. Documentation taken from corresponding module.
- *
- * Checks that the current page contains the given string in its
- * raw source code.
- *
- * ```php
- * dontSeeInSource('
Green eggs & ham
');
- * ```
- *
- * @param $raw
- * Conditional Assertion: Test won't be stopped on fail
- * @see \Codeception\Lib\InnerBrowser::dontSeeInSource()
- */
- public function cantSeeInSource($raw) {
- return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInSource', func_get_args()));
- }
- /**
- * [!] Method is generated. Documentation taken from corresponding module.
- *
- * Checks that the current page contains the given string in its
- * raw source code.
- *
- * ```php
- * dontSeeInSource('
Green eggs & ham
');
- * ```
- *
- * @param $raw
- * @see \Codeception\Lib\InnerBrowser::dontSeeInSource()
- */
- public function dontSeeInSource($raw) {
- return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeInSource', func_get_args()));
- }
-
-
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
@@ -1205,25 +1076,13 @@ trait FunctionalTesterActions
* Submits the given form on the page, optionally with the given form
* values. Give the form fields values as an array.
*
- * Although this function can be used as a short-hand version of
- * `fillField()`, `selectOption()`, `click()` etc. it has some important
- * differences:
- *
- * * Only field *names* may be used, not CSS/XPath selectors nor field labels
- * * If a field is sent to this function that does *not* exist on the page,
- * it will silently be added to the HTTP request. This is helpful for testing
- * some types of forms, but be aware that you will *not* get an exception
- * like you would if you called `fillField()` or `selectOption()` with
- * a missing field.
- *
- * Fields that are not provided will be filled by their values from the page,
- * or from any previous calls to `fillField()`, `selectOption()` etc.
+ * 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 which button's value to include
- * in the request with the last parameter (as an alternative to
- * explicitly setting its value in the second parameter), as
+ * 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:
@@ -1297,8 +1156,7 @@ trait FunctionalTesterActions
* );
* ```
*
- * This function works well when paired with `seeInFormFields()`
- * for quickly testing CRUD interfaces and form validation logic.
+ * Pair this with seeInFormFields for quick testing magic.
*
* ``` php
* true,
* // ...
* ];
- * $I->submitForm('#my-form', $form, 'submitButton');
+ * $I->submitForm('//form[@id=my-form]', $form, 'submitButton');
* // $I->amOnPage('/path/to/form-page') may be needed
- * $I->seeInFormFields('#my-form', $form);
+ * $I->seeInFormFields('//form[@id=my-form]', $form);
+ * ?>
* ```
*
* Parameter values can be set to arrays for multiple input fields
* of the same name, or multi-select combo boxes. For checkboxes,
- * you can use either the string value or boolean `true`/`false` which will
+ * either the string value can be used, or boolean values which will
* be replaced by the checkbox's value in the DOM.
*
* ``` php
@@ -1324,7 +1183,7 @@ trait FunctionalTesterActions
* 'field1' => 'value',
* 'checkbox' => [
* 'value of first checkbox',
- * 'value of second checkbox',
+ * 'value of second checkbox,
* ],
* 'otherCheckboxes' => [
* true,
@@ -1336,29 +1195,27 @@ trait FunctionalTesterActions
* '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
+ * 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
- * submitForm('#my-form', [
* 'field[]' => 'value',
- * 'field[]' => 'another value', // 'field[]' is already a defined key
+ * 'field[]' => 'another value', // 'field[]' is already a defined key
* ]);
* ```
*
* The solution is to pass an array value:
*
* ```php
- * submitForm('#my-form', [
* 'field' => [
* 'value',
@@ -1609,28 +1466,7 @@ trait FunctionalTesterActions
/**
* [!] Method is generated. Documentation taken from corresponding module.
*
- * Grabs either the text content, or attribute values, of nodes
- * matched by $cssOrXpath and returns them as an array.
- *
- * ```html
- *
First
- *
Second
- *
Third
- * ```
- *
- * ```php
- * grabMultiple('a');
- *
- * // would return ['#first', '#second', '#third']
- * $aLinks = $I->grabMultiple('a', 'href');
- * ?>
- * ```
- *
- * @param $cssOrXpath
- * @param $attribute
- * @return string[]
+ *
* @see \Codeception\Lib\InnerBrowser::grabMultiple()
*/
public function grabMultiple($cssOrXpath, $attribute = null) {
@@ -2136,43 +1972,6 @@ trait FunctionalTesterActions
}
- /**
- * [!] Method is generated. Documentation taken from corresponding module.
- *
- * Switch to iframe or frame on the page.
- *
- * Example:
- * ``` html
- *