diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index f1065f909..f6dde2b97 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -1,80 +1,32 @@
on:
- - pull_request
- - push
+ pull_request:
+ paths-ignore:
+ - 'docs/**'
+ - 'README.md'
+ - 'CHANGELOG.md'
+ - '.gitignore'
+ - '.gitattributes'
+ - 'infection.json.dist'
+ - 'psalm.xml'
+
+ push:
+ paths-ignore:
+ - 'docs/**'
+ - 'README.md'
+ - 'CHANGELOG.md'
+ - '.gitignore'
+ - '.gitattributes'
+ - 'infection.json.dist'
+ - 'psalm.xml'
name: build
jobs:
- tests:
- name: PHP ${{ matrix.php }} - ${{ matrix.os }}
-
- env:
+ build:
+ uses: yiisoft/actions/.github/workflows/codeception.yml@master
+ with:
extensions: dom, json, gd, imagick
- key: cache-v1
-
- runs-on: ${{ matrix.os }}
-
- strategy:
- matrix:
- os:
- - ubuntu-latest
- - windows-latest
-
- php:
- - "7.4"
- - "8.0"
- - "8.1"
-
- steps:
- - name: Checkout
- uses: actions/checkout@v2
-
- - name: Setup cache environment
- id: cache-env
- uses: shivammathur/cache-extensions@v1
- with:
- php-version: ${{ matrix.php }}
- extensions: ${{ env.extensions }}
- key: ${{ env.key }}
-
- - name: Cache extensions
- uses: actions/cache@v1
- with:
- path: ${{ steps.cache-env.outputs.dir }}
- key: ${{ steps.cache-env.outputs.key }}
- restore-keys: ${{ steps.cache-env.outputs.key }}
-
- - name: Install PHP with extensions
- uses: shivammathur/setup-php@v2
- with:
- php-version: ${{ matrix.php }}
- extensions: ${{ env.extensions }}
- ini-values: date.timezone='UTC'
-
- - name: Determine composer cache directory on Linux
- if: matrix.os == 'ubuntu-latest'
- run: |
- echo "COMPOSER_CACHE_DIR=$(composer config cache-dir)" >> $GITHUB_ENV
-
- - name: Determine composer cache directory on Windows
- if: matrix.os == 'windows-latest'
- run: |
- echo "COMPOSER_CACHE_DIR=~\AppData\Local\Composer" >> $GITHUB_ENV
-
- - name: Cache dependencies installed with composer
- uses: actions/cache@v1
- with:
- path: ${{ steps.cache-env.outputs.dir }}
- key: php${{ matrix.php }}-composer-${{ matrix.dependencies }}-${{ hashFiles('**/composer.json') }}
- restore-keys: |
- php${{ matrix.php }}-composer-${{ matrix.dependencies }}-
-
- - name: Install dependencies with composer php PHP [5.6 - 8.0]
- run: composer update --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
-
- - name: Run tests with codeception
- run: |
- sed -i "s/'cookieValidationKey' => ''/'cookieValidationKey' => 'testkey'/" config/web.php
- php -S 127.0.0.1:8080 -t public > ./runtime/yii.log 2>&1 &
- vendor/bin/codecept run
- shell: bash
+ os: >-
+ ['ubuntu-latest', 'windows-latest']
+ php: >-
+ ['8.1', '8.2']
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
index 28419e445..277d796a0 100644
--- a/.gitignore
+++ b/.gitignore
@@ -33,4 +33,7 @@ tests/_output/*
tests/_support/_generated
#vagrant folder
-/.vagrant
\ No newline at end of file
+/.vagrant
+
+#codeception
+/c3.php
\ No newline at end of file
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
new file mode 100644
index 000000000..fd87feb27
--- /dev/null
+++ b/.scrutinizer.yml
@@ -0,0 +1,44 @@
+checks:
+ php: true
+
+filter:
+ paths:
+ - "/*"
+ excluded_paths:
+ - "/config/*"
+ - "/runtime/*"
+ - "/tests/Support/*"
+ - "/vagrant/*"
+ - "/vendor/*"
+
+build:
+ image: default-bionic
+
+ environment:
+ variables:
+ YII_ENV: test
+
+ php:
+ version: 8.1.21
+ ini:
+ xdebug.mode: coverage
+
+ nodes:
+ analysis:
+ tests:
+ override:
+ - php-scrutinizer-run
+
+ codeception:
+ dependencies:
+ override:
+ - composer self-update
+ - composer update --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
+
+ tests:
+ override:
+ - command: vendor/bin/codecept run --coverage-xml
+ on_node: 1
+ coverage:
+ file: runtime/_output/coverage.xml
+ format: php-clover
\ No newline at end of file
diff --git a/assets/AppAsset.php b/assets/AppAsset.php
index 3d40487ae..e7038ab27 100644
--- a/assets/AppAsset.php
+++ b/assets/AppAsset.php
@@ -1,4 +1,7 @@
* @since 2.0
*/
-class HelloController extends Controller
+final class HelloController extends Controller
{
/**
* This command echoes what you have entered as the message.
+ *
* @param string $message the message to be echoed.
+ *
* @return int Exit code
*/
- public function actionIndex($message = 'hello world')
+ public function actionIndex(string $message = 'hello world'): int
{
echo $message . "\n";
diff --git a/composer.json b/composer.json
index 722fcba65..bf8685787 100644
--- a/composer.json
+++ b/composer.json
@@ -14,27 +14,30 @@
},
"minimum-stability": "dev",
"require": {
- "php": ">=7.4.0",
- "yiisoft/yii2": "~2.0.45",
+ "php": ">=8.1",
+ "yiisoft/yii2": "2.2.x-dev as 2.0.48.1",
"yiisoft/yii2-bootstrap5": "~2.0.2",
"yiisoft/yii2-symfonymailer": "~2.0.3"
},
"require-dev": {
+ "codeception/c3": "^2.8",
+ "codeception/codeception": "^5.0.0",
+ "codeception/lib-innerbrowser": "^4.0",
+ "codeception/module-asserts": "^3.0",
+ "codeception/module-filesystem": "^3.0",
+ "codeception/module-yii2": "^1.1",
+ "codeception/verify": "^3.0",
+ "maglnet/composer-require-checker": "^4.6",
+ "symfony/browser-kit": "^6.3",
+ "symfony/process": "^6.3",
"yiisoft/yii2-debug": "~2.1.0",
- "yiisoft/yii2-gii": "~2.2.0",
"yiisoft/yii2-faker": "~2.0.0",
- "phpunit/phpunit": "~9.5.0",
- "codeception/codeception": "^5.0.0 || ^4.0",
- "codeception/lib-innerbrowser": "^4.0 || ^3.0 || ^1.1",
- "codeception/module-asserts": "^3.0 || ^1.1",
- "codeception/module-yii2": "^1.1",
- "codeception/module-filesystem": "^3.0 || ^2.0 || ^1.1",
- "codeception/verify": "^3.0 || ^2.2",
- "symfony/browser-kit": "^6.0 || >=2.7 <=4.2.4"
+ "yiisoft/yii2-gii": "~2.2.0"
},
"config": {
"allow-plugins": {
- "yiisoft/yii2-composer" : true
+ "yiisoft/yii2-composer": true,
+ "codeception/c3": true
},
"process-timeout": 1800,
"fxp-asset": {
diff --git a/config/web.php b/config/web.php
index 8b9dd3f94..9ac0013f5 100644
--- a/config/web.php
+++ b/config/web.php
@@ -14,7 +14,7 @@
'components' => [
'request' => [
// !!! insert a secret key in the following (if it is empty) - this is required by cookie validation
- 'cookieValidationKey' => '',
+ 'cookieValidationKey' => '1',
],
'cache' => [
'class' => 'yii\caching\FileCache',
diff --git a/controllers/SiteController.php b/controllers/SiteController.php
index 67c3f50f8..cd3be2e7f 100644
--- a/controllers/SiteController.php
+++ b/controllers/SiteController.php
@@ -1,5 +1,7 @@
[
@@ -41,7 +43,7 @@ public function behaviors()
/**
* {@inheritdoc}
*/
- public function actions()
+ public function actions(): array
{
return [
'error' => [
@@ -59,7 +61,7 @@ public function actions()
*
* @return string
*/
- public function actionIndex()
+ public function actionIndex(): string
{
return $this->render('index');
}
@@ -69,7 +71,7 @@ public function actionIndex()
*
* @return Response|string
*/
- public function actionLogin()
+ public function actionLogin(): Response|string
{
if (!Yii::$app->user->isGuest) {
return $this->goHome();
@@ -91,7 +93,7 @@ public function actionLogin()
*
* @return Response
*/
- public function actionLogout()
+ public function actionLogout(): Response
{
Yii::$app->user->logout();
@@ -103,7 +105,7 @@ public function actionLogout()
*
* @return Response|string
*/
- public function actionContact()
+ public function actionContact(): Response|string
{
$model = new ContactForm();
if ($model->load(Yii::$app->request->post()) && $model->contact(Yii::$app->params['adminEmail'])) {
@@ -121,7 +123,7 @@ public function actionContact()
*
* @return string
*/
- public function actionAbout()
+ public function actionAbout(): string
{
return $this->render('about');
}
diff --git a/models/ContactForm.php b/models/ContactForm.php
index f001d2192..93caa0f8f 100644
--- a/models/ContactForm.php
+++ b/models/ContactForm.php
@@ -1,5 +1,7 @@
'Verification Code',
@@ -44,10 +46,12 @@ public function attributeLabels()
/**
* Sends an email to the specified email address using the information collected by this model.
+ *
* @param string $email the target email address
+ *
* @return bool whether the model passes validation
*/
- public function contact($email)
+ public function contact(string $email): bool
{
if ($this->validate()) {
Yii::$app->mailer->compose()
diff --git a/models/LoginForm.php b/models/LoginForm.php
index dce15ccf7..86b1f5dfd 100644
--- a/models/LoginForm.php
+++ b/models/LoginForm.php
@@ -1,5 +1,7 @@
hasErrors()) {
$user = $this->getUser();
@@ -55,9 +57,10 @@ public function validatePassword($attribute, $params)
/**
* Logs in a user using the provided username and password.
+ *
* @return bool whether the user is logged in successfully
*/
- public function login()
+ public function login(): bool
{
if ($this->validate()) {
return Yii::$app->user->login($this->getUser(), $this->rememberMe ? 3600*24*30 : 0);
@@ -68,14 +71,14 @@ public function login()
/**
* Finds user by [[username]]
*
- * @return User|null
+ * @return User|null the user identity
*/
- public function getUser()
+ public function getUser(): User|null
{
- if ($this->_user === false) {
- $this->_user = User::findByUsername($this->username);
+ if ($this->user === false) {
+ $this->user = User::findByUsername($this->username);
}
- return $this->_user;
+ return $this->user;
}
}
diff --git a/models/User.php b/models/User.php
index 2e3fb25ed..fc285eeff 100644
--- a/models/User.php
+++ b/models/User.php
@@ -1,16 +1,20 @@
[
'id' => '100',
'username' => 'admin',
@@ -31,7 +35,7 @@ class User extends \yii\base\BaseObject implements \yii\web\IdentityInterface
/**
* {@inheritdoc}
*/
- public static function findIdentity($id)
+ public static function findIdentity($id): IdentityInterface|null
{
return isset(self::$users[$id]) ? new static(self::$users[$id]) : null;
}
@@ -39,7 +43,7 @@ public static function findIdentity($id)
/**
* {@inheritdoc}
*/
- public static function findIdentityByAccessToken($token, $type = null)
+ public static function findIdentityByAccessToken($token, $type = null): IdentityInterface|null
{
foreach (self::$users as $user) {
if ($user['accessToken'] === $token) {
@@ -53,13 +57,14 @@ public static function findIdentityByAccessToken($token, $type = null)
/**
* Finds user by username
*
- * @param string $username
- * @return static|null
+ * @param string $username the username
+ *
+ * @return static|null the user object
*/
- public static function findByUsername($username)
+ public static function findByUsername($username): static|null
{
foreach (self::$users as $user) {
- if (strcasecmp($user['username'], $username) === 0) {
+ if (strcasecmp((string) $user['username'], $username) === 0) {
return new static($user);
}
}
@@ -70,7 +75,7 @@ public static function findByUsername($username)
/**
* {@inheritdoc}
*/
- public function getId()
+ public function getId(): string
{
return $this->id;
}
@@ -78,7 +83,7 @@ public function getId()
/**
* {@inheritdoc}
*/
- public function getAuthKey()
+ public function getAuthKey(): string
{
return $this->authKey;
}
@@ -86,7 +91,7 @@ public function getAuthKey()
/**
* {@inheritdoc}
*/
- public function validateAuthKey($authKey)
+ public function validateAuthKey($authKey): bool
{
return $this->authKey === $authKey;
}
@@ -95,9 +100,10 @@ public function validateAuthKey($authKey)
* Validates password
*
* @param string $password password to validate
+ *
* @return bool if password provided is valid for current user
*/
- public function validatePassword($password)
+ public function validatePassword(string $password): bool
{
return $this->password === $password;
}
diff --git a/tests/Acceptance.suite.yml b/tests/Acceptance.suite.yml
new file mode 100644
index 000000000..19fcf72af
--- /dev/null
+++ b/tests/Acceptance.suite.yml
@@ -0,0 +1,17 @@
+# Codeception Test Suite Configuration
+#
+# Suite for acceptance tests.
+# Perform tests in browser using the WebDriver or PhpBrowser.
+# If you need both WebDriver and PHPBrowser tests - create a separate suite.
+
+actor: AcceptanceTester
+extensions:
+ enabled:
+ - Codeception\Extension\RunProcess:
+ 0: php -d variables_order=EGPCS -S 127.0.0.1:8080 web/index-test.php -t web
+ sleep: 1
+modules:
+ enabled:
+ - Filesystem
+ - Yii2
+ - Asserts
diff --git a/tests/acceptance/AboutCest.php b/tests/Acceptance/AboutCest.php
similarity index 52%
rename from tests/acceptance/AboutCest.php
rename to tests/Acceptance/AboutCest.php
index 8a7be5af1..d2387c3f4 100644
--- a/tests/acceptance/AboutCest.php
+++ b/tests/Acceptance/AboutCest.php
@@ -1,10 +1,12 @@
amOnPage(Url::toRoute('/site/about'));
$I->see('About', 'h1');
diff --git a/tests/acceptance/ContactCest.php b/tests/Acceptance/ContactCest.php
similarity index 77%
rename from tests/acceptance/ContactCest.php
rename to tests/Acceptance/ContactCest.php
index 90f98482e..abdbbd074 100644
--- a/tests/acceptance/ContactCest.php
+++ b/tests/Acceptance/ContactCest.php
@@ -1,21 +1,23 @@
amOnPage(Url::toRoute('/site/contact'));
}
- public function contactPageWorks(AcceptanceTester $I)
+ public function contactPageWorks(AcceptanceTester $I): void
{
$I->wantTo('ensure that contact page works');
$I->see('Contact', 'h1');
}
- public function contactFormCanBeSubmitted(AcceptanceTester $I)
+ public function contactFormCanBeSubmitted(AcceptanceTester $I): void
{
$I->amGoingTo('submit contact form with correct data');
$I->fillField('#contactform-name', 'tester');
@@ -25,9 +27,8 @@ public function contactFormCanBeSubmitted(AcceptanceTester $I)
$I->fillField('#contactform-verifycode', 'testme');
$I->click('contact-button');
-
- $I->wait(2); // wait for button to be clicked
+ $I->expectTo('see message about successful sending');
$I->dontSeeElement('#contact-form');
$I->see('Thank you for contacting us. We will respond to you as soon as possible.');
}
diff --git a/tests/acceptance/HomeCest.php b/tests/Acceptance/HomeCest.php
similarity index 77%
rename from tests/acceptance/HomeCest.php
rename to tests/Acceptance/HomeCest.php
index e65df16ae..8fd0610a8 100644
--- a/tests/acceptance/HomeCest.php
+++ b/tests/Acceptance/HomeCest.php
@@ -1,18 +1,20 @@
amOnPage(Url::toRoute('/site/index'));
$I->see('My Company');
$I->seeLink('About');
$I->click('About');
- $I->wait(2); // wait for page to be opened
+ $I->expectTo('see About page');
$I->see('This is the About page.');
}
}
diff --git a/tests/acceptance/LoginCest.php b/tests/Acceptance/LoginCest.php
similarity index 51%
rename from tests/acceptance/LoginCest.php
rename to tests/Acceptance/LoginCest.php
index 6f5cb2f38..986700a09 100644
--- a/tests/acceptance/LoginCest.php
+++ b/tests/Acceptance/LoginCest.php
@@ -1,10 +1,12 @@
amOnPage(Url::toRoute('/site/login'));
$I->see('Login', 'h1');
@@ -13,9 +15,18 @@ public function ensureThatLoginWorks(AcceptanceTester $I)
$I->fillField('input[name="LoginForm[username]"]', 'admin');
$I->fillField('input[name="LoginForm[password]"]', 'admin');
$I->click('login-button');
- $I->wait(2); // wait for button to be clicked
$I->expectTo('see user info');
$I->see('Logout');
+
+ $I->amGoingTo('try to login with the user is logged in');
+ $I->amOnPage(Url::toRoute('/site/login'));
+ $I->dontSee('Login', 'h1');
+
+ $I->amGoingTo('logout');
+ $I->click('Logout');
+
+ $I->expectTo('see home page');
+ $I->see('Congratulations!');
}
}
diff --git a/tests/acceptance/_bootstrap.php b/tests/Acceptance/_bootstrap.php
similarity index 100%
rename from tests/acceptance/_bootstrap.php
rename to tests/Acceptance/_bootstrap.php
diff --git a/tests/functional.suite.yml b/tests/Functional.suite.yml
similarity index 100%
rename from tests/functional.suite.yml
rename to tests/Functional.suite.yml
diff --git a/tests/functional/ContactFormCest.php b/tests/Functional/ContactFormCest.php
similarity index 81%
rename from tests/functional/ContactFormCest.php
rename to tests/Functional/ContactFormCest.php
index d17ef52fd..a9c9750e5 100644
--- a/tests/functional/ContactFormCest.php
+++ b/tests/Functional/ContactFormCest.php
@@ -1,18 +1,20 @@
amOnRoute('site/contact');
}
- public function openContactPage(\FunctionalTester $I)
+ public function openContactPage(FunctionalTester $I): void
{
$I->see('Contact', 'h1');
}
- public function submitEmptyForm(\FunctionalTester $I)
+ public function submitEmptyForm(FunctionalTester $I): void
{
$I->submitForm('#contact-form', []);
$I->expectTo('see validations errors');
@@ -24,7 +26,7 @@ public function submitEmptyForm(\FunctionalTester $I)
$I->see('The verification code is incorrect');
}
- public function submitFormWithIncorrectEmail(\FunctionalTester $I)
+ public function submitFormWithIncorrectEmail(FunctionalTester $I): void
{
$I->submitForm('#contact-form', [
'ContactForm[name]' => 'tester',
@@ -41,7 +43,7 @@ public function submitFormWithIncorrectEmail(\FunctionalTester $I)
$I->dontSee('The verification code is incorrect', '.help-inline');
}
- public function submitFormSuccessfully(\FunctionalTester $I)
+ public function submitFormSuccessfully(FunctionalTester $I): void
{
$I->submitForm('#contact-form', [
'ContactForm[name]' => 'tester',
diff --git a/tests/functional/LoginFormCest.php b/tests/Functional/LoginFormCest.php
similarity index 69%
rename from tests/functional/LoginFormCest.php
rename to tests/Functional/LoginFormCest.php
index 7a83a27d6..ce14808c0 100644
--- a/tests/functional/LoginFormCest.php
+++ b/tests/Functional/LoginFormCest.php
@@ -1,20 +1,21 @@
amOnRoute('site/login');
}
- public function openLoginPage(\FunctionalTester $I)
+ public function openLoginPage(FunctionalTester $I): void
{
$I->see('Login', 'h1');
-
}
// demonstrates `amLoggedInAs` method
- public function internalLoginById(\FunctionalTester $I)
+ public function internalLoginById(FunctionalTester $I): void
{
$I->amLoggedInAs(100);
$I->amOnPage('/');
@@ -22,14 +23,14 @@ public function internalLoginById(\FunctionalTester $I)
}
// demonstrates `amLoggedInAs` method
- public function internalLoginByInstance(\FunctionalTester $I)
+ public function internalLoginByInstance(FunctionalTester $I): void
{
$I->amLoggedInAs(\app\models\User::findByUsername('admin'));
$I->amOnPage('/');
$I->see('Logout (admin)');
}
- public function loginWithEmptyCredentials(\FunctionalTester $I)
+ public function loginWithEmptyCredentials(FunctionalTester $I): void
{
$I->submitForm('#login-form', []);
$I->expectTo('see validations errors');
@@ -37,7 +38,7 @@ public function loginWithEmptyCredentials(\FunctionalTester $I)
$I->see('Password cannot be blank.');
}
- public function loginWithWrongCredentials(\FunctionalTester $I)
+ public function loginWithWrongCredentials(FunctionalTester $I): void
{
$I->submitForm('#login-form', [
'LoginForm[username]' => 'admin',
@@ -47,7 +48,7 @@ public function loginWithWrongCredentials(\FunctionalTester $I)
$I->see('Incorrect username or password.');
}
- public function loginSuccessfully(\FunctionalTester $I)
+ public function loginSuccessfully(FunctionalTester $I): void
{
$I->submitForm('#login-form', [
'LoginForm[username]' => 'admin',
diff --git a/tests/functional/_bootstrap.php b/tests/Functional/_bootstrap.php
similarity index 100%
rename from tests/functional/_bootstrap.php
rename to tests/Functional/_bootstrap.php
diff --git a/tests/_support/AcceptanceTester.php b/tests/Support/AcceptanceTester.php
similarity index 80%
rename from tests/_support/AcceptanceTester.php
rename to tests/Support/AcceptanceTester.php
index 4c7dcbb6d..c87742cbd 100644
--- a/tests/_support/AcceptanceTester.php
+++ b/tests/Support/AcceptanceTester.php
@@ -1,10 +1,12 @@
getScenario()->runStep(new \Codeception\Step\Condition('amInPath', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Opens a file and stores it's content.
+ *
+ * Usage:
+ *
+ * ``` php
+ * openFile('composer.json');
+ * $I->seeInThisFile('codeception/codeception');
+ * ```
+ * @see \Codeception\Module\Filesystem::openFile()
+ */
+ public function openFile(string $filename): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('openFile', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Deletes a file
+ *
+ * ``` php
+ * deleteFile('composer.lock');
+ * ```
+ * @see \Codeception\Module\Filesystem::deleteFile()
+ */
+ public function deleteFile(string $filename): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('deleteFile', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Deletes directory with all subdirectories
+ *
+ * ``` php
+ * deleteDir('vendor');
+ * ```
+ * @see \Codeception\Module\Filesystem::deleteDir()
+ */
+ public function deleteDir(string $dirname): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('deleteDir', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Copies directory with all contents
+ *
+ * ``` php
+ * copyDir('vendor','old_vendor');
+ * ```
+ * @see \Codeception\Module\Filesystem::copyDir()
+ */
+ public function copyDir(string $src, string $dst): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('copyDir', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks If opened file has `text` in it.
+ *
+ * Usage:
+ *
+ * ``` php
+ * openFile('composer.json');
+ * $I->seeInThisFile('codeception/codeception');
+ * ```
+ * @see \Codeception\Module\Filesystem::seeInThisFile()
+ */
+ public function seeInThisFile(string $text): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInThisFile', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks If opened file has `text` in it.
+ *
+ * Usage:
+ *
+ * ``` php
+ * openFile('composer.json');
+ * $I->seeInThisFile('codeception/codeception');
+ * ```
+ * @see \Codeception\Module\Filesystem::seeInThisFile()
+ */
+ public function canSeeInThisFile(string $text): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInThisFile', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks If opened file has the `number` of new lines.
+ *
+ * Usage:
+ *
+ * ``` php
+ * openFile('composer.json');
+ * $I->seeNumberNewLines(5);
+ * ```
+ *
+ * @param int $number New lines
+ * @see \Codeception\Module\Filesystem::seeNumberNewLines()
+ */
+ public function seeNumberNewLines(int $number): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeNumberNewLines', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks If opened file has the `number` of new lines.
+ *
+ * Usage:
+ *
+ * ``` php
+ * openFile('composer.json');
+ * $I->seeNumberNewLines(5);
+ * ```
+ *
+ * @param int $number New lines
+ * @see \Codeception\Module\Filesystem::seeNumberNewLines()
+ */
+ public function canSeeNumberNewLines(int $number): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeNumberNewLines', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks that contents of currently opened file matches $regex
+ * @see \Codeception\Module\Filesystem::seeThisFileMatches()
+ */
+ public function seeThisFileMatches(string $regex): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeThisFileMatches', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that contents of currently opened file matches $regex
+ * @see \Codeception\Module\Filesystem::seeThisFileMatches()
+ */
+ public function canSeeThisFileMatches(string $regex): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeThisFileMatches', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks the strict matching of file contents.
+ * Unlike `seeInThisFile` will fail if file has something more than expected lines.
+ * Better to use with HEREDOC strings.
+ * Matching is done after removing "\r" chars from file content.
+ *
+ * ``` php
+ * openFile('process.pid');
+ * $I->seeFileContentsEqual('3192');
+ * ```
+ * @see \Codeception\Module\Filesystem::seeFileContentsEqual()
+ */
+ public function seeFileContentsEqual(string $text): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeFileContentsEqual', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks the strict matching of file contents.
+ * Unlike `seeInThisFile` will fail if file has something more than expected lines.
+ * Better to use with HEREDOC strings.
+ * Matching is done after removing "\r" chars from file content.
+ *
+ * ``` php
+ * openFile('process.pid');
+ * $I->seeFileContentsEqual('3192');
+ * ```
+ * @see \Codeception\Module\Filesystem::seeFileContentsEqual()
+ */
+ public function canSeeFileContentsEqual(string $text): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeFileContentsEqual', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks If opened file doesn't contain `text` in it
+ *
+ * ``` php
+ * openFile('composer.json');
+ * $I->dontSeeInThisFile('codeception/codeception');
+ * ```
+ * @see \Codeception\Module\Filesystem::dontSeeInThisFile()
+ */
+ public function dontSeeInThisFile(string $text): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeInThisFile', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks If opened file doesn't contain `text` in it
+ *
+ * ``` php
+ * openFile('composer.json');
+ * $I->dontSeeInThisFile('codeception/codeception');
+ * ```
+ * @see \Codeception\Module\Filesystem::dontSeeInThisFile()
+ */
+ public function cantSeeInThisFile(string $text): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInThisFile', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Deletes a file
+ * @see \Codeception\Module\Filesystem::deleteThisFile()
+ */
+ public function deleteThisFile(): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('deleteThisFile', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks if file exists in path.
+ * Opens a file when it's exists
+ *
+ * ``` php
+ * seeFileFound('UserModel.php','app/models');
+ * ```
+ * @see \Codeception\Module\Filesystem::seeFileFound()
+ */
+ public function seeFileFound(string $filename, string $path = ""): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeFileFound', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks if file exists in path.
+ * Opens a file when it's exists
+ *
+ * ``` php
+ * seeFileFound('UserModel.php','app/models');
+ * ```
+ * @see \Codeception\Module\Filesystem::seeFileFound()
+ */
+ public function canSeeFileFound(string $filename, string $path = ""): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeFileFound', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks if file does not exist in path
+ * @see \Codeception\Module\Filesystem::dontSeeFileFound()
+ */
+ public function dontSeeFileFound(string $filename, string $path = ""): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeFileFound', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks if file does not exist in path
+ * @see \Codeception\Module\Filesystem::dontSeeFileFound()
+ */
+ public function cantSeeFileFound(string $filename, string $path = ""): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeFileFound', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Erases directory contents
+ *
+ * ``` php
+ * cleanDir('logs');
+ * ```
+ * @see \Codeception\Module\Filesystem::cleanDir()
+ */
+ public function cleanDir(string $dirname): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('cleanDir', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Saves contents to file
+ * @see \Codeception\Module\Filesystem::writeToFile()
+ */
+ public function writeToFile(string $filename, string $contents): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('writeToFile', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Authenticates a user on a site without submitting a login form.
+ * Use it for fast pragmatic authorization in functional tests.
+ *
+ * ```php
+ * amLoggedInAs(1);
+ *
+ * // User object is passed as parameter
+ * $admin = \app\models\User::findByUsername('admin');
+ * $I->amLoggedInAs($admin);
+ * ```
+ * Requires the `user` component to be enabled and configured.
+ *
+ * @param $user
+ * @throws \Codeception\Exception\ModuleException
+ * @see \Codeception\Module\Yii2::amLoggedInAs()
+ */
+ public function amLoggedInAs($user) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Condition('amLoggedInAs', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Creates and loads fixtures from a config.
+ * The signature is the same as for the `fixtures()` method of `yii\test\FixtureTrait`
+ *
+ * ```php
+ * haveFixtures([
+ * 'posts' => PostsFixture::class,
+ * 'user' => [
+ * 'class' => UserFixture::class,
+ * 'dataFile' => '@tests/_data/models/user.php',
+ * ],
+ * ]);
+ * ```
+ *
+ * Note: if you need to load fixtures before a test (probably before the
+ * cleanup transaction is started; `cleanup` option is `true` by default),
+ * you can specify the fixtures in the `_fixtures()` method of a test case
+ *
+ * ```php
+ * [
+ * 'class' => UserFixture::class,
+ * 'dataFile' => codecept_data_dir() . 'user.php'
+ * ]
+ * ];
+ * }
+ * ```
+ * instead of calling `haveFixtures` in Cest `_before`
+ *
+ * @param $fixtures
+ * @part fixtures
+ * @see \Codeception\Module\Yii2::haveFixtures()
+ */
+ public function haveFixtures($fixtures) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('haveFixtures', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Returns all loaded fixtures.
+ * Array of fixture instances
+ *
+ * @part fixtures
+ * @return array
+ * @see \Codeception\Module\Yii2::grabFixtures()
+ */
+ public function grabFixtures() {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('grabFixtures', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Gets a fixture by name.
+ * Returns a Fixture instance. If a fixture is an instance of
+ * `\yii\test\BaseActiveFixture` a second parameter can be used to return a
+ * specific model:
+ *
+ * ```php
+ * haveFixtures(['users' => UserFixture::class]);
+ *
+ * $users = $I->grabFixture('users');
+ *
+ * // get first user by key, if a fixture is an instance of ActiveFixture
+ * $user = $I->grabFixture('users', 'user1');
+ * ```
+ *
+ * @param $name
+ * @return mixed
+ * @throws \Codeception\Exception\ModuleException if the fixture is not found
+ * @part fixtures
+ * @see \Codeception\Module\Yii2::grabFixture()
+ */
+ public function grabFixture($name, $index = NULL) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('grabFixture', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Inserts a record into the database.
+ *
+ * ``` php
+ * haveRecord('app\models\User', array('name' => 'Davert'));
+ * ?>
+ * ```
+ *
+ * @param $model
+ * @param array $attributes
+ * @return mixed
+ * @part orm
+ * @see \Codeception\Module\Yii2::haveRecord()
+ */
+ public function haveRecord($model, $attributes = []) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('haveRecord', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks that a record exists in the database.
+ *
+ * ``` php
+ * $I->seeRecord('app\models\User', array('name' => 'davert'));
+ * ```
+ *
+ * @param $model
+ * @param array $attributes
+ * @part orm
+ * @see \Codeception\Module\Yii2::seeRecord()
+ */
+ public function seeRecord(string $model, array $attributes = []): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeRecord', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that a record exists in the database.
+ *
+ * ``` php
+ * $I->seeRecord('app\models\User', array('name' => 'davert'));
+ * ```
+ *
+ * @param $model
+ * @param array $attributes
+ * @part orm
+ * @see \Codeception\Module\Yii2::seeRecord()
+ */
+ public function canSeeRecord(string $model, array $attributes = []): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeRecord', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks that a record does not exist in the database.
+ *
+ * ``` php
+ * $I->dontSeeRecord('app\models\User', array('name' => 'davert'));
+ * ```
+ *
+ * @param $model
+ * @param array $attributes
+ * @part orm
+ * @see \Codeception\Module\Yii2::dontSeeRecord()
+ */
+ public function dontSeeRecord(string $model, array $attributes = []): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeRecord', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that a record does not exist in the database.
+ *
+ * ``` php
+ * $I->dontSeeRecord('app\models\User', array('name' => 'davert'));
+ * ```
+ *
+ * @param $model
+ * @param array $attributes
+ * @part orm
+ * @see \Codeception\Module\Yii2::dontSeeRecord()
+ */
+ public function cantSeeRecord(string $model, array $attributes = []): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeRecord', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Retrieves a record from the database
+ *
+ * ``` php
+ * $category = $I->grabRecord('app\models\User', array('name' => 'davert'));
+ * ```
+ *
+ * @param $model
+ * @param array $attributes
+ * @return mixed
+ * @part orm
+ * @see \Codeception\Module\Yii2::grabRecord()
+ */
+ public function grabRecord(string $model, array $attributes = []): mixed {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('grabRecord', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Similar to `amOnPage` but accepts a route as first argument and params as second
+ *
+ * ```
+ * $I->amOnRoute('site/view', ['page' => 'about']);
+ * ```
+ *
+ * @param string $route A route
+ * @param array $params Additional route parameters
+ * @see \Codeception\Module\Yii2::amOnRoute()
+ */
+ public function amOnRoute(string $route, array $params = []): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Condition('amOnRoute', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Opens the page for the given relative URI or route.
+ *
+ * ``` php
+ * amOnPage('/');
+ * // opens /register page
+ * $I->amOnPage('/register');
+ * ```
+ *
+ * @param string $page the page URI
+ * @see \Codeception\Module\Yii2::amOnPage()
+ */
+ public function amOnPage(string $page): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Condition('amOnPage', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Gets a component from the Yii container. Throws an exception if the
+ * component is not available
+ *
+ * ```php
+ * grabComponent('mailer');
+ * ```
+ *
+ * @param $component
+ * @return mixed
+ * @throws \Codeception\Exception\ModuleException
+ * @deprecated in your tests you can use \Yii::$app directly.
+ * @see \Codeception\Module\Yii2::grabComponent()
+ */
+ public function grabComponent(mixed $component) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('grabComponent', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks that an email is sent.
+ *
+ * ```php
+ * seeEmailIsSent();
+ *
+ * // check that only 3 emails were sent
+ * $I->seeEmailIsSent(3);
+ * ```
+ *
+ * @param int $num
+ * @throws \Codeception\Exception\ModuleException
+ * @part email
+ * @see \Codeception\Module\Yii2::seeEmailIsSent()
+ */
+ public function seeEmailIsSent(?int $num = NULL): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeEmailIsSent', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that an email is sent.
+ *
+ * ```php
+ * seeEmailIsSent();
+ *
+ * // check that only 3 emails were sent
+ * $I->seeEmailIsSent(3);
+ * ```
+ *
+ * @param int $num
+ * @throws \Codeception\Exception\ModuleException
+ * @part email
+ * @see \Codeception\Module\Yii2::seeEmailIsSent()
+ */
+ public function canSeeEmailIsSent(?int $num = NULL): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeEmailIsSent', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks that no email was sent
+ *
+ * @part email
+ * @see \Codeception\Module\Yii2::dontSeeEmailIsSent()
+ */
+ public function dontSeeEmailIsSent(): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeEmailIsSent', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that no email was sent
+ *
+ * @part email
+ * @see \Codeception\Module\Yii2::dontSeeEmailIsSent()
+ */
+ public function cantSeeEmailIsSent(): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeEmailIsSent', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Returns array of all sent email messages.
+ * Each message implements the `yii\mail\MessageInterface` interface.
+ * Useful to perform additional checks using the `Asserts` module:
+ *
+ * ```php
+ * seeEmailIsSent();
+ * $messages = $I->grabSentEmails();
+ * $I->assertEquals('admin@site,com', $messages[0]->getTo());
+ * ```
+ *
+ * @part email
+ * @return array
+ * @throws \Codeception\Exception\ModuleException
+ * @see \Codeception\Module\Yii2::grabSentEmails()
+ */
+ public function grabSentEmails(): array {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('grabSentEmails', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Returns the last sent email:
+ *
+ * ```php
+ * seeEmailIsSent();
+ * $message = $I->grabLastSentEmail();
+ * $I->assertEquals('admin@site,com', $message->getTo());
+ * ```
+ * @part email
+ * @see \Codeception\Module\Yii2::grabLastSentEmail()
+ */
+ public function grabLastSentEmail(): object {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('grabLastSentEmail', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Returns a list of regex patterns for recognized domain names
+ *
+ * @return array
+ * @see \Codeception\Module\Yii2::getInternalDomains()
+ */
+ public function getInternalDomains(): array {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('getInternalDomains', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Sets a cookie and, if validation is enabled, signs it.
+ * @param string $name The name of the cookie
+ * @param string $val The value of the cookie
+ * @param array $params Additional cookie params like `domain`, `path`, `expires` and `secure`.
+ * @see \Codeception\Module\Yii2::setCookie()
+ */
+ public function setCookie($name, $val, $params = []) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('setCookie', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Creates the CSRF Cookie.
+ * @param string $val The value of the CSRF token
+ * @return string[] Returns an array containing the name of the CSRF param and the masked CSRF token.
+ * @see \Codeception\Module\Yii2::createAndSetCsrfCookie()
+ */
+ public function createAndSetCsrfCookie(string $val): array {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('createAndSetCsrfCookie', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Authenticates user for HTTP_AUTH
+ * @see \Codeception\Lib\InnerBrowser::amHttpAuthenticated()
+ */
+ public function amHttpAuthenticated(string $username, string $password): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Condition('amHttpAuthenticated', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Sets the HTTP header to the passed value - which is used on
+ * subsequent HTTP requests through PhpBrowser.
+ *
+ * Example:
+ * ```php
+ * haveHttpHeader('X-Requested-With', 'Codeception');
+ * $I->amOnPage('test-headers.php');
+ * ```
+ *
+ * To use special chars in Header Key use HTML Character Entities:
+ * Example:
+ * Header with underscore - 'Client_Id'
+ * should be represented as - 'Client_Id' or 'Client_Id'
+ *
+ * ```php
+ * haveHttpHeader('Client_Id', 'Codeception');
+ * ```
+ *
+ * @param string $name the name of the request header
+ * @param string $value the value to set it to for subsequent
+ * requests
+ * @see \Codeception\Lib\InnerBrowser::haveHttpHeader()
+ */
+ public function haveHttpHeader(string $name, string $value): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('haveHttpHeader', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Deletes the header with the passed name. Subsequent requests
+ * will not have the deleted header in its request.
+ *
+ * Example:
+ * ```php
+ * haveHttpHeader('X-Requested-With', 'Codeception');
+ * $I->amOnPage('test-headers.php');
+ * // ...
+ * $I->deleteHeader('X-Requested-With');
+ * $I->amOnPage('some-other-page.php');
+ * ```
+ *
+ * @param string $name the name of the header to delete.
+ * @see \Codeception\Lib\InnerBrowser::deleteHeader()
+ */
+ public function deleteHeader(string $name): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('deleteHeader', 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
+ * 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 string|array $link
+ * @see \Codeception\Lib\InnerBrowser::click()
+ */
+ public function click($link, $context = NULL): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('click', func_get_args()));
+ }
+
+
+ /**
+ * [!] 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.
+ *
+ * ``` 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('Sign Up', ['css' => 'body h1']); // with strict CSS locator
+ * ```
+ *
+ * Note that the search is done after stripping all HTML tags from the body,
+ * so `$I->see('strong')` will return true for strings like:
+ *
+ * - `
I am Stronger than thou
`
+ * - ``
+ *
+ * But will *not* be true for strings like:
+ *
+ * - `Home`
+ * - `
Home`
+ * - ``
+ *
+ * For checking the raw source code, use `seeInSource()`.
+ *
+ * @param array|string $selector optional
+ * @see \Codeception\Lib\InnerBrowser::see()
+ */
+ public function see(string $text, $selector = NULL): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Assertion('see', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * 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.
+ *
+ * ``` 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('Sign Up', ['css' => 'body h1']); // with strict CSS locator
+ * ```
+ *
+ * Note that the search is done after stripping all HTML tags from the body,
+ * so `$I->see('strong')` will return true for strings like:
+ *
+ * - `
I am Stronger than thou
`
+ * - ``
+ *
+ * But will *not* be true for strings like:
+ *
+ * - `Home`
+ * - `
Home`
+ * - ``
+ *
+ * For checking the raw source code, use `seeInSource()`.
+ *
+ * @param array|string $selector optional
+ * @see \Codeception\Lib\InnerBrowser::see()
+ */
+ public function canSee(string $text, $selector = NULL): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('see', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks that the current page doesn't contain the text specified (case insensitive).
+ * Give a locator as the second parameter to match a specific region.
+ *
+ * ```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('Sign Up', ['css' => 'body h1']); // with strict CSS locator
+ * ```
+ *
+ * Note that the search is done after stripping all HTML tags from the body,
+ * so `$I->dontSee('strong')` will fail on strings like:
+ *
+ * - `
Home`
+ * - ``
+ *
+ * For checking the raw source code, use `seeInSource()`.
+ *
+ * @param array|string $selector optional
+ * @see \Codeception\Lib\InnerBrowser::dontSee()
+ */
+ public function dontSee(string $text, $selector = NULL): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('dontSee', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that the current page doesn't contain the text specified (case insensitive).
+ * Give a locator as the second parameter to match a specific region.
+ *
+ * ```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('Sign Up', ['css' => 'body h1']); // with strict CSS locator
+ * ```
+ *
+ * Note that the search is done after stripping all HTML tags from the body,
+ * so `$I->dontSee('strong')` will fail on strings like:
+ *
+ * - `
Home`
+ * - ``
+ *
+ * For checking the raw source code, use `seeInSource()`.
+ *
+ * @param array|string $selector optional
+ * @see \Codeception\Lib\InnerBrowser::dontSee()
+ */
+ public function cantSee(string $text, $selector = NULL): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSee', 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
');
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::seeInSource()
+ */
+ public function seeInSource(string $raw): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInSource', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that the current page contains the given string in its
+ * raw source code.
+ *
+ * ``` php
+ * seeInSource('
Green eggs & ham
');
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::seeInSource()
+ */
+ public function canSeeInSource(string $raw): void {
+ $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
+ * dontSeeInSource('
Green eggs & ham
');
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::dontSeeInSource()
+ */
+ public function dontSeeInSource(string $raw): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeInSource', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that the current page contains the given string in its
+ * raw source code.
+ *
+ * ```php
+ * dontSeeInSource('
Green eggs & ham
');
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::dontSeeInSource()
+ */
+ public function cantSeeInSource(string $raw): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInSource', 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
+ * seeLink('Logout'); // matches Logout
+ * $I->seeLink('Logout','/logout'); // matches Logout
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::seeLink()
+ */
+ public function seeLink(string $text, ?string $url = NULL): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeLink', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * 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
+ * seeLink('Logout'); // matches Logout
+ * $I->seeLink('Logout','/logout'); // matches Logout
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::seeLink()
+ */
+ public function canSeeLink(string $text, ?string $url = NULL): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('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
+ * dontSeeLink('Logout'); // I suppose user is not logged in
+ * $I->dontSeeLink('Checkout now', '/store/cart.php');
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::dontSeeLink()
+ */
+ public function dontSeeLink(string $text, string $url = ""): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeLink', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * 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
+ * dontSeeLink('Logout'); // I suppose user is not logged in
+ * $I->dontSeeLink('Checkout now', '/store/cart.php');
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::dontSeeLink()
+ */
+ public function cantSeeLink(string $text, string $url = ""): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeLink', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks that current URI contains the given string.
+ *
+ * ``` php
+ * seeInCurrentUrl('home');
+ * // to match: /users/1
+ * $I->seeInCurrentUrl('/users/');
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::seeInCurrentUrl()
+ */
+ public function seeInCurrentUrl(string $uri): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInCurrentUrl', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that current URI contains the given string.
+ *
+ * ``` php
+ * seeInCurrentUrl('home');
+ * // to match: /users/1
+ * $I->seeInCurrentUrl('/users/');
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::seeInCurrentUrl()
+ */
+ public function canSeeInCurrentUrl(string $uri): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInCurrentUrl', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks that the current URI doesn't contain the given string.
+ *
+ * ``` php
+ * dontSeeInCurrentUrl('/users/');
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::dontSeeInCurrentUrl()
+ */
+ public function dontSeeInCurrentUrl(string $uri): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeInCurrentUrl', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that the current URI doesn't contain the given string.
+ *
+ * ``` php
+ * dontSeeInCurrentUrl('/users/');
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::dontSeeInCurrentUrl()
+ */
+ public function cantSeeInCurrentUrl(string $uri): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInCurrentUrl', 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
+ * seeCurrentUrlEquals('/');
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::seeCurrentUrlEquals()
+ */
+ public function seeCurrentUrlEquals(string $uri): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCurrentUrlEquals', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that the current URL is equal to the given string.
+ * Unlike `seeInCurrentUrl`, this only matches the full URL.
+ *
+ * ``` php
+ * seeCurrentUrlEquals('/');
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::seeCurrentUrlEquals()
+ */
+ public function canSeeCurrentUrlEquals(string $uri): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeCurrentUrlEquals', 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
+ * dontSeeCurrentUrlEquals('/');
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::dontSeeCurrentUrlEquals()
+ */
+ public function dontSeeCurrentUrlEquals(string $uri): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeCurrentUrlEquals', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that the current URL doesn't equal the given string.
+ * Unlike `dontSeeInCurrentUrl`, this only matches the full URL.
+ *
+ * ``` php
+ * dontSeeCurrentUrlEquals('/');
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::dontSeeCurrentUrlEquals()
+ */
+ public function cantSeeCurrentUrlEquals(string $uri): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeCurrentUrlEquals', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks that the current URL matches the given regular expression.
+ *
+ * ``` php
+ * seeCurrentUrlMatches('~^/users/(\d+)~');
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::seeCurrentUrlMatches()
+ */
+ public function seeCurrentUrlMatches(string $uri): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCurrentUrlMatches', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that the current URL matches the given regular expression.
+ *
+ * ``` php
+ * seeCurrentUrlMatches('~^/users/(\d+)~');
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::seeCurrentUrlMatches()
+ */
+ public function canSeeCurrentUrlMatches(string $uri): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeCurrentUrlMatches', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks that current url doesn't match the given regular expression.
+ *
+ * ``` php
+ * dontSeeCurrentUrlMatches('~^/users/(\d+)~');
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::dontSeeCurrentUrlMatches()
+ */
+ public function dontSeeCurrentUrlMatches(string $uri): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeCurrentUrlMatches', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that current url doesn't match the given regular expression.
+ *
+ * ``` php
+ * dontSeeCurrentUrlMatches('~^/users/(\d+)~');
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::dontSeeCurrentUrlMatches()
+ */
+ public function cantSeeCurrentUrlMatches(string $uri): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('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 capturing group.
+ * If no parameters are provided, the full URI is returned.
+ *
+ * ``` php
+ * grabFromCurrentUrl('~^/user/(\d+)/~');
+ * $uri = $I->grabFromCurrentUrl();
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::grabFromCurrentUrl()
+ */
+ public function grabFromCurrentUrl(?string $uri = NULL): mixed {
+ 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
+ * 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]');
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::seeCheckboxIsChecked()
+ */
+ public function seeCheckboxIsChecked($checkbox): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCheckboxIsChecked', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that the specified checkbox is checked.
+ *
+ * ``` php
+ * 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]');
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::seeCheckboxIsChecked()
+ */
+ public function canSeeCheckboxIsChecked($checkbox): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeCheckboxIsChecked', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Check that the specified checkbox is unchecked.
+ *
+ * ``` php
+ * 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.
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::dontSeeCheckboxIsChecked()
+ */
+ public function dontSeeCheckboxIsChecked($checkbox): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeCheckboxIsChecked', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Check that the specified checkbox is unchecked.
+ *
+ * ``` php
+ * 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.
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::dontSeeCheckboxIsChecked()
+ */
+ public function cantSeeCheckboxIsChecked($checkbox): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeCheckboxIsChecked', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks that the given input field or textarea *equals* (i.e. not just contains) the given value.
+ * Fields are matched by label text, the "name" attribute, CSS, or XPath.
+ *
+ * ``` php
+ * 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 string|array $field
+ * @see \Codeception\Lib\InnerBrowser::seeInField()
+ */
+ public function seeInField($field, $value): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInField', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that the given input field or textarea *equals* (i.e. not just contains) the given value.
+ * Fields are matched by label text, the "name" attribute, CSS, or XPath.
+ *
+ * ``` php
+ * 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 string|array $field
+ * @see \Codeception\Lib\InnerBrowser::seeInField()
+ */
+ public function canSeeInField($field, $value): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('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
+ * 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 string|array $field
+ * @see \Codeception\Lib\InnerBrowser::dontSeeInField()
+ */
+ public function dontSeeInField($field, $value): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeInField', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * 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
+ * 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 string|array $field
+ * @see \Codeception\Lib\InnerBrowser::dontSeeInField()
+ */
+ public function cantSeeInField($field, $value): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('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
+ * 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
+ * seeInFormFields('.form-class', [
+ * 'multiselect' => [
+ * 'value1',
+ * 'value2',
+ * ],
+ * 'checkbox[]' => [
+ * 'a checked value',
+ * 'another checked value',
+ * ],
+ * ]);
+ * ```
+ *
+ * Additionally, checkbox values can be checked with a boolean.
+ *
+ * ``` php
+ * seeInFormFields('#form-id', [
+ * 'checkbox1' => true, // passes if checked
+ * 'checkbox2' => false, // passes if unchecked
+ * ]);
+ * ```
+ *
+ * Pair this with submitForm for quick testing magic.
+ *
+ * ``` php
+ * 'value',
+ * 'field2' => 'another value',
+ * 'checkbox1' => true,
+ * // ...
+ * ];
+ * $I->submitForm('//form[@id=my-form]', string $form, 'submitButton');
+ * // $I->amOnPage('/path/to/form-page') may be needed
+ * $I->seeInFormFields('//form[@id=my-form]', string $form);
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::seeInFormFields()
+ */
+ public function seeInFormFields($formSelector, array $params): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInFormFields', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks if the array of form parameters (name => value) are set on the form matched with the
+ * passed selector.
+ *
+ * ``` php
+ * 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
+ * seeInFormFields('.form-class', [
+ * 'multiselect' => [
+ * 'value1',
+ * 'value2',
+ * ],
+ * 'checkbox[]' => [
+ * 'a checked value',
+ * 'another checked value',
+ * ],
+ * ]);
+ * ```
+ *
+ * Additionally, checkbox values can be checked with a boolean.
+ *
+ * ``` php
+ * seeInFormFields('#form-id', [
+ * 'checkbox1' => true, // passes if checked
+ * 'checkbox2' => false, // passes if unchecked
+ * ]);
+ * ```
+ *
+ * Pair this with submitForm for quick testing magic.
+ *
+ * ``` php
+ * 'value',
+ * 'field2' => 'another value',
+ * 'checkbox1' => true,
+ * // ...
+ * ];
+ * $I->submitForm('//form[@id=my-form]', string $form, 'submitButton');
+ * // $I->amOnPage('/path/to/form-page') may be needed
+ * $I->seeInFormFields('//form[@id=my-form]', string $form);
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::seeInFormFields()
+ */
+ public function canSeeInFormFields($formSelector, array $params): void {
+ $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 not set on the form matched with
+ * the passed selector.
+ *
+ * ``` php
+ * 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
+ * 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
+ * dontSeeInFormFields('#form-id', [
+ * 'checkbox1' => true, // fails if checked
+ * 'checkbox2' => false, // fails if unchecked
+ * ]);
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::dontSeeInFormFields()
+ */
+ public function dontSeeInFormFields($formSelector, array $params): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeInFormFields', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks if the array of form parameters (name => value) are not set on the form matched with
+ * the passed selector.
+ *
+ * ``` php
+ * 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
+ * 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
+ * dontSeeInFormFields('#form-id', [
+ * 'checkbox1' => true, // fails if checked
+ * 'checkbox2' => false, // fails if unchecked
+ * ]);
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::dontSeeInFormFields()
+ */
+ public function cantSeeInFormFields($formSelector, array $params): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInFormFields', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Submits the given form on the page, with the given form
+ * values. Pass the form field's values as an array in the second
+ * parameter.
+ *
+ * Although this function can be used as a short-hand version of
+ * `fillField()`, `selectOption()`, `click()` etc. it has some important
+ * differences:
+ *
+ * * Only field *names* may be used, not CSS/XPath selectors nor field labels
+ * * If a field is sent to this function that does *not* exist on the page,
+ * it will silently be added to the HTTP request. This is helpful for testing
+ * some types of forms, but be aware that you will *not* get an exception
+ * like you would if you called `fillField()` or `selectOption()` with
+ * a missing field.
+ *
+ * Fields that are not provided will be filled by their values from the page,
+ * or from any previous calls to `fillField()`, `selectOption()` etc.
+ * You don't need to click the 'Submit' button afterwards.
+ * This command itself triggers the request to form's action.
+ *
+ * You can optionally specify which button's value to include
+ * in the request with the last parameter (as an alternative to
+ * explicitly setting its value in the second parameter), as
+ * button values are not otherwise included in the request.
+ *
+ * Examples:
+ *
+ * ``` php
+ * submitForm('#login', [
+ * 'login' => 'davert',
+ * 'password' => '123456'
+ * ]);
+ * // or
+ * $I->submitForm('#login', [
+ * 'login' => 'davert',
+ * 'password' => '123456'
+ * ], 'submitButtonName');
+ *
+ * ```
+ *
+ * For example, given this sample "Sign Up" form:
+ *
+ * ``` html
+ *
+ * ```
+ *
+ * You could write the following to submit it:
+ *
+ * ``` php
+ * submitForm(
+ * '#userForm',
+ * [
+ * 'user' => [
+ * 'login' => 'Davert',
+ * 'password' => '123456',
+ * 'agree' => true
+ * ]
+ * ],
+ * 'submitButton'
+ * );
+ * ```
+ * Note that "2" will be the submitted value for the "plan" field, as it is
+ * the selected option.
+ *
+ * To uncheck the pre-checked checkbox "newsletter", call `$I->uncheckOption(['name' => 'user[newsletter]']);` *before*,
+ * then submit the form as shown here (i.e. without the "newsletter" field in the `$params` array).
+ *
+ * You can also emulate a JavaScript submission by not specifying any
+ * buttons in the third parameter to submitForm.
+ *
+ * ```php
+ * submitForm(
+ * '#userForm',
+ * [
+ * 'user' => [
+ * 'login' => 'Davert',
+ * 'password' => '123456',
+ * 'agree' => true
+ * ]
+ * ]
+ * );
+ * ```
+ *
+ * This function works well when paired with `seeInFormFields()`
+ * for quickly testing CRUD interfaces and form validation logic.
+ *
+ * ``` php
+ * 'value',
+ * 'field2' => 'another value',
+ * 'checkbox1' => true,
+ * // ...
+ * ];
+ * $I->submitForm('#my-form', $form, 'submitButton');
+ * // $I->amOnPage('/path/to/form-page') may be needed
+ * $I->seeInFormFields('#my-form', $form);
+ * ```
+ *
+ * Parameter values can be set to arrays for multiple input fields
+ * of the same name, or multi-select combo boxes. For checkboxes,
+ * you can use either the string value or boolean `true`/`false` which will
+ * be replaced by the checkbox's value in the DOM.
+ *
+ * ``` php
+ * 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
+ * submitForm('#my-form', [
+ * 'field[]' => 'value',
+ * 'field[]' => 'another value', // 'field[]' is already a defined key
+ * ]);
+ * ```
+ *
+ * The solution is to pass an array value:
+ *
+ * ```php
+ * submitForm('#my-form', [
+ * 'field' => [
+ * 'value',
+ * 'another value',
+ * ]
+ * ]);
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::submitForm()
+ */
+ public function submitForm($selector, array $params, ?string $button = NULL): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('submitForm', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Fills a text field or textarea with the given string.
+ *
+ * ``` php
+ * fillField("//input[@type='text']", "Hello World!");
+ * $I->fillField(['name' => 'email'], 'jon@example.com');
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::fillField()
+ */
+ public function fillField($field, $value): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('fillField', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Selects an option in a select tag or in radio button group.
+ *
+ * ``` php
+ * 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
+ * selectOption('Which OS do you use?', array('Windows','Linux'));
+ * ```
+ *
+ * Or provide an associative array for the second argument to specifically define which selection method should be used:
+ *
+ * ``` php
+ * selectOption('Which OS do you use?', array('text' => 'Windows')); // Only search by text 'Windows'
+ * $I->selectOption('Which OS do you use?', array('value' => 'windows')); // Only search by value 'windows'
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::selectOption()
+ */
+ public function selectOption($select, $option): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('selectOption', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Ticks a checkbox. For radio buttons, use the `selectOption` method instead.
+ *
+ * ``` php
+ * checkOption('#agree');
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::checkOption()
+ */
+ public function checkOption($option): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('checkOption', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Unticks a checkbox.
+ *
+ * ``` php
+ * uncheckOption('#notify');
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::uncheckOption()
+ */
+ public function uncheckOption($option): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('uncheckOption', 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
+ * attachFile('input[@type="file"]', 'prices.xls');
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::attachFile()
+ */
+ public function attachFile($field, string $filename): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('attachFile', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Sends an ajax GET request with the passed parameters.
+ * See `sendAjaxPostRequest()`
+ * @see \Codeception\Lib\InnerBrowser::sendAjaxGetRequest()
+ */
+ public function sendAjaxGetRequest(string $uri, array $params = []): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('sendAjaxGetRequest', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Sends an ajax POST request with the passed parameters.
+ * The appropriate HTTP header is added automatically:
+ * `X-Requested-With: XMLHttpRequest`
+ * Example:
+ * ``` php
+ * sendAjaxPostRequest('/add-task', ['task' => 'lorem ipsum']);
+ * ```
+ * Some frameworks (e.g. Symfony) create field names in the form of an "array":
+ * ``
+ * In this case you need to pass the fields like this:
+ * ``` php
+ * sendAjaxPostRequest('/add-task', ['form' => [
+ * 'task' => 'lorem ipsum',
+ * 'category' => 'miscellaneous',
+ * ]]);
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::sendAjaxPostRequest()
+ */
+ public function sendAjaxPostRequest(string $uri, array $params = []): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('sendAjaxPostRequest', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Sends an ajax request, using the passed HTTP method.
+ * See `sendAjaxPostRequest()`
+ * Example:
+ * ``` php
+ * sendAjaxRequest('PUT', '/posts/7', ['title' => 'new title']);
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::sendAjaxRequest()
+ */
+ public function sendAjaxRequest(string $method, string $uri, array $params = []): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('sendAjaxRequest', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Use this method within an [interactive pause](https://codeception.com/docs/02-GettingStarted#Interactive-Pause) to save the HTML source code of the current page.
+ *
+ * ```php
+ * makeHtmlSnapshot('edit_page');
+ * // saved to: tests/_output/debug/edit_page.html
+ * $I->makeHtmlSnapshot();
+ * // saved to: tests/_output/debug/2017-05-26_14-24-11_4b3403665fea6.html
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::makeHtmlSnapshot()
+ */
+ public function makeHtmlSnapshot(?string $name = NULL): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('makeHtmlSnapshot', 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
+ * grabTextFrom('h1');
+ * $heading = $I->grabTextFrom('descendant-or-self::h1');
+ * $value = $I->grabTextFrom('~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
+ * grabAttributeFrom('#tooltip', 'title');
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::grabAttributeFrom()
+ */
+ public function grabAttributeFrom($cssOrXpath, string $attribute): mixed {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('grabAttributeFrom', func_get_args()));
+ }
+
+
+ /**
+ * [!] 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');
+ * ```
+ *
+ * @return string[]
+ * @see \Codeception\Lib\InnerBrowser::grabMultiple()
+ */
+ public function grabMultiple($cssOrXpath, ?string $attribute = NULL): array {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('grabMultiple', 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
+ * grabValueFrom('Name');
+ * $name = $I->grabValueFrom('input[name=username]');
+ * $name = $I->grabValueFrom('descendant-or-self::form/descendant::input[@name = 'username']');
+ * $name = $I->grabValueFrom(['name' => 'username']);
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::grabValueFrom()
+ */
+ public function grabValueFrom($field): mixed {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('grabValueFrom', 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.
+ * If the cookie is set by an ajax request (XMLHttpRequest), there might be some delay caused by the browser, so try `$I->wait(0.1)`.
+ * @see \Codeception\Lib\InnerBrowser::grabCookie()
+ */
+ public function grabCookie(string $cookie, array $params = []): mixed {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('grabCookie', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Grabs current page source code.
+ *
+ * @throws ModuleException if no page was opened.
+ * @return string Current page source code.
+ * @see \Codeception\Lib\InnerBrowser::grabPageSource()
+ */
+ public function grabPageSource(): string {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('grabPageSource', 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
+ * seeCookie('PHPSESSID');
+ * ```
+ *
+ * @return mixed|void
+ * @see \Codeception\Lib\InnerBrowser::seeCookie()
+ */
+ public function seeCookie($cookie, $params = []) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCookie', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * 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
+ * seeCookie('PHPSESSID');
+ * ```
+ *
+ * @return mixed|void
+ * @see \Codeception\Lib\InnerBrowser::seeCookie()
+ */
+ public function canSeeCookie($cookie, $params = []) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('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.
+ *
+ * @return mixed|void
+ * @see \Codeception\Lib\InnerBrowser::dontSeeCookie()
+ */
+ public function dontSeeCookie($cookie, $params = []) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeCookie', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * 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.
+ *
+ * @return mixed|void
+ * @see \Codeception\Lib\InnerBrowser::dontSeeCookie()
+ */
+ public function cantSeeCookie($cookie, $params = []) {
+ return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeCookie', 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.
+ *
+ * @return mixed|void
+ * @see \Codeception\Lib\InnerBrowser::resetCookie()
+ */
+ public function resetCookie($cookie, $params = []) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('resetCookie', 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
+ * 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']);
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::seeElement()
+ */
+ public function seeElement($selector, array $attributes = []): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeElement', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that the given element exists on the page and is visible.
+ * You can also specify expected attributes of this element.
+ *
+ * ``` php
+ * 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']);
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::seeElement()
+ */
+ public function canSeeElement($selector, array $attributes = []): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('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
+ * dontSeeElement('.error');
+ * $I->dontSeeElement('//form/input[1]');
+ * $I->dontSeeElement('input', ['name' => 'login']);
+ * $I->dontSeeElement('input', ['value' => '123456']);
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::dontSeeElement()
+ */
+ public function dontSeeElement($selector, array $attributes = []): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeElement', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that the given element is invisible or not present on the page.
+ * You can also specify expected attributes of this element.
+ *
+ * ``` php
+ * dontSeeElement('.error');
+ * $I->dontSeeElement('//form/input[1]');
+ * $I->dontSeeElement('input', ['name' => 'login']);
+ * $I->dontSeeElement('input', ['value' => '123456']);
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::dontSeeElement()
+ */
+ public function cantSeeElement($selector, array $attributes = []): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeElement', 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
+ * seeNumberOfElements('tr', 10);
+ * $I->seeNumberOfElements('tr', [0,10]); // between 0 and 10 elements
+ * ```
+ *
+ * @param int|int[] $expected
+ * @see \Codeception\Lib\InnerBrowser::seeNumberOfElements()
+ */
+ public function seeNumberOfElements($selector, $expected): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeNumberOfElements', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that there are a certain number of elements matched by the given locator on the page.
+ *
+ * ``` php
+ * seeNumberOfElements('tr', 10);
+ * $I->seeNumberOfElements('tr', [0,10]); // between 0 and 10 elements
+ * ```
+ *
+ * @param int|int[] $expected
+ * @see \Codeception\Lib\InnerBrowser::seeNumberOfElements()
+ */
+ public function canSeeNumberOfElements($selector, $expected): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeNumberOfElements', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks that the given option is selected.
+ *
+ * ``` php
+ * seeOptionIsSelected('#form input[name=payment]', 'Visa');
+ * ```
+ *
+ * @return mixed|void
+ * @see \Codeception\Lib\InnerBrowser::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.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that the given option is selected.
+ *
+ * ``` php
+ * seeOptionIsSelected('#form input[name=payment]', 'Visa');
+ * ```
+ *
+ * @return mixed|void
+ * @see \Codeception\Lib\InnerBrowser::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 not selected.
+ *
+ * ``` php
+ * dontSeeOptionIsSelected('#form input[name=payment]', 'Visa');
+ * ```
+ *
+ * @return mixed|void
+ * @see \Codeception\Lib\InnerBrowser::dontSeeOptionIsSelected()
+ */
+ public function dontSeeOptionIsSelected($selector, $optionText) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeOptionIsSelected', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that the given option is not selected.
+ *
+ * ``` php
+ * dontSeeOptionIsSelected('#form input[name=payment]', 'Visa');
+ * ```
+ *
+ * @return mixed|void
+ * @see \Codeception\Lib\InnerBrowser::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.
+ *
+ * Asserts that current page has 404 response status code.
+ * @see \Codeception\Lib\InnerBrowser::seePageNotFound()
+ */
+ public function seePageNotFound(): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Assertion('seePageNotFound', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Asserts that current page has 404 response status code.
+ * @see \Codeception\Lib\InnerBrowser::seePageNotFound()
+ */
+ public function canSeePageNotFound(): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seePageNotFound', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks that response code is equal to value provided.
+ *
+ * ```php
+ * seeResponseCodeIs(200);
+ *
+ * // recommended \Codeception\Util\HttpCode
+ * $I->seeResponseCodeIs(\Codeception\Util\HttpCode::OK);
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::seeResponseCodeIs()
+ */
+ public function seeResponseCodeIs(int $code): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeResponseCodeIs', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that response code is equal to value provided.
+ *
+ * ```php
+ * seeResponseCodeIs(200);
+ *
+ * // recommended \Codeception\Util\HttpCode
+ * $I->seeResponseCodeIs(\Codeception\Util\HttpCode::OK);
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::seeResponseCodeIs()
+ */
+ public function canSeeResponseCodeIs(int $code): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeResponseCodeIs', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks that response code is between a certain range. Between actually means [from <= CODE <= to]
+ * @see \Codeception\Lib\InnerBrowser::seeResponseCodeIsBetween()
+ */
+ public function seeResponseCodeIsBetween(int $from, int $to): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeResponseCodeIsBetween', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that response code is between a certain range. Between actually means [from <= CODE <= to]
+ * @see \Codeception\Lib\InnerBrowser::seeResponseCodeIsBetween()
+ */
+ public function canSeeResponseCodeIsBetween(int $from, int $to): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeResponseCodeIsBetween', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks that response code is equal to value provided.
+ *
+ * ```php
+ * dontSeeResponseCodeIs(200);
+ *
+ * // recommended \Codeception\Util\HttpCode
+ * $I->dontSeeResponseCodeIs(\Codeception\Util\HttpCode::OK);
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::dontSeeResponseCodeIs()
+ */
+ public function dontSeeResponseCodeIs(int $code): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeResponseCodeIs', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that response code is equal to value provided.
+ *
+ * ```php
+ * dontSeeResponseCodeIs(200);
+ *
+ * // recommended \Codeception\Util\HttpCode
+ * $I->dontSeeResponseCodeIs(\Codeception\Util\HttpCode::OK);
+ * ```
+ * @see \Codeception\Lib\InnerBrowser::dontSeeResponseCodeIs()
+ */
+ public function cantSeeResponseCodeIs(int $code): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeResponseCodeIs', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks that the response code 2xx
+ * @see \Codeception\Lib\InnerBrowser::seeResponseCodeIsSuccessful()
+ */
+ public function seeResponseCodeIsSuccessful(): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeResponseCodeIsSuccessful', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that the response code 2xx
+ * @see \Codeception\Lib\InnerBrowser::seeResponseCodeIsSuccessful()
+ */
+ public function canSeeResponseCodeIsSuccessful(): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeResponseCodeIsSuccessful', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks that the response code 3xx
+ * @see \Codeception\Lib\InnerBrowser::seeResponseCodeIsRedirection()
+ */
+ public function seeResponseCodeIsRedirection(): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeResponseCodeIsRedirection', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that the response code 3xx
+ * @see \Codeception\Lib\InnerBrowser::seeResponseCodeIsRedirection()
+ */
+ public function canSeeResponseCodeIsRedirection(): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeResponseCodeIsRedirection', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks that the response code is 4xx
+ * @see \Codeception\Lib\InnerBrowser::seeResponseCodeIsClientError()
+ */
+ public function seeResponseCodeIsClientError(): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeResponseCodeIsClientError', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that the response code is 4xx
+ * @see \Codeception\Lib\InnerBrowser::seeResponseCodeIsClientError()
+ */
+ public function canSeeResponseCodeIsClientError(): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeResponseCodeIsClientError', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks that the response code is 5xx
+ * @see \Codeception\Lib\InnerBrowser::seeResponseCodeIsServerError()
+ */
+ public function seeResponseCodeIsServerError(): void {
+ $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeResponseCodeIsServerError', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that the response code is 5xx
+ * @see \Codeception\Lib\InnerBrowser::seeResponseCodeIsServerError()
+ */
+ public function canSeeResponseCodeIsServerError(): void {
+ $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeResponseCodeIsServerError', func_get_args()));
+ }
+
+
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * Checks that the page title contains the given string.
+ *
+ * ``` php
+ * seeInTitle('Blog - Post #1');
+ * ```
+ *
+ * @return mixed|void
+ * @see \Codeception\Lib\InnerBrowser::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.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that the page title contains the given string.
+ *
+ * ``` php
+ * seeInTitle('Blog - Post #1');
+ * ```
+ *
+ * @return mixed|void
+ * @see \Codeception\Lib\InnerBrowser::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 does not contain the given string.
+ *
+ * @return mixed|void
+ * @see \Codeception\Lib\InnerBrowser::dontSeeInTitle()
+ */
+ public function dontSeeInTitle($title) {
+ return $this->getScenario()->runStep(new \Codeception\Step\Action('dontSeeInTitle', func_get_args()));
+ }
+ /**
+ * [!] Method is generated. Documentation taken from corresponding module.
+ *
+ * [!] Conditional Assertion: Test won't be stopped on fail
+ * Checks that the page title does not contain the given string.
+ *
+ * @return mixed|void
+ * @see \Codeception\Lib\InnerBrowser::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.
+ *
+ * Switch to iframe or frame on the page.
+ *
+ * Example:
+ * ``` html
+ *