├── .github
    └── ISSUE_TEMPLATE
    │   ├── bug_report.md
    │   └── feature_request.md
├── .gitignore
├── .travis.yml
├── LICENSE.md
├── README.md
├── composer.json
├── composer.lock
├── src
    ├── Firebase.php
    ├── web
    │   └── Application.php
    └── yii2
    │   ├── BaseYii.php
    │   └── Yii.php
└── tests
    ├── codeception.yml
    ├── tests
        ├── FirebaseTest.php
        ├── _bootstrap.php
        ├── _data
        │   └── .gitkeep
        ├── _output
        │   └── .gitkeep
        ├── _support
        │   ├── AcceptanceTester.php
        │   ├── FunctionalTester.php
        │   ├── Helper
        │   │   ├── Acceptance.php
        │   │   ├── Functional.php
        │   │   └── Unit.php
        │   ├── UnitTester.php
        │   └── _generated
        │   │   ├── AcceptanceTesterActions.php
        │   │   ├── FunctionalTesterActions.php
        │   │   └── UnitTesterActions.php
        ├── acceptance.suite.yml
        ├── acceptance
        │   └── _bootstrap.php
        ├── config
        │   ├── config-local.php
        │   ├── config.php
        │   └── web.php
        ├── functional.suite.yml
        ├── functional
        │   └── _bootstrap.php
        ├── unit.suite.yml
        └── unit
        │   ├── FirebaseDatabaseTest.php
        │   └── _bootstrap.php
    └── web
        ├── assets
            └── .gitignore
        └── index-test.php


/.github/ISSUE_TEMPLATE/bug_report.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Bug report
 3 | about: Create a report to help us improve
 4 | 
 5 | ---
 6 | 
 7 | **Describe the bug**
 8 | A clear and concise description of what the bug is.
 9 | 
10 | **To Reproduce**
11 | Steps to reproduce the behavior:
12 | 1. Go to '...'
13 | 2. Click on '....'
14 | 3. Scroll down to '....'
15 | 4. See error
16 | 
17 | **Expected behavior**
18 | A clear and concise description of what you expected to happen.
19 | 
20 | **Screenshots**
21 | If applicable, add screenshots to help explain your problem.
22 | 
23 | **Desktop (please complete the following information):**
24 |  - OS: [e.g. iOS]
25 |  - Browser [e.g. chrome, safari]
26 |  - Version [e.g. 22]
27 | 
28 | **Smartphone (please complete the following information):**
29 |  - Device: [e.g. iPhone6]
30 |  - OS: [e.g. iOS8.1]
31 |  - Browser [e.g. stock browser, safari]
32 |  - Version [e.g. 22]
33 | 
34 | **Additional context**
35 | Add any other context about the problem here.
36 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/feature_request.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Feature request
 3 | about: Suggest an idea for this project
 4 | 
 5 | ---
 6 | 
 7 | **Is your feature request related to a problem? Please describe.**
 8 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
 9 | 
10 | **Describe the solution you'd like**
11 | A clear and concise description of what you want to happen.
12 | 
13 | **Describe alternatives you've considered**
14 | A clear and concise description of any alternative solutions or features you've considered.
15 | 
16 | **Additional context**
17 | Add any other context or screenshots about the feature request here.
18 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | /vendor/
2 | .idea


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
 1 | language: php
 2 | php:
 3 |   - '7.0'
 4 | 
 5 | # faster builds on new travis setup not using sudo
 6 | sudo: false
 7 | 
 8 | # cache composer cache
 9 | cache:
10 |   directories:
11 |     - $HOME/.composer/cache
12 | 
13 | install:
14 |   - travis_retry composer self-update && composer --version
15 |   - travis_retry composer global require "fxp/composer-asset-plugin:^1.3.1"
16 |   - export PATH="$HOME/.composer/vendor/bin:$PATH"
17 |   - travis_retry composer install --dev --prefer-dist --no-interaction
18 | # codeception
19 |   - travis_retry composer global require "codeception/codeception=2.0.*" "codeception/specify=*" "codeception/verify=*"
20 | # setup application:
21 |   - |
22 |     cd tests
23 |     codecept build
24 |     cd ..
25 | 
26 | script:
27 |   - |
28 |     cd tests
29 |     codecept run


--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2016 Jérôme Gamez, https://github.com/jeromegamez <jerome@gamez.name>
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # yii2-firebase
 2 | 
 3 | [![Latest Stable Version](https://poser.pugx.org/grptx/yii2-firebase/v/stable)](https://packagist.org/packages/grptx/yii2-firebase)
 4 | [![Total Downloads](https://poser.pugx.org/grptx/yii2-firebase/downloads)](https://packagist.org/packages/grptx/yii2-firebase)
 5 | [![Latest Unstable Version](https://poser.pugx.org/grptx/yii2-firebase/v/unstable)](https://packagist.org/packages/grptx/yii2-firebase)
 6 | [![License](https://poser.pugx.org/grptx/yii2-firebase/license)](https://packagist.org/packages/grptx/yii2-firebase)
 7 | 
 8 | This Yii2 component wraps [kreait/firebase-php](https://github.com/kreait/firebase-php/) and allow to easy connect to the Firebase realtime database 
 9 | 
10 | ## Installation
11 | 
12 | Preferred way to install is through [Composer](https://getcomposer.org): 
13 | ```shell
14 | php composer.phar require grptx/yii2-firebase:~0.3.1
15 | ```
16 | Or, you may add
17 | 
18 | ```php
19 | "grptx/yii2-firebase": "~0.3.1"
20 | ```
21 | 
22 | to the require section of your `composer.json` file and execute `php composer.phar update`.
23 | 
24 | ## Configuration
25 | 
26 | ```php
27 | ...
28 | 'components' => [
29 |     'firebase' => [
30 |         'class'=>'grptx\Firebase\Firebase',
31 |         'credential_file'=>'service_account.json', // (see https://firebase.google.com/docs/admin/setup#add_firebase_to_your_app)
32 |         'database_uri'=>'https://my-project.firebaseio.com', // (optional)
33 |     ]
34 | ...
35 | ]
36 | ```
37 | 
38 | ### Optional
39 | to use the autocomplete function of IDE (i.e. Phpstorm) you can optionally replace in the web/index.php the inclusion of Yii.php file and the Application instance:
40 | 
41 | replace:
42 | ```php
43 | require(__DIR__ . '/../../vendor/yiisoft/yii2/Yii.php');
44 | //and 
45 | (new yii\web\Application($config))->run();
46 | ```
47 | with:
48 | ```php
49 | require (__DIR__.'/../../vendor/grptx/yii2-firebase/src/yii2/Yii.php');
50 | //and
51 | (new \grptx\Firebase\web\Application($config))->run();
52 | 
53 | ```
54 | now when you need you can use grptx\Firebase\yii2\Yii instead of Yii to use autocomplete of your IDE
55 | 
56 | ## Usage
57 | 
58 | Retrive a _database_ ,_reference_ and a _value_
59 | ```php
60 | $database = Yii::$app->firebase->getDatabase();
61 | $reference = $database->getReference('path/to/child/location');
62 | $value = $reference->getValue();
63 | ```
64 | 
65 | or just the _reference_ and a _value_
66 | 
67 | ```php
68 | $reference = Yii::$app->firebase->getReference('path/to/child/location');
69 | $value = $reference->getValue();
70 | ```
71 | 
72 | for other method see [firebase-php.readthedocs.io.](https://firebase-php.readthedocs.io/en/latest/realtime-database.html)


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "grptx/yii2-firebase",
 3 |   "type": "yii2-extension",
 4 |   "authors": [
 5 |     {
 6 |       "name": "grptx",
 7 |       "email": "r.rossetti@melogra.no"
 8 |     }
 9 |   ],
10 |   "license": "MIT",
11 |   "keywords": [
12 |     "yii2",
13 |     "yii2-components",
14 |     "firebase",
15 |     "php7"
16 |   ],
17 |   "description": "Yii2 Component to connect to Firebase Database",
18 |   "require": {
19 |     "yiisoft/yii2": "^2",
20 |     "kreait/firebase-php": "^4.0"
21 |   },
22 |   "require-dev": {
23 |     "codeception/codeception": "*",
24 |     "codeception/specify": "*",
25 |     "codeception/verify": "*",
26 |     "yiisoft/yii2-faker":"*"
27 |   },
28 |   "minimum-stability": "dev",
29 |   "autoload": {
30 |     "psr-4": {
31 |       "grptx\\Firebase\\": "src",
32 |       "grptx\\tests\\":"tests/tests"
33 |     }
34 |   }
35 | }
36 | 


--------------------------------------------------------------------------------
/src/Firebase.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace grptx\Firebase;
  4 | 
  5 | use Kreait\Firebase\Database;
  6 | use Kreait\Firebase\Database\Reference;
  7 | use Kreait\Firebase\Factory;
  8 | use Kreait\Firebase\ServiceAccount;
  9 | use Kreait\Firebase\Exception\ServiceAccountDiscoveryFailed;
 10 | use yii\base\Component;
 11 | 
 12 | class Firebase extends Component
 13 | {
 14 |     /**
 15 |      * @var string
 16 |      */
 17 |     public $credential_file;
 18 |     /**
 19 |      * @var string
 20 |      */
 21 |     public $database_uri = false;
 22 |     /**
 23 |      * @var ServiceAccount
 24 |      */
 25 |     private $_serviceAccount;
 26 |     /**
 27 |      * @var \Kreait\Firebase
 28 |      */
 29 |     private $_firebase;
 30 |     /**
 31 |      * @var Database
 32 |      */
 33 |     private $_database;
 34 | 
 35 |     /**
 36 |      * @return ServiceAccount
 37 |      */
 38 |     public function getServiceAccount(): ServiceAccount
 39 |     {
 40 |         if (!$this->_serviceAccount) {
 41 |             try {
 42 |                 if (!$this->credential_file) {
 43 |                     $this->_serviceAccount = ServiceAccount::discover();
 44 |                 } else {
 45 |                     $this->_serviceAccount = ServiceAccount::fromJsonFile($this->credential_file);
 46 |                 }
 47 |             } catch (ServiceAccountDiscoveryFailed $e) {
 48 |                 $this->_serviceAccount = null;
 49 |             }
 50 | 
 51 |         }
 52 |         return $this->_serviceAccount;
 53 |     }
 54 | 
 55 |     /**
 56 |      * @return string
 57 |      */
 58 |     public function getDataBaseUri(): string
 59 |     {
 60 |         return $this->database_uri;
 61 |     }
 62 | 
 63 |     /**
 64 |      * @return \Kreait\Firebase
 65 |      */
 66 |     public function getFirebase(): \Kreait\Firebase
 67 |     {
 68 |         if (!$this->_firebase) {
 69 |             if ($this->getServiceAccount()) {
 70 |                 $factory = (new Factory)->withServiceAccount($this->getServiceAccount());
 71 |                 if ($this->getDataBaseUri()) {
 72 |                     $this->_firebase = $factory->withDatabaseUri($this->getDataBaseUri())->create();
 73 |                 } else {
 74 |                     $this->_firebase = (new Factory)->withServiceAccount($this->getServiceAccount())->create();
 75 |                 }
 76 |             } else if ($this->getDataBaseUri()) {
 77 |                 $this->_firebase = (new Factory)->withDatabaseUri($this->getDataBaseUri())->create();
 78 |             } else {
 79 |                 throw new ServiceAccountDiscoveryFailed("cannot retrieve Firebase istance");
 80 |             }
 81 |         }
 82 |         return $this->_firebase;
 83 |     }
 84 | 
 85 |     /**
 86 |      * @return Database
 87 |      */
 88 |     public function getDatabase(): Database
 89 |     {
 90 |         if (!$this->_database) {
 91 |             if ($this->getFirebase()) {
 92 |                 $this->_database = $this->getFirebase()->getDatabase();
 93 |             }
 94 |         }
 95 |         return $this->_database;
 96 |     }
 97 | 
 98 |     /**
 99 |      * @param string $path
100 |      * @return Reference
101 |      */
102 |     public function getReference(string $path = ''): Reference
103 |     {
104 |         return $this->getDatabase()->getReference($path);
105 |     }
106 | 
107 |     /**
108 |      * @param $uri
109 |      * @return Reference
110 |      */
111 |     public function getReferenceFromUrl($uri): Reference
112 |     {
113 |         return $this->getDatabase()->getReferenceFromUrl($uri);
114 |     }
115 | 
116 | }


--------------------------------------------------------------------------------
/src/web/Application.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace grptx\Firebase\web;
 4 | 
 5 | use grptx\Firebase\Firebase;
 6 | 
 7 | /**
 8 |  * Class Application
 9 |  * @package grptx\Firebase\web
10 |  * @property Firebase $firebase
11 |  */
12 | class Application extends \yii\web\Application {
13 | 
14 | }


--------------------------------------------------------------------------------
/src/yii2/BaseYii.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: gx
 5 |  * Date: 25/07/17
 6 |  * Time: 11.10
 7 |  */
 8 | 
 9 | namespace grptx\Firebase\yii2;
10 | 
11 | 
12 | use grptx\Firebase\web\Application;
13 | 
14 | class BaseYii extends \yii\BaseYii {
15 | 	/**
16 | 	 * @var Application \yii\console\Application|grptx\Firebase\web\Application the application instance
17 | 	 */
18 | 	public static $app;
19 | }


--------------------------------------------------------------------------------
/src/yii2/Yii.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Yii bootstrap file.
 5 |  *
 6 |  * @link http://www.yiiframework.com/
 7 |  * @copyright Copyright (c) 2008 Yii Software LLC
 8 |  * @license http://www.yiiframework.com/license/
 9 |  */
10 | require(__DIR__ . '/BaseYii.php');
11 | 
12 | use grptx\Firebase\yii2\BaseYii;
13 | use yii\di\Container;
14 | /**
15 |  * Yii is a helper class serving common framework functionalities.
16 |  *
17 |  * It extends from [[\yii\BaseYii]] which provides the actual implementation.
18 |  * By writing your own Yii class, you can customize some functionalities of [[\yii\BaseYii]].
19 |  *
20 |  * @author Qiang Xue <qiang.xue@gmail.com>
21 |  * @author Roberto Rossetti <r.rossetti@melogra.no>
22 |  * @since 2.0
23 |  */
24 | class Yii extends BaseYii
25 | {
26 | }
27 | 
28 | spl_autoload_register(['Yii', 'autoload'], true, true);
29 | Yii::$classMap = require(__DIR__ . '/../../../../yiisoft/yii2/classes.php');
30 | Yii::$container = new Container();


--------------------------------------------------------------------------------
/tests/codeception.yml:
--------------------------------------------------------------------------------
 1 | paths:
 2 |     tests: tests
 3 |     output: tests/_output
 4 |     data: tests/_data
 5 |     support: tests/_support
 6 |     envs: tests/_envs
 7 |     log: tests/_log
 8 |     helpers: tests/_support
 9 | 
10 | actor_suffix: Tester
11 | 
12 | 
13 | settings:
14 |     bootstrap: _bootstrap.php
15 |     suite_class: \PHPUnit_Framework_TestSuite
16 |     memory_limit: 1024M
17 |     log: true
18 |     colors: true
19 | config:
20 |     # the entry script URL (with host info) for functional and acceptance tests
21 |     # PLEASE ADJUST IT TO THE ACTUAL ENTRY SCRIPT URL
22 |     test_entry_url: http://localhost:8081/index-test.php
23 | 
24 | modules:
25 |     config:
26 |         Yii2:
27 |             configFile: 'tests/config/config-local.php'
28 | 


--------------------------------------------------------------------------------
/tests/tests/FirebaseTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: gx
 5 |  * Date: 28/07/17
 6 |  * Time: 10.53
 7 |  */
 8 | 
 9 | namespace grptx\tests;
10 | 
11 | use Kreait\Firebase\ServiceAccount;
12 | use Kreait\Tests\FirebaseTestCase;
13 | use Firebase\Auth\Token\Handler;
14 | use GuzzleHttp\Psr7\Uri;
15 | use Kreait\Firebase;
16 | use PHPUnit\Framework\TestCase;
17 | 
18 | class FirebaseTest extends \grptx\Firebase\Firebase {
19 | 	private $firebaseTestCase;
20 | 
21 | 	/**
22 | 	 * @var ServiceAccount|\PHPUnit_Framework_MockObject_MockObject
23 | 	 */
24 | 	private $serviceAccount;
25 | 
26 | 	/**
27 | 	 * @var Uri
28 | 	 */
29 | 	private $databaseUri;
30 | 
31 | 	/**
32 | 	 * @var Handler
33 | 	 */
34 | 	private $tokenHandler;
35 | 
36 | 	/**
37 | 	 * @var Firebase
38 | 	 */
39 | 	private $firebase;
40 | 
41 | 	protected function setUp() {
42 | 		$this->firebaseTestCase = new FirebaseYiiTestCase();
43 | 		$this->serviceAccount   = $this->firebaseTestCase->createServiceAccountMock();
44 | 		$this->databaseUri      = new Uri( 'https://database-uri.tld' );
45 | 		$this->tokenHandler     = new Handler( 'projectid', 'clientEmail', 'privateKey' );
46 | 
47 | 		$this->firebase = new Firebase( $this->serviceAccount, $this->databaseUri, $this->tokenHandler );
48 | 	}
49 | 
50 | 	/**
51 | 	 * Firebase constructor.
52 | 	 */
53 | 	public function __construct() {
54 | 		parent::__construct([]);
55 | 		$this->setUp();
56 | 	}
57 | 
58 | 	public function getServiceAccount(): ServiceAccount
59 | 	{
60 | 		return $this->serviceAccount;
61 | 	}
62 | }
63 | 
64 | class FirebaseYiiTestCase extends TestCase {
65 | 	protected $fixturesDir = __DIR__.'/_fixtures';
66 | 
67 | 	/**
68 | 	 * @return ServiceAccount|\PHPUnit_Framework_MockObject_MockObject
69 | 	 */
70 | 	public function createServiceAccountMock()
71 | 	{
72 | 		$mock = $this->createMock(ServiceAccount::class);
73 | 
74 | 		$mock->expects($this->any())
75 | 		     ->method('getProjectId')
76 | 		     ->willReturn('project');
77 | 
78 | 		$mock->expects($this->any())
79 | 		     ->method('getClientId')
80 | 		     ->willReturn('client');
81 | 
82 | 		$mock->expects($this->any())
83 | 		     ->method('getClientEmail')
84 | 		     ->willReturn('client@email.tld');
85 | 
86 | 		$mock->expects($this->any())
87 | 		     ->method('getPrivateKey')
88 | 		     ->willReturn('some private key');
89 | 
90 | 		return $mock;
91 | 	}
92 | }


--------------------------------------------------------------------------------
/tests/tests/_bootstrap.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | defined('YII_DEBUG') or define('YII_DEBUG', true);
 3 | defined('YII_ENV') or define('YII_ENV', 'test');
 4 | defined('YII_TEST_ENTRY_URL') or define('YII_TEST_ENTRY_URL', parse_url(\Codeception\Configuration::config()['config']['test_entry_url'], PHP_URL_PATH));
 5 | defined('YII_TEST_ENTRY_FILE') or define('YII_TEST_ENTRY_FILE', __DIR__ . '/../web/index-test.php');
 6 | require_once(__DIR__ . '/../../vendor/autoload.php');
 7 | require_once(__DIR__ . '/../../vendor/yiisoft/yii2/Yii.php');
 8 | $_SERVER['SCRIPT_FILENAME'] = YII_TEST_ENTRY_FILE;
 9 | $_SERVER['SCRIPT_NAME'] = YII_TEST_ENTRY_URL;
10 | $_SERVER['SERVER_NAME'] = parse_url(\Codeception\Configuration::config()['config']['test_entry_url'], PHP_URL_HOST);
11 | $_SERVER['SERVER_PORT'] =  parse_url(\Codeception\Configuration::config()['config']['test_entry_url'], PHP_URL_PORT) ?: '80';
12 | Yii::setAlias('@tests', dirname(__DIR__));


--------------------------------------------------------------------------------
/tests/tests/_data/.gitkeep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/grptx/yii2-firebase/72bd9f5a36232bdef10a84e48497700788486c65/tests/tests/_data/.gitkeep


--------------------------------------------------------------------------------
/tests/tests/_output/.gitkeep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/grptx/yii2-firebase/72bd9f5a36232bdef10a84e48497700788486c65/tests/tests/_output/.gitkeep


--------------------------------------------------------------------------------
/tests/tests/_support/AcceptanceTester.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | 
 4 | /**
 5 |  * Inherited Methods
 6 |  * @method void wantToTest($text)
 7 |  * @method void wantTo($text)
 8 |  * @method void execute($callable)
 9 |  * @method void expectTo($prediction)
10 |  * @method void expect($prediction)
11 |  * @method void amGoingTo($argumentation)
12 |  * @method void am($role)
13 |  * @method void lookForwardTo($achieveValue)
14 |  * @method void comment($description)
15 |  * @method \Codeception\Lib\Friend haveFriend($name, $actorClass = NULL)
16 |  *
17 |  * @SuppressWarnings(PHPMD)
18 | */
19 | class AcceptanceTester extends \Codeception\Actor
20 | {
21 |     use _generated\AcceptanceTesterActions;
22 | 
23 |    /**
24 |     * Define custom actions here
25 |     */
26 | }
27 | 


--------------------------------------------------------------------------------
/tests/tests/_support/FunctionalTester.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | 
 4 | /**
 5 |  * Inherited Methods
 6 |  * @method void wantToTest($text)
 7 |  * @method void wantTo($text)
 8 |  * @method void execute($callable)
 9 |  * @method void expectTo($prediction)
10 |  * @method void expect($prediction)
11 |  * @method void amGoingTo($argumentation)
12 |  * @method void am($role)
13 |  * @method void lookForwardTo($achieveValue)
14 |  * @method void comment($description)
15 |  * @method \Codeception\Lib\Friend haveFriend($name, $actorClass = NULL)
16 |  *
17 |  * @SuppressWarnings(PHPMD)
18 | */
19 | class FunctionalTester extends \Codeception\Actor
20 | {
21 |     use _generated\FunctionalTesterActions;
22 | 
23 |    /**
24 |     * Define custom actions here
25 |     */
26 | }
27 | 


--------------------------------------------------------------------------------
/tests/tests/_support/Helper/Acceptance.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Helper;
 3 | 
 4 | // here you can define custom actions
 5 | // all public methods declared in helper class will be available in $I
 6 | 
 7 | class Acceptance extends \Codeception\Module
 8 | {
 9 | 
10 | }
11 | 


--------------------------------------------------------------------------------
/tests/tests/_support/Helper/Functional.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Helper;
 3 | 
 4 | // here you can define custom actions
 5 | // all public methods declared in helper class will be available in $I
 6 | 
 7 | class Functional extends \Codeception\Module
 8 | {
 9 | 
10 | }
11 | 


--------------------------------------------------------------------------------
/tests/tests/_support/Helper/Unit.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace Helper;
 3 | 
 4 | // here you can define custom actions
 5 | // all public methods declared in helper class will be available in $I
 6 | 
 7 | class Unit extends \Codeception\Module
 8 | {
 9 | 
10 | }
11 | 


--------------------------------------------------------------------------------
/tests/tests/_support/UnitTester.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | 
 4 | /**
 5 |  * Inherited Methods
 6 |  * @method void wantToTest($text)
 7 |  * @method void wantTo($text)
 8 |  * @method void execute($callable)
 9 |  * @method void expectTo($prediction)
10 |  * @method void expect($prediction)
11 |  * @method void amGoingTo($argumentation)
12 |  * @method void am($role)
13 |  * @method void lookForwardTo($achieveValue)
14 |  * @method void comment($description)
15 |  * @method \Codeception\Lib\Friend haveFriend($name, $actorClass = NULL)
16 |  *
17 |  * @SuppressWarnings(PHPMD)
18 | */
19 | class UnitTester extends \Codeception\Actor
20 | {
21 |     use _generated\UnitTesterActions;
22 | 
23 |    /**
24 |     * Define custom actions here
25 |     */
26 | 
27 | }
28 | 


--------------------------------------------------------------------------------
/tests/tests/_support/_generated/AcceptanceTesterActions.php:
--------------------------------------------------------------------------------
   1 | <?php  //[STAMP] 895a8e5ab22b72dc91306f75f5797b7d
   2 | namespace _generated;
   3 | 
   4 | // This class was automatically generated by build task
   5 | // You should not change it manually as it will be overwritten on next build
   6 | // @codingStandardsIgnoreFile
   7 | 
   8 | use Codeception\Module\PhpBrowser;
   9 | 
  10 | trait AcceptanceTesterActions
  11 | {
  12 |     /**
  13 |      * @return \Codeception\Scenario
  14 |      */
  15 |     abstract protected function getScenario();
  16 | 
  17 |     
  18 |     /**
  19 |      * [!] Method is generated. Documentation taken from corresponding module.
  20 |      *
  21 |      * Alias to `haveHttpHeader`
  22 |      *
  23 |      * @param $name
  24 |      * @param $value
  25 |      * @see \Codeception\Module\PhpBrowser::setHeader()
  26 |      */
  27 |     public function setHeader($name, $value) {
  28 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('setHeader', func_get_args()));
  29 |     }
  30 | 
  31 |  
  32 |     /**
  33 |      * [!] Method is generated. Documentation taken from corresponding module.
  34 |      *
  35 |      * Authenticates user for HTTP_AUTH
  36 |      *
  37 |      * @param $username
  38 |      * @param $password
  39 |      * @see \Codeception\Module\PhpBrowser::amHttpAuthenticated()
  40 |      */
  41 |     public function amHttpAuthenticated($username, $password) {
  42 |         return $this->getScenario()->runStep(new \Codeception\Step\Condition('amHttpAuthenticated', func_get_args()));
  43 |     }
  44 | 
  45 |  
  46 |     /**
  47 |      * [!] Method is generated. Documentation taken from corresponding module.
  48 |      *
  49 |      * Open web page at the given absolute URL and sets its hostname as the base host.
  50 |      *
  51 |      * ``` php
  52 |      * <?php
  53 |      * $I->amOnUrl('http://codeception.com');
  54 |      * $I->amOnPage('/quickstart'); // moves to http://codeception.com/quickstart
  55 |      * ?>
  56 |      * ```
  57 |      * @see \Codeception\Module\PhpBrowser::amOnUrl()
  58 |      */
  59 |     public function amOnUrl($url) {
  60 |         return $this->getScenario()->runStep(new \Codeception\Step\Condition('amOnUrl', func_get_args()));
  61 |     }
  62 | 
  63 |  
  64 |     /**
  65 |      * [!] Method is generated. Documentation taken from corresponding module.
  66 |      *
  67 |      * Changes the subdomain for the 'url' configuration parameter.
  68 |      * Does not open a page; use `amOnPage` for that.
  69 |      *
  70 |      * ``` php
  71 |      * <?php
  72 |      * // If config is: 'http://mysite.com'
  73 |      * // or config is: 'http://www.mysite.com'
  74 |      * // or config is: 'http://company.mysite.com'
  75 |      *
  76 |      * $I->amOnSubdomain('user');
  77 |      * $I->amOnPage('/');
  78 |      * // moves to http://user.mysite.com/
  79 |      * ?>
  80 |      * ```
  81 |      *
  82 |      * @param $subdomain
  83 |      *
  84 |      * @return mixed
  85 |      * @see \Codeception\Module\PhpBrowser::amOnSubdomain()
  86 |      */
  87 |     public function amOnSubdomain($subdomain) {
  88 |         return $this->getScenario()->runStep(new \Codeception\Step\Condition('amOnSubdomain', func_get_args()));
  89 |     }
  90 | 
  91 |  
  92 |     /**
  93 |      * [!] Method is generated. Documentation taken from corresponding module.
  94 |      *
  95 |      * Low-level API method.
  96 |      * If Codeception commands are not enough, use [Guzzle HTTP Client](http://guzzlephp.org/) methods directly
  97 |      *
  98 |      * Example:
  99 |      *
 100 |      * ``` php
 101 |      * <?php
 102 |      * $I->executeInGuzzle(function (\GuzzleHttp\Client $client) {
 103 |      *      $client->get('/get', ['query' => ['foo' => 'bar']]);
 104 |      * });
 105 |      * ?>
 106 |      * ```
 107 |      *
 108 |      * It is not recommended to use this command on a regular basis.
 109 |      * If Codeception lacks important Guzzle Client methods, implement them and submit patches.
 110 |      *
 111 |      * @param callable $function
 112 |      * @see \Codeception\Module\PhpBrowser::executeInGuzzle()
 113 |      */
 114 |     public function executeInGuzzle($function) {
 115 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('executeInGuzzle', func_get_args()));
 116 |     }
 117 | 
 118 |  
 119 |     /**
 120 |      * [!] Method is generated. Documentation taken from corresponding module.
 121 |      *
 122 |      * Sets the HTTP header to the passed value - which is used on
 123 |      * subsequent HTTP requests through PhpBrowser.
 124 |      *
 125 |      * Example:
 126 |      * ```php
 127 |      * <?php
 128 |      * $I->setHeader('X-Requested-With', 'Codeception');
 129 |      * $I->amOnPage('test-headers.php');
 130 |      * ?>
 131 |      * ```
 132 |      *
 133 |      * @param string $name the name of the request header
 134 |      * @param string $value the value to set it to for subsequent
 135 |      *        requests
 136 |      * @see \Codeception\Lib\InnerBrowser::haveHttpHeader()
 137 |      */
 138 |     public function haveHttpHeader($name, $value) {
 139 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('haveHttpHeader', func_get_args()));
 140 |     }
 141 | 
 142 |  
 143 |     /**
 144 |      * [!] Method is generated. Documentation taken from corresponding module.
 145 |      *
 146 |      * Deletes the header with the passed name.  Subsequent requests
 147 |      * will not have the deleted header in its request.
 148 |      *
 149 |      * Example:
 150 |      * ```php
 151 |      * <?php
 152 |      * $I->haveHttpHeader('X-Requested-With', 'Codeception');
 153 |      * $I->amOnPage('test-headers.php');
 154 |      * // ...
 155 |      * $I->deleteHeader('X-Requested-With');
 156 |      * $I->amOnPage('some-other-page.php');
 157 |      * ?>
 158 |      * ```
 159 |      *
 160 |      * @param string $name the name of the header to delete.
 161 |      * @see \Codeception\Lib\InnerBrowser::deleteHeader()
 162 |      */
 163 |     public function deleteHeader($name) {
 164 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('deleteHeader', func_get_args()));
 165 |     }
 166 | 
 167 |  
 168 |     /**
 169 |      * [!] Method is generated. Documentation taken from corresponding module.
 170 |      *
 171 |      * Opens the page for the given relative URI.
 172 |      *
 173 |      * ``` php
 174 |      * <?php
 175 |      * // opens front page
 176 |      * $I->amOnPage('/');
 177 |      * // opens /register page
 178 |      * $I->amOnPage('/register');
 179 |      * ```
 180 |      *
 181 |      * @param $page
 182 |      * @see \Codeception\Lib\InnerBrowser::amOnPage()
 183 |      */
 184 |     public function amOnPage($page) {
 185 |         return $this->getScenario()->runStep(new \Codeception\Step\Condition('amOnPage', func_get_args()));
 186 |     }
 187 | 
 188 |  
 189 |     /**
 190 |      * [!] Method is generated. Documentation taken from corresponding module.
 191 |      *
 192 |      * Perform a click on a link or a button, given by a locator.
 193 |      * If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.
 194 |      * For buttons, the "value" attribute, "name" attribute, and inner text are searched.
 195 |      * For links, the link text is searched.
 196 |      * For images, the "alt" attribute and inner text of any parent links are searched.
 197 |      *
 198 |      * The second parameter is a context (CSS or XPath locator) to narrow the search.
 199 |      *
 200 |      * Note that if the locator matches a button of type `submit`, the form will be submitted.
 201 |      *
 202 |      * ``` php
 203 |      * <?php
 204 |      * // simple link
 205 |      * $I->click('Logout');
 206 |      * // button of form
 207 |      * $I->click('Submit');
 208 |      * // CSS button
 209 |      * $I->click('#form input[type=submit]');
 210 |      * // XPath
 211 |      * $I->click('//form/*[@type=submit]');
 212 |      * // link in context
 213 |      * $I->click('Logout', '#nav');
 214 |      * // using strict locator
 215 |      * $I->click(['link' => 'Login']);
 216 |      * ?>
 217 |      * ```
 218 |      *
 219 |      * @param $link
 220 |      * @param $context
 221 |      * @see \Codeception\Lib\InnerBrowser::click()
 222 |      */
 223 |     public function click($link, $context = null) {
 224 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('click', func_get_args()));
 225 |     }
 226 | 
 227 |  
 228 |     /**
 229 |      * [!] Method is generated. Documentation taken from corresponding module.
 230 |      *
 231 |      * Checks that the current page contains the given string (case insensitive).
 232 |      *
 233 |      * You can specify a specific HTML element (via CSS or XPath) as the second
 234 |      * parameter to only search within that element.
 235 |      *
 236 |      * ``` php
 237 |      * <?php
 238 |      * $I->see('Logout');                        // I can suppose user is logged in
 239 |      * $I->see('Sign Up', 'h1');                 // I can suppose it's a signup page
 240 |      * $I->see('Sign Up', '//body/h1');          // with XPath
 241 |      * $I->see('Sign Up', ['css' => 'body h1']); // with strict CSS locator
 242 |      * ```
 243 |      *
 244 |      * Note that the search is done after stripping all HTML tags from the body,
 245 |      * so `$I->see('strong')` will return true for strings like:
 246 |      *
 247 |      *   - `<p>I am Stronger than thou</p>`
 248 |      *   - `<script>document.createElement('strong');</script>`
 249 |      *
 250 |      * But will *not* be true for strings like:
 251 |      *
 252 |      *   - `<strong>Home</strong>`
 253 |      *   - `<div class="strong">Home</strong>`
 254 |      *   - `<!-- strong -->`
 255 |      *
 256 |      * For checking the raw source code, use `seeInSource()`.
 257 |      *
 258 |      * @param      $text
 259 |      * @param null $selector
 260 |      * Conditional Assertion: Test won't be stopped on fail
 261 |      * @see \Codeception\Lib\InnerBrowser::see()
 262 |      */
 263 |     public function canSee($text, $selector = null) {
 264 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('see', func_get_args()));
 265 |     }
 266 |     /**
 267 |      * [!] Method is generated. Documentation taken from corresponding module.
 268 |      *
 269 |      * Checks that the current page contains the given string (case insensitive).
 270 |      *
 271 |      * You can specify a specific HTML element (via CSS or XPath) as the second
 272 |      * parameter to only search within that element.
 273 |      *
 274 |      * ``` php
 275 |      * <?php
 276 |      * $I->see('Logout');                        // I can suppose user is logged in
 277 |      * $I->see('Sign Up', 'h1');                 // I can suppose it's a signup page
 278 |      * $I->see('Sign Up', '//body/h1');          // with XPath
 279 |      * $I->see('Sign Up', ['css' => 'body h1']); // with strict CSS locator
 280 |      * ```
 281 |      *
 282 |      * Note that the search is done after stripping all HTML tags from the body,
 283 |      * so `$I->see('strong')` will return true for strings like:
 284 |      *
 285 |      *   - `<p>I am Stronger than thou</p>`
 286 |      *   - `<script>document.createElement('strong');</script>`
 287 |      *
 288 |      * But will *not* be true for strings like:
 289 |      *
 290 |      *   - `<strong>Home</strong>`
 291 |      *   - `<div class="strong">Home</strong>`
 292 |      *   - `<!-- strong -->`
 293 |      *
 294 |      * For checking the raw source code, use `seeInSource()`.
 295 |      *
 296 |      * @param      $text
 297 |      * @param null $selector
 298 |      * @see \Codeception\Lib\InnerBrowser::see()
 299 |      */
 300 |     public function see($text, $selector = null) {
 301 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('see', func_get_args()));
 302 |     }
 303 | 
 304 |  
 305 |     /**
 306 |      * [!] Method is generated. Documentation taken from corresponding module.
 307 |      *
 308 |      * Checks that the current page doesn't contain the text specified (case insensitive).
 309 |      * Give a locator as the second parameter to match a specific region.
 310 |      *
 311 |      * ```php
 312 |      * <?php
 313 |      * $I->dontSee('Login');                         // I can suppose user is already logged in
 314 |      * $I->dontSee('Sign Up','h1');                  // I can suppose it's not a signup page
 315 |      * $I->dontSee('Sign Up','//body/h1');           // with XPath
 316 |      * $I->dontSee('Sign Up', ['css' => 'body h1']); // with strict CSS locator
 317 |      * ```
 318 |      *
 319 |      * Note that the search is done after stripping all HTML tags from the body,
 320 |      * so `$I->dontSee('strong')` will fail on strings like:
 321 |      *
 322 |      *   - `<p>I am Stronger than thou</p>`
 323 |      *   - `<script>document.createElement('strong');</script>`
 324 |      *
 325 |      * But will ignore strings like:
 326 |      *
 327 |      *   - `<strong>Home</strong>`
 328 |      *   - `<div class="strong">Home</strong>`
 329 |      *   - `<!-- strong -->`
 330 |      *
 331 |      * For checking the raw source code, use `seeInSource()`.
 332 |      *
 333 |      * @param      $text
 334 |      * @param null $selector
 335 |      * Conditional Assertion: Test won't be stopped on fail
 336 |      * @see \Codeception\Lib\InnerBrowser::dontSee()
 337 |      */
 338 |     public function cantSee($text, $selector = null) {
 339 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSee', func_get_args()));
 340 |     }
 341 |     /**
 342 |      * [!] Method is generated. Documentation taken from corresponding module.
 343 |      *
 344 |      * Checks that the current page doesn't contain the text specified (case insensitive).
 345 |      * Give a locator as the second parameter to match a specific region.
 346 |      *
 347 |      * ```php
 348 |      * <?php
 349 |      * $I->dontSee('Login');                         // I can suppose user is already logged in
 350 |      * $I->dontSee('Sign Up','h1');                  // I can suppose it's not a signup page
 351 |      * $I->dontSee('Sign Up','//body/h1');           // with XPath
 352 |      * $I->dontSee('Sign Up', ['css' => 'body h1']); // with strict CSS locator
 353 |      * ```
 354 |      *
 355 |      * Note that the search is done after stripping all HTML tags from the body,
 356 |      * so `$I->dontSee('strong')` will fail on strings like:
 357 |      *
 358 |      *   - `<p>I am Stronger than thou</p>`
 359 |      *   - `<script>document.createElement('strong');</script>`
 360 |      *
 361 |      * But will ignore strings like:
 362 |      *
 363 |      *   - `<strong>Home</strong>`
 364 |      *   - `<div class="strong">Home</strong>`
 365 |      *   - `<!-- strong -->`
 366 |      *
 367 |      * For checking the raw source code, use `seeInSource()`.
 368 |      *
 369 |      * @param      $text
 370 |      * @param null $selector
 371 |      * @see \Codeception\Lib\InnerBrowser::dontSee()
 372 |      */
 373 |     public function dontSee($text, $selector = null) {
 374 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSee', func_get_args()));
 375 |     }
 376 | 
 377 |  
 378 |     /**
 379 |      * [!] Method is generated. Documentation taken from corresponding module.
 380 |      *
 381 |      * Checks that the current page contains the given string in its
 382 |      * raw source code.
 383 |      *
 384 |      * ``` php
 385 |      * <?php
 386 |      * $I->seeInSource('<h1>Green eggs &amp; ham</h1>');
 387 |      * ```
 388 |      *
 389 |      * @param      $raw
 390 |      * Conditional Assertion: Test won't be stopped on fail
 391 |      * @see \Codeception\Lib\InnerBrowser::seeInSource()
 392 |      */
 393 |     public function canSeeInSource($raw) {
 394 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInSource', func_get_args()));
 395 |     }
 396 |     /**
 397 |      * [!] Method is generated. Documentation taken from corresponding module.
 398 |      *
 399 |      * Checks that the current page contains the given string in its
 400 |      * raw source code.
 401 |      *
 402 |      * ``` php
 403 |      * <?php
 404 |      * $I->seeInSource('<h1>Green eggs &amp; ham</h1>');
 405 |      * ```
 406 |      *
 407 |      * @param      $raw
 408 |      * @see \Codeception\Lib\InnerBrowser::seeInSource()
 409 |      */
 410 |     public function seeInSource($raw) {
 411 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInSource', func_get_args()));
 412 |     }
 413 | 
 414 |  
 415 |     /**
 416 |      * [!] Method is generated. Documentation taken from corresponding module.
 417 |      *
 418 |      * Checks that the current page contains the given string in its
 419 |      * raw source code.
 420 |      *
 421 |      * ```php
 422 |      * <?php
 423 |      * $I->dontSeeInSource('<h1>Green eggs &amp; ham</h1>');
 424 |      * ```
 425 |      *
 426 |      * @param      $raw
 427 |      * Conditional Assertion: Test won't be stopped on fail
 428 |      * @see \Codeception\Lib\InnerBrowser::dontSeeInSource()
 429 |      */
 430 |     public function cantSeeInSource($raw) {
 431 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInSource', func_get_args()));
 432 |     }
 433 |     /**
 434 |      * [!] Method is generated. Documentation taken from corresponding module.
 435 |      *
 436 |      * Checks that the current page contains the given string in its
 437 |      * raw source code.
 438 |      *
 439 |      * ```php
 440 |      * <?php
 441 |      * $I->dontSeeInSource('<h1>Green eggs &amp; ham</h1>');
 442 |      * ```
 443 |      *
 444 |      * @param      $raw
 445 |      * @see \Codeception\Lib\InnerBrowser::dontSeeInSource()
 446 |      */
 447 |     public function dontSeeInSource($raw) {
 448 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeInSource', func_get_args()));
 449 |     }
 450 | 
 451 |  
 452 |     /**
 453 |      * [!] Method is generated. Documentation taken from corresponding module.
 454 |      *
 455 |      * Checks that there's a link with the specified text.
 456 |      * Give a full URL as the second parameter to match links with that exact URL.
 457 |      *
 458 |      * ``` php
 459 |      * <?php
 460 |      * $I->seeLink('Logout'); // matches <a href="#">Logout</a>
 461 |      * $I->seeLink('Logout','/logout'); // matches <a href="/logout">Logout</a>
 462 |      * ?>
 463 |      * ```
 464 |      *
 465 |      * @param      $text
 466 |      * @param null $url
 467 |      * Conditional Assertion: Test won't be stopped on fail
 468 |      * @see \Codeception\Lib\InnerBrowser::seeLink()
 469 |      */
 470 |     public function canSeeLink($text, $url = null) {
 471 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeLink', func_get_args()));
 472 |     }
 473 |     /**
 474 |      * [!] Method is generated. Documentation taken from corresponding module.
 475 |      *
 476 |      * Checks that there's a link with the specified text.
 477 |      * Give a full URL as the second parameter to match links with that exact URL.
 478 |      *
 479 |      * ``` php
 480 |      * <?php
 481 |      * $I->seeLink('Logout'); // matches <a href="#">Logout</a>
 482 |      * $I->seeLink('Logout','/logout'); // matches <a href="/logout">Logout</a>
 483 |      * ?>
 484 |      * ```
 485 |      *
 486 |      * @param      $text
 487 |      * @param null $url
 488 |      * @see \Codeception\Lib\InnerBrowser::seeLink()
 489 |      */
 490 |     public function seeLink($text, $url = null) {
 491 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeLink', func_get_args()));
 492 |     }
 493 | 
 494 |  
 495 |     /**
 496 |      * [!] Method is generated. Documentation taken from corresponding module.
 497 |      *
 498 |      * Checks that the page doesn't contain a link with the given string.
 499 |      * If the second parameter is given, only links with a matching "href" attribute will be checked.
 500 |      *
 501 |      * ``` php
 502 |      * <?php
 503 |      * $I->dontSeeLink('Logout'); // I suppose user is not logged in
 504 |      * $I->dontSeeLink('Checkout now', '/store/cart.php');
 505 |      * ?>
 506 |      * ```
 507 |      *
 508 |      * @param $text
 509 |      * @param null $url
 510 |      * Conditional Assertion: Test won't be stopped on fail
 511 |      * @see \Codeception\Lib\InnerBrowser::dontSeeLink()
 512 |      */
 513 |     public function cantSeeLink($text, $url = null) {
 514 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeLink', func_get_args()));
 515 |     }
 516 |     /**
 517 |      * [!] Method is generated. Documentation taken from corresponding module.
 518 |      *
 519 |      * Checks that the page doesn't contain a link with the given string.
 520 |      * If the second parameter is given, only links with a matching "href" attribute will be checked.
 521 |      *
 522 |      * ``` php
 523 |      * <?php
 524 |      * $I->dontSeeLink('Logout'); // I suppose user is not logged in
 525 |      * $I->dontSeeLink('Checkout now', '/store/cart.php');
 526 |      * ?>
 527 |      * ```
 528 |      *
 529 |      * @param $text
 530 |      * @param null $url
 531 |      * @see \Codeception\Lib\InnerBrowser::dontSeeLink()
 532 |      */
 533 |     public function dontSeeLink($text, $url = null) {
 534 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeLink', func_get_args()));
 535 |     }
 536 | 
 537 |  
 538 |     /**
 539 |      * [!] Method is generated. Documentation taken from corresponding module.
 540 |      *
 541 |      * Checks that current URI contains the given string.
 542 |      *
 543 |      * ``` php
 544 |      * <?php
 545 |      * // to match: /home/dashboard
 546 |      * $I->seeInCurrentUrl('home');
 547 |      * // to match: /users/1
 548 |      * $I->seeInCurrentUrl('/users/');
 549 |      * ?>
 550 |      * ```
 551 |      *
 552 |      * @param $uri
 553 |      * Conditional Assertion: Test won't be stopped on fail
 554 |      * @see \Codeception\Lib\InnerBrowser::seeInCurrentUrl()
 555 |      */
 556 |     public function canSeeInCurrentUrl($uri) {
 557 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInCurrentUrl', func_get_args()));
 558 |     }
 559 |     /**
 560 |      * [!] Method is generated. Documentation taken from corresponding module.
 561 |      *
 562 |      * Checks that current URI contains the given string.
 563 |      *
 564 |      * ``` php
 565 |      * <?php
 566 |      * // to match: /home/dashboard
 567 |      * $I->seeInCurrentUrl('home');
 568 |      * // to match: /users/1
 569 |      * $I->seeInCurrentUrl('/users/');
 570 |      * ?>
 571 |      * ```
 572 |      *
 573 |      * @param $uri
 574 |      * @see \Codeception\Lib\InnerBrowser::seeInCurrentUrl()
 575 |      */
 576 |     public function seeInCurrentUrl($uri) {
 577 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInCurrentUrl', func_get_args()));
 578 |     }
 579 | 
 580 |  
 581 |     /**
 582 |      * [!] Method is generated. Documentation taken from corresponding module.
 583 |      *
 584 |      * Checks that the current URI doesn't contain the given string.
 585 |      *
 586 |      * ``` php
 587 |      * <?php
 588 |      * $I->dontSeeInCurrentUrl('/users/');
 589 |      * ?>
 590 |      * ```
 591 |      *
 592 |      * @param $uri
 593 |      * Conditional Assertion: Test won't be stopped on fail
 594 |      * @see \Codeception\Lib\InnerBrowser::dontSeeInCurrentUrl()
 595 |      */
 596 |     public function cantSeeInCurrentUrl($uri) {
 597 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInCurrentUrl', func_get_args()));
 598 |     }
 599 |     /**
 600 |      * [!] Method is generated. Documentation taken from corresponding module.
 601 |      *
 602 |      * Checks that the current URI doesn't contain the given string.
 603 |      *
 604 |      * ``` php
 605 |      * <?php
 606 |      * $I->dontSeeInCurrentUrl('/users/');
 607 |      * ?>
 608 |      * ```
 609 |      *
 610 |      * @param $uri
 611 |      * @see \Codeception\Lib\InnerBrowser::dontSeeInCurrentUrl()
 612 |      */
 613 |     public function dontSeeInCurrentUrl($uri) {
 614 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeInCurrentUrl', func_get_args()));
 615 |     }
 616 | 
 617 |  
 618 |     /**
 619 |      * [!] Method is generated. Documentation taken from corresponding module.
 620 |      *
 621 |      * Checks that the current URL is equal to the given string.
 622 |      * Unlike `seeInCurrentUrl`, this only matches the full URL.
 623 |      *
 624 |      * ``` php
 625 |      * <?php
 626 |      * // to match root url
 627 |      * $I->seeCurrentUrlEquals('/');
 628 |      * ?>
 629 |      * ```
 630 |      *
 631 |      * @param $uri
 632 |      * Conditional Assertion: Test won't be stopped on fail
 633 |      * @see \Codeception\Lib\InnerBrowser::seeCurrentUrlEquals()
 634 |      */
 635 |     public function canSeeCurrentUrlEquals($uri) {
 636 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeCurrentUrlEquals', func_get_args()));
 637 |     }
 638 |     /**
 639 |      * [!] Method is generated. Documentation taken from corresponding module.
 640 |      *
 641 |      * Checks that the current URL is equal to the given string.
 642 |      * Unlike `seeInCurrentUrl`, this only matches the full URL.
 643 |      *
 644 |      * ``` php
 645 |      * <?php
 646 |      * // to match root url
 647 |      * $I->seeCurrentUrlEquals('/');
 648 |      * ?>
 649 |      * ```
 650 |      *
 651 |      * @param $uri
 652 |      * @see \Codeception\Lib\InnerBrowser::seeCurrentUrlEquals()
 653 |      */
 654 |     public function seeCurrentUrlEquals($uri) {
 655 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCurrentUrlEquals', func_get_args()));
 656 |     }
 657 | 
 658 |  
 659 |     /**
 660 |      * [!] Method is generated. Documentation taken from corresponding module.
 661 |      *
 662 |      * Checks that the current URL doesn't equal the given string.
 663 |      * Unlike `dontSeeInCurrentUrl`, this only matches the full URL.
 664 |      *
 665 |      * ``` php
 666 |      * <?php
 667 |      * // current url is not root
 668 |      * $I->dontSeeCurrentUrlEquals('/');
 669 |      * ?>
 670 |      * ```
 671 |      *
 672 |      * @param $uri
 673 |      * Conditional Assertion: Test won't be stopped on fail
 674 |      * @see \Codeception\Lib\InnerBrowser::dontSeeCurrentUrlEquals()
 675 |      */
 676 |     public function cantSeeCurrentUrlEquals($uri) {
 677 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeCurrentUrlEquals', func_get_args()));
 678 |     }
 679 |     /**
 680 |      * [!] Method is generated. Documentation taken from corresponding module.
 681 |      *
 682 |      * Checks that the current URL doesn't equal the given string.
 683 |      * Unlike `dontSeeInCurrentUrl`, this only matches the full URL.
 684 |      *
 685 |      * ``` php
 686 |      * <?php
 687 |      * // current url is not root
 688 |      * $I->dontSeeCurrentUrlEquals('/');
 689 |      * ?>
 690 |      * ```
 691 |      *
 692 |      * @param $uri
 693 |      * @see \Codeception\Lib\InnerBrowser::dontSeeCurrentUrlEquals()
 694 |      */
 695 |     public function dontSeeCurrentUrlEquals($uri) {
 696 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeCurrentUrlEquals', func_get_args()));
 697 |     }
 698 | 
 699 |  
 700 |     /**
 701 |      * [!] Method is generated. Documentation taken from corresponding module.
 702 |      *
 703 |      * Checks that the current URL matches the given regular expression.
 704 |      *
 705 |      * ``` php
 706 |      * <?php
 707 |      * // to match root url
 708 |      * $I->seeCurrentUrlMatches('~$/users/(\d+)~');
 709 |      * ?>
 710 |      * ```
 711 |      *
 712 |      * @param $uri
 713 |      * Conditional Assertion: Test won't be stopped on fail
 714 |      * @see \Codeception\Lib\InnerBrowser::seeCurrentUrlMatches()
 715 |      */
 716 |     public function canSeeCurrentUrlMatches($uri) {
 717 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeCurrentUrlMatches', func_get_args()));
 718 |     }
 719 |     /**
 720 |      * [!] Method is generated. Documentation taken from corresponding module.
 721 |      *
 722 |      * Checks that the current URL matches the given regular expression.
 723 |      *
 724 |      * ``` php
 725 |      * <?php
 726 |      * // to match root url
 727 |      * $I->seeCurrentUrlMatches('~$/users/(\d+)~');
 728 |      * ?>
 729 |      * ```
 730 |      *
 731 |      * @param $uri
 732 |      * @see \Codeception\Lib\InnerBrowser::seeCurrentUrlMatches()
 733 |      */
 734 |     public function seeCurrentUrlMatches($uri) {
 735 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCurrentUrlMatches', func_get_args()));
 736 |     }
 737 | 
 738 |  
 739 |     /**
 740 |      * [!] Method is generated. Documentation taken from corresponding module.
 741 |      *
 742 |      * Checks that current url doesn't match the given regular expression.
 743 |      *
 744 |      * ``` php
 745 |      * <?php
 746 |      * // to match root url
 747 |      * $I->dontSeeCurrentUrlMatches('~$/users/(\d+)~');
 748 |      * ?>
 749 |      * ```
 750 |      *
 751 |      * @param $uri
 752 |      * Conditional Assertion: Test won't be stopped on fail
 753 |      * @see \Codeception\Lib\InnerBrowser::dontSeeCurrentUrlMatches()
 754 |      */
 755 |     public function cantSeeCurrentUrlMatches($uri) {
 756 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeCurrentUrlMatches', func_get_args()));
 757 |     }
 758 |     /**
 759 |      * [!] Method is generated. Documentation taken from corresponding module.
 760 |      *
 761 |      * Checks that current url doesn't match the given regular expression.
 762 |      *
 763 |      * ``` php
 764 |      * <?php
 765 |      * // to match root url
 766 |      * $I->dontSeeCurrentUrlMatches('~$/users/(\d+)~');
 767 |      * ?>
 768 |      * ```
 769 |      *
 770 |      * @param $uri
 771 |      * @see \Codeception\Lib\InnerBrowser::dontSeeCurrentUrlMatches()
 772 |      */
 773 |     public function dontSeeCurrentUrlMatches($uri) {
 774 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeCurrentUrlMatches', func_get_args()));
 775 |     }
 776 | 
 777 |  
 778 |     /**
 779 |      * [!] Method is generated. Documentation taken from corresponding module.
 780 |      *
 781 |      * Executes the given regular expression against the current URI and returns the first match.
 782 |      * If no parameters are provided, the full URI is returned.
 783 |      *
 784 |      * ``` php
 785 |      * <?php
 786 |      * $user_id = $I->grabFromCurrentUrl('~$/user/(\d+)/~');
 787 |      * $uri = $I->grabFromCurrentUrl();
 788 |      * ?>
 789 |      * ```
 790 |      *
 791 |      * @param null $uri
 792 |      *
 793 |      * @return mixed
 794 |      * @see \Codeception\Lib\InnerBrowser::grabFromCurrentUrl()
 795 |      */
 796 |     public function grabFromCurrentUrl($uri = null) {
 797 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('grabFromCurrentUrl', func_get_args()));
 798 |     }
 799 | 
 800 |  
 801 |     /**
 802 |      * [!] Method is generated. Documentation taken from corresponding module.
 803 |      *
 804 |      * Checks that the specified checkbox is checked.
 805 |      *
 806 |      * ``` php
 807 |      * <?php
 808 |      * $I->seeCheckboxIsChecked('#agree'); // I suppose user agreed to terms
 809 |      * $I->seeCheckboxIsChecked('#signup_form input[type=checkbox]'); // I suppose user agreed to terms, If there is only one checkbox in form.
 810 |      * $I->seeCheckboxIsChecked('//form/input[@type=checkbox and @name=agree]');
 811 |      * ?>
 812 |      * ```
 813 |      *
 814 |      * @param $checkbox
 815 |      * Conditional Assertion: Test won't be stopped on fail
 816 |      * @see \Codeception\Lib\InnerBrowser::seeCheckboxIsChecked()
 817 |      */
 818 |     public function canSeeCheckboxIsChecked($checkbox) {
 819 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeCheckboxIsChecked', func_get_args()));
 820 |     }
 821 |     /**
 822 |      * [!] Method is generated. Documentation taken from corresponding module.
 823 |      *
 824 |      * Checks that the specified checkbox is checked.
 825 |      *
 826 |      * ``` php
 827 |      * <?php
 828 |      * $I->seeCheckboxIsChecked('#agree'); // I suppose user agreed to terms
 829 |      * $I->seeCheckboxIsChecked('#signup_form input[type=checkbox]'); // I suppose user agreed to terms, If there is only one checkbox in form.
 830 |      * $I->seeCheckboxIsChecked('//form/input[@type=checkbox and @name=agree]');
 831 |      * ?>
 832 |      * ```
 833 |      *
 834 |      * @param $checkbox
 835 |      * @see \Codeception\Lib\InnerBrowser::seeCheckboxIsChecked()
 836 |      */
 837 |     public function seeCheckboxIsChecked($checkbox) {
 838 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCheckboxIsChecked', func_get_args()));
 839 |     }
 840 | 
 841 |  
 842 |     /**
 843 |      * [!] Method is generated. Documentation taken from corresponding module.
 844 |      *
 845 |      * Check that the specified checkbox is unchecked.
 846 |      *
 847 |      * ``` php
 848 |      * <?php
 849 |      * $I->dontSeeCheckboxIsChecked('#agree'); // I suppose user didn't agree to terms
 850 |      * $I->seeCheckboxIsChecked('#signup_form input[type=checkbox]'); // I suppose user didn't check the first checkbox in form.
 851 |      * ?>
 852 |      * ```
 853 |      *
 854 |      * @param $checkbox
 855 |      * Conditional Assertion: Test won't be stopped on fail
 856 |      * @see \Codeception\Lib\InnerBrowser::dontSeeCheckboxIsChecked()
 857 |      */
 858 |     public function cantSeeCheckboxIsChecked($checkbox) {
 859 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeCheckboxIsChecked', func_get_args()));
 860 |     }
 861 |     /**
 862 |      * [!] Method is generated. Documentation taken from corresponding module.
 863 |      *
 864 |      * Check that the specified checkbox is unchecked.
 865 |      *
 866 |      * ``` php
 867 |      * <?php
 868 |      * $I->dontSeeCheckboxIsChecked('#agree'); // I suppose user didn't agree to terms
 869 |      * $I->seeCheckboxIsChecked('#signup_form input[type=checkbox]'); // I suppose user didn't check the first checkbox in form.
 870 |      * ?>
 871 |      * ```
 872 |      *
 873 |      * @param $checkbox
 874 |      * @see \Codeception\Lib\InnerBrowser::dontSeeCheckboxIsChecked()
 875 |      */
 876 |     public function dontSeeCheckboxIsChecked($checkbox) {
 877 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeCheckboxIsChecked', func_get_args()));
 878 |     }
 879 | 
 880 |  
 881 |     /**
 882 |      * [!] Method is generated. Documentation taken from corresponding module.
 883 |      *
 884 |      * Checks that the given input field or textarea contains the given value.
 885 |      * For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
 886 |      *
 887 |      * ``` php
 888 |      * <?php
 889 |      * $I->seeInField('Body','Type your comment here');
 890 |      * $I->seeInField('form textarea[name=body]','Type your comment here');
 891 |      * $I->seeInField('form input[type=hidden]','hidden_value');
 892 |      * $I->seeInField('#searchform input','Search');
 893 |      * $I->seeInField('//form/*[@name=search]','Search');
 894 |      * $I->seeInField(['name' => 'search'], 'Search');
 895 |      * ?>
 896 |      * ```
 897 |      *
 898 |      * @param $field
 899 |      * @param $value
 900 |      * Conditional Assertion: Test won't be stopped on fail
 901 |      * @see \Codeception\Lib\InnerBrowser::seeInField()
 902 |      */
 903 |     public function canSeeInField($field, $value) {
 904 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInField', func_get_args()));
 905 |     }
 906 |     /**
 907 |      * [!] Method is generated. Documentation taken from corresponding module.
 908 |      *
 909 |      * Checks that the given input field or textarea contains the given value.
 910 |      * For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
 911 |      *
 912 |      * ``` php
 913 |      * <?php
 914 |      * $I->seeInField('Body','Type your comment here');
 915 |      * $I->seeInField('form textarea[name=body]','Type your comment here');
 916 |      * $I->seeInField('form input[type=hidden]','hidden_value');
 917 |      * $I->seeInField('#searchform input','Search');
 918 |      * $I->seeInField('//form/*[@name=search]','Search');
 919 |      * $I->seeInField(['name' => 'search'], 'Search');
 920 |      * ?>
 921 |      * ```
 922 |      *
 923 |      * @param $field
 924 |      * @param $value
 925 |      * @see \Codeception\Lib\InnerBrowser::seeInField()
 926 |      */
 927 |     public function seeInField($field, $value) {
 928 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInField', func_get_args()));
 929 |     }
 930 | 
 931 |  
 932 |     /**
 933 |      * [!] Method is generated. Documentation taken from corresponding module.
 934 |      *
 935 |      * Checks that an input field or textarea doesn't contain the given value.
 936 |      * For fuzzy locators, the field is matched by label text, CSS and XPath.
 937 |      *
 938 |      * ``` php
 939 |      * <?php
 940 |      * $I->dontSeeInField('Body','Type your comment here');
 941 |      * $I->dontSeeInField('form textarea[name=body]','Type your comment here');
 942 |      * $I->dontSeeInField('form input[type=hidden]','hidden_value');
 943 |      * $I->dontSeeInField('#searchform input','Search');
 944 |      * $I->dontSeeInField('//form/*[@name=search]','Search');
 945 |      * $I->dontSeeInField(['name' => 'search'], 'Search');
 946 |      * ?>
 947 |      * ```
 948 |      *
 949 |      * @param $field
 950 |      * @param $value
 951 |      * Conditional Assertion: Test won't be stopped on fail
 952 |      * @see \Codeception\Lib\InnerBrowser::dontSeeInField()
 953 |      */
 954 |     public function cantSeeInField($field, $value) {
 955 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInField', func_get_args()));
 956 |     }
 957 |     /**
 958 |      * [!] Method is generated. Documentation taken from corresponding module.
 959 |      *
 960 |      * Checks that an input field or textarea doesn't contain the given value.
 961 |      * For fuzzy locators, the field is matched by label text, CSS and XPath.
 962 |      *
 963 |      * ``` php
 964 |      * <?php
 965 |      * $I->dontSeeInField('Body','Type your comment here');
 966 |      * $I->dontSeeInField('form textarea[name=body]','Type your comment here');
 967 |      * $I->dontSeeInField('form input[type=hidden]','hidden_value');
 968 |      * $I->dontSeeInField('#searchform input','Search');
 969 |      * $I->dontSeeInField('//form/*[@name=search]','Search');
 970 |      * $I->dontSeeInField(['name' => 'search'], 'Search');
 971 |      * ?>
 972 |      * ```
 973 |      *
 974 |      * @param $field
 975 |      * @param $value
 976 |      * @see \Codeception\Lib\InnerBrowser::dontSeeInField()
 977 |      */
 978 |     public function dontSeeInField($field, $value) {
 979 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeInField', func_get_args()));
 980 |     }
 981 | 
 982 |  
 983 |     /**
 984 |      * [!] Method is generated. Documentation taken from corresponding module.
 985 |      *
 986 |      * Checks if the array of form parameters (name => value) are set on the form matched with the
 987 |      * passed selector.
 988 |      *
 989 |      * ``` php
 990 |      * <?php
 991 |      * $I->seeInFormFields('form[name=myform]', [
 992 |      *      'input1' => 'value',
 993 |      *      'input2' => 'other value',
 994 |      * ]);
 995 |      * ?>
 996 |      * ```
 997 |      *
 998 |      * For multi-select elements, or to check values of multiple elements with the same name, an
 999 |      * array may be passed:
1000 |      *
1001 |      * ``` php
1002 |      * <?php
1003 |      * $I->seeInFormFields('.form-class', [
1004 |      *      'multiselect' => [
1005 |      *          'value1',
1006 |      *          'value2',
1007 |      *      ],
1008 |      *      'checkbox[]' => [
1009 |      *          'a checked value',
1010 |      *          'another checked value',
1011 |      *      ],
1012 |      * ]);
1013 |      * ?>
1014 |      * ```
1015 |      *
1016 |      * Additionally, checkbox values can be checked with a boolean.
1017 |      *
1018 |      * ``` php
1019 |      * <?php
1020 |      * $I->seeInFormFields('#form-id', [
1021 |      *      'checkbox1' => true,        // passes if checked
1022 |      *      'checkbox2' => false,       // passes if unchecked
1023 |      * ]);
1024 |      * ?>
1025 |      * ```
1026 |      *
1027 |      * Pair this with submitForm for quick testing magic.
1028 |      *
1029 |      * ``` php
1030 |      * <?php
1031 |      * $form = [
1032 |      *      'field1' => 'value',
1033 |      *      'field2' => 'another value',
1034 |      *      'checkbox1' => true,
1035 |      *      // ...
1036 |      * ];
1037 |      * $I->submitForm('//form[@id=my-form]', $form, 'submitButton');
1038 |      * // $I->amOnPage('/path/to/form-page') may be needed
1039 |      * $I->seeInFormFields('//form[@id=my-form]', $form);
1040 |      * ?>
1041 |      * ```
1042 |      *
1043 |      * @param $formSelector
1044 |      * @param $params
1045 |      * Conditional Assertion: Test won't be stopped on fail
1046 |      * @see \Codeception\Lib\InnerBrowser::seeInFormFields()
1047 |      */
1048 |     public function canSeeInFormFields($formSelector, $params) {
1049 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInFormFields', func_get_args()));
1050 |     }
1051 |     /**
1052 |      * [!] Method is generated. Documentation taken from corresponding module.
1053 |      *
1054 |      * Checks if the array of form parameters (name => value) are set on the form matched with the
1055 |      * passed selector.
1056 |      *
1057 |      * ``` php
1058 |      * <?php
1059 |      * $I->seeInFormFields('form[name=myform]', [
1060 |      *      'input1' => 'value',
1061 |      *      'input2' => 'other value',
1062 |      * ]);
1063 |      * ?>
1064 |      * ```
1065 |      *
1066 |      * For multi-select elements, or to check values of multiple elements with the same name, an
1067 |      * array may be passed:
1068 |      *
1069 |      * ``` php
1070 |      * <?php
1071 |      * $I->seeInFormFields('.form-class', [
1072 |      *      'multiselect' => [
1073 |      *          'value1',
1074 |      *          'value2',
1075 |      *      ],
1076 |      *      'checkbox[]' => [
1077 |      *          'a checked value',
1078 |      *          'another checked value',
1079 |      *      ],
1080 |      * ]);
1081 |      * ?>
1082 |      * ```
1083 |      *
1084 |      * Additionally, checkbox values can be checked with a boolean.
1085 |      *
1086 |      * ``` php
1087 |      * <?php
1088 |      * $I->seeInFormFields('#form-id', [
1089 |      *      'checkbox1' => true,        // passes if checked
1090 |      *      'checkbox2' => false,       // passes if unchecked
1091 |      * ]);
1092 |      * ?>
1093 |      * ```
1094 |      *
1095 |      * Pair this with submitForm for quick testing magic.
1096 |      *
1097 |      * ``` php
1098 |      * <?php
1099 |      * $form = [
1100 |      *      'field1' => 'value',
1101 |      *      'field2' => 'another value',
1102 |      *      'checkbox1' => true,
1103 |      *      // ...
1104 |      * ];
1105 |      * $I->submitForm('//form[@id=my-form]', $form, 'submitButton');
1106 |      * // $I->amOnPage('/path/to/form-page') may be needed
1107 |      * $I->seeInFormFields('//form[@id=my-form]', $form);
1108 |      * ?>
1109 |      * ```
1110 |      *
1111 |      * @param $formSelector
1112 |      * @param $params
1113 |      * @see \Codeception\Lib\InnerBrowser::seeInFormFields()
1114 |      */
1115 |     public function seeInFormFields($formSelector, $params) {
1116 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInFormFields', func_get_args()));
1117 |     }
1118 | 
1119 |  
1120 |     /**
1121 |      * [!] Method is generated. Documentation taken from corresponding module.
1122 |      *
1123 |      * Checks if the array of form parameters (name => value) are not set on the form matched with
1124 |      * the passed selector.
1125 |      *
1126 |      * ``` php
1127 |      * <?php
1128 |      * $I->dontSeeInFormFields('form[name=myform]', [
1129 |      *      'input1' => 'non-existent value',
1130 |      *      'input2' => 'other non-existent value',
1131 |      * ]);
1132 |      * ?>
1133 |      * ```
1134 |      *
1135 |      * To check that an element hasn't been assigned any one of many values, an array can be passed
1136 |      * as the value:
1137 |      *
1138 |      * ``` php
1139 |      * <?php
1140 |      * $I->dontSeeInFormFields('.form-class', [
1141 |      *      'fieldName' => [
1142 |      *          'This value shouldn\'t be set',
1143 |      *          'And this value shouldn\'t be set',
1144 |      *      ],
1145 |      * ]);
1146 |      * ?>
1147 |      * ```
1148 |      *
1149 |      * Additionally, checkbox values can be checked with a boolean.
1150 |      *
1151 |      * ``` php
1152 |      * <?php
1153 |      * $I->dontSeeInFormFields('#form-id', [
1154 |      *      'checkbox1' => true,        // fails if checked
1155 |      *      'checkbox2' => false,       // fails if unchecked
1156 |      * ]);
1157 |      * ?>
1158 |      * ```
1159 |      *
1160 |      * @param $formSelector
1161 |      * @param $params
1162 |      * Conditional Assertion: Test won't be stopped on fail
1163 |      * @see \Codeception\Lib\InnerBrowser::dontSeeInFormFields()
1164 |      */
1165 |     public function cantSeeInFormFields($formSelector, $params) {
1166 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInFormFields', func_get_args()));
1167 |     }
1168 |     /**
1169 |      * [!] Method is generated. Documentation taken from corresponding module.
1170 |      *
1171 |      * Checks if the array of form parameters (name => value) are not set on the form matched with
1172 |      * the passed selector.
1173 |      *
1174 |      * ``` php
1175 |      * <?php
1176 |      * $I->dontSeeInFormFields('form[name=myform]', [
1177 |      *      'input1' => 'non-existent value',
1178 |      *      'input2' => 'other non-existent value',
1179 |      * ]);
1180 |      * ?>
1181 |      * ```
1182 |      *
1183 |      * To check that an element hasn't been assigned any one of many values, an array can be passed
1184 |      * as the value:
1185 |      *
1186 |      * ``` php
1187 |      * <?php
1188 |      * $I->dontSeeInFormFields('.form-class', [
1189 |      *      'fieldName' => [
1190 |      *          'This value shouldn\'t be set',
1191 |      *          'And this value shouldn\'t be set',
1192 |      *      ],
1193 |      * ]);
1194 |      * ?>
1195 |      * ```
1196 |      *
1197 |      * Additionally, checkbox values can be checked with a boolean.
1198 |      *
1199 |      * ``` php
1200 |      * <?php
1201 |      * $I->dontSeeInFormFields('#form-id', [
1202 |      *      'checkbox1' => true,        // fails if checked
1203 |      *      'checkbox2' => false,       // fails if unchecked
1204 |      * ]);
1205 |      * ?>
1206 |      * ```
1207 |      *
1208 |      * @param $formSelector
1209 |      * @param $params
1210 |      * @see \Codeception\Lib\InnerBrowser::dontSeeInFormFields()
1211 |      */
1212 |     public function dontSeeInFormFields($formSelector, $params) {
1213 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeInFormFields', func_get_args()));
1214 |     }
1215 | 
1216 |  
1217 |     /**
1218 |      * [!] Method is generated. Documentation taken from corresponding module.
1219 |      *
1220 |      * Submits the given form on the page, optionally with the given form
1221 |      * values.  Pass the form field's values as an array in the second
1222 |      * parameter.
1223 |      *
1224 |      * Although this function can be used as a short-hand version of
1225 |      * `fillField()`, `selectOption()`, `click()` etc. it has some important
1226 |      * differences:
1227 |      *
1228 |      *  * Only field *names* may be used, not CSS/XPath selectors nor field labels
1229 |      *  * If a field is sent to this function that does *not* exist on the page,
1230 |      *    it will silently be added to the HTTP request.  This is helpful for testing
1231 |      *    some types of forms, but be aware that you will *not* get an exception
1232 |      *    like you would if you called `fillField()` or `selectOption()` with
1233 |      *    a missing field.
1234 |      *
1235 |      * Fields that are not provided will be filled by their values from the page,
1236 |      * or from any previous calls to `fillField()`, `selectOption()` etc.
1237 |      * You don't need to click the 'Submit' button afterwards.
1238 |      * This command itself triggers the request to form's action.
1239 |      *
1240 |      * You can optionally specify which button's value to include
1241 |      * in the request with the last parameter (as an alternative to
1242 |      * explicitly setting its value in the second parameter), as
1243 |      * button values are not otherwise included in the request.
1244 |      *
1245 |      * Examples:
1246 |      *
1247 |      * ``` php
1248 |      * <?php
1249 |      * $I->submitForm('#login', [
1250 |      *     'login' => 'davert',
1251 |      *     'password' => '123456'
1252 |      * ]);
1253 |      * // or
1254 |      * $I->submitForm('#login', [
1255 |      *     'login' => 'davert',
1256 |      *     'password' => '123456'
1257 |      * ], 'submitButtonName');
1258 |      *
1259 |      * ```
1260 |      *
1261 |      * For example, given this sample "Sign Up" form:
1262 |      *
1263 |      * ``` html
1264 |      * <form action="/sign_up">
1265 |      *     Login:
1266 |      *     <input type="text" name="user[login]" /><br/>
1267 |      *     Password:
1268 |      *     <input type="password" name="user[password]" /><br/>
1269 |      *     Do you agree to our terms?
1270 |      *     <input type="checkbox" name="user[agree]" /><br/>
1271 |      *     Select pricing plan:
1272 |      *     <select name="plan">
1273 |      *         <option value="1">Free</option>
1274 |      *         <option value="2" selected="selected">Paid</option>
1275 |      *     </select>
1276 |      *     <input type="submit" name="submitButton" value="Submit" />
1277 |      * </form>
1278 |      * ```
1279 |      *
1280 |      * You could write the following to submit it:
1281 |      *
1282 |      * ``` php
1283 |      * <?php
1284 |      * $I->submitForm(
1285 |      *     '#userForm',
1286 |      *     [
1287 |      *         'user' => [
1288 |      *             'login' => 'Davert',
1289 |      *             'password' => '123456',
1290 |      *             'agree' => true
1291 |      *         ]
1292 |      *     ],
1293 |      *     'submitButton'
1294 |      * );
1295 |      * ```
1296 |      * Note that "2" will be the submitted value for the "plan" field, as it is
1297 |      * the selected option.
1298 |      *
1299 |      * You can also emulate a JavaScript submission by not specifying any
1300 |      * buttons in the third parameter to submitForm.
1301 |      *
1302 |      * ```php
1303 |      * <?php
1304 |      * $I->submitForm(
1305 |      *     '#userForm',
1306 |      *     [
1307 |      *         'user' => [
1308 |      *             'login' => 'Davert',
1309 |      *             'password' => '123456',
1310 |      *             'agree' => true
1311 |      *         ]
1312 |      *     ]
1313 |      * );
1314 |      * ```
1315 |      *
1316 |      * This function works well when paired with `seeInFormFields()`
1317 |      * for quickly testing CRUD interfaces and form validation logic.
1318 |      *
1319 |      * ``` php
1320 |      * <?php
1321 |      * $form = [
1322 |      *      'field1' => 'value',
1323 |      *      'field2' => 'another value',
1324 |      *      'checkbox1' => true,
1325 |      *      // ...
1326 |      * ];
1327 |      * $I->submitForm('#my-form', $form, 'submitButton');
1328 |      * // $I->amOnPage('/path/to/form-page') may be needed
1329 |      * $I->seeInFormFields('#my-form', $form);
1330 |      * ```
1331 |      *
1332 |      * Parameter values can be set to arrays for multiple input fields
1333 |      * of the same name, or multi-select combo boxes.  For checkboxes,
1334 |      * you can use either the string value or boolean `true`/`false` which will
1335 |      * be replaced by the checkbox's value in the DOM.
1336 |      *
1337 |      * ``` php
1338 |      * <?php
1339 |      * $I->submitForm('#my-form', [
1340 |      *      'field1' => 'value',
1341 |      *      'checkbox' => [
1342 |      *          'value of first checkbox',
1343 |      *          'value of second checkbox',
1344 |      *      ],
1345 |      *      'otherCheckboxes' => [
1346 |      *          true,
1347 |      *          false,
1348 |      *          false
1349 |      *      ],
1350 |      *      'multiselect' => [
1351 |      *          'first option value',
1352 |      *          'second option value'
1353 |      *      ]
1354 |      * ]);
1355 |      * ```
1356 |      *
1357 |      * Mixing string and boolean values for a checkbox's value is not supported
1358 |      * and may produce unexpected results.
1359 |      *
1360 |      * Field names ending in `[]` must be passed without the trailing square
1361 |      * bracket characters, and must contain an array for its value.  This allows
1362 |      * submitting multiple values with the same name, consider:
1363 |      *
1364 |      * ```php
1365 |      * <?php
1366 |      * // This will NOT work correctly
1367 |      * $I->submitForm('#my-form', [
1368 |      *     'field[]' => 'value',
1369 |      *     'field[]' => 'another value',  // 'field[]' is already a defined key
1370 |      * ]);
1371 |      * ```
1372 |      *
1373 |      * The solution is to pass an array value:
1374 |      *
1375 |      * ```php
1376 |      * <?php
1377 |      * // This way both values are submitted
1378 |      * $I->submitForm('#my-form', [
1379 |      *     'field' => [
1380 |      *         'value',
1381 |      *         'another value',
1382 |      *     ]
1383 |      * ]);
1384 |      * ```
1385 |      *
1386 |      * @param $selector
1387 |      * @param $params
1388 |      * @param $button
1389 |      * @see \Codeception\Lib\InnerBrowser::submitForm()
1390 |      */
1391 |     public function submitForm($selector, $params, $button = null) {
1392 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('submitForm', func_get_args()));
1393 |     }
1394 | 
1395 |  
1396 |     /**
1397 |      * [!] Method is generated. Documentation taken from corresponding module.
1398 |      *
1399 |      * Fills a text field or textarea with the given string.
1400 |      *
1401 |      * ``` php
1402 |      * <?php
1403 |      * $I->fillField("//input[@type='text']", "Hello World!");
1404 |      * $I->fillField(['name' => 'email'], 'jon@mail.com');
1405 |      * ?>
1406 |      * ```
1407 |      *
1408 |      * @param $field
1409 |      * @param $value
1410 |      * @see \Codeception\Lib\InnerBrowser::fillField()
1411 |      */
1412 |     public function fillField($field, $value) {
1413 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('fillField', func_get_args()));
1414 |     }
1415 | 
1416 |  
1417 |     /**
1418 |      * [!] Method is generated. Documentation taken from corresponding module.
1419 |      *
1420 |      * Selects an option in a select tag or in radio button group.
1421 |      *
1422 |      * ``` php
1423 |      * <?php
1424 |      * $I->selectOption('form select[name=account]', 'Premium');
1425 |      * $I->selectOption('form input[name=payment]', 'Monthly');
1426 |      * $I->selectOption('//form/select[@name=account]', 'Monthly');
1427 |      * ?>
1428 |      * ```
1429 |      *
1430 |      * Provide an array for the second argument to select multiple options:
1431 |      *
1432 |      * ``` php
1433 |      * <?php
1434 |      * $I->selectOption('Which OS do you use?', array('Windows','Linux'));
1435 |      * ?>
1436 |      * ```
1437 |      *
1438 |      * Or provide an associative array for the second argument to specifically define which selection method should be used:
1439 |      *
1440 |      * ``` php
1441 |      * <?php
1442 |      * $I->selectOption('Which OS do you use?', array('text' => 'Windows')); // Only search by text 'Windows'
1443 |      * $I->selectOption('Which OS do you use?', array('value' => 'windows')); // Only search by value 'windows'
1444 |      * ?>
1445 |      * ```
1446 |      *
1447 |      * @param $select
1448 |      * @param $option
1449 |      * @see \Codeception\Lib\InnerBrowser::selectOption()
1450 |      */
1451 |     public function selectOption($select, $option) {
1452 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('selectOption', func_get_args()));
1453 |     }
1454 | 
1455 |  
1456 |     /**
1457 |      * [!] Method is generated. Documentation taken from corresponding module.
1458 |      *
1459 |      * Ticks a checkbox. For radio buttons, use the `selectOption` method instead.
1460 |      *
1461 |      * ``` php
1462 |      * <?php
1463 |      * $I->checkOption('#agree');
1464 |      * ?>
1465 |      * ```
1466 |      *
1467 |      * @param $option
1468 |      * @see \Codeception\Lib\InnerBrowser::checkOption()
1469 |      */
1470 |     public function checkOption($option) {
1471 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('checkOption', func_get_args()));
1472 |     }
1473 | 
1474 |  
1475 |     /**
1476 |      * [!] Method is generated. Documentation taken from corresponding module.
1477 |      *
1478 |      * Unticks a checkbox.
1479 |      *
1480 |      * ``` php
1481 |      * <?php
1482 |      * $I->uncheckOption('#notify');
1483 |      * ?>
1484 |      * ```
1485 |      *
1486 |      * @param $option
1487 |      * @see \Codeception\Lib\InnerBrowser::uncheckOption()
1488 |      */
1489 |     public function uncheckOption($option) {
1490 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('uncheckOption', func_get_args()));
1491 |     }
1492 | 
1493 |  
1494 |     /**
1495 |      * [!] Method is generated. Documentation taken from corresponding module.
1496 |      *
1497 |      * Attaches a file relative to the Codeception data directory to the given file upload field.
1498 |      *
1499 |      * ``` php
1500 |      * <?php
1501 |      * // file is stored in 'tests/_data/prices.xls'
1502 |      * $I->attachFile('input[@type="file"]', 'prices.xls');
1503 |      * ?>
1504 |      * ```
1505 |      *
1506 |      * @param $field
1507 |      * @param $filename
1508 |      * @see \Codeception\Lib\InnerBrowser::attachFile()
1509 |      */
1510 |     public function attachFile($field, $filename) {
1511 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('attachFile', func_get_args()));
1512 |     }
1513 | 
1514 |  
1515 |     /**
1516 |      * [!] Method is generated. Documentation taken from corresponding module.
1517 |      *
1518 |      * If your page triggers an ajax request, you can perform it manually.
1519 |      * This action sends a GET ajax request with specified params.
1520 |      *
1521 |      * See ->sendAjaxPostRequest for examples.
1522 |      *
1523 |      * @param $uri
1524 |      * @param $params
1525 |      * @see \Codeception\Lib\InnerBrowser::sendAjaxGetRequest()
1526 |      */
1527 |     public function sendAjaxGetRequest($uri, $params = null) {
1528 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('sendAjaxGetRequest', func_get_args()));
1529 |     }
1530 | 
1531 |  
1532 |     /**
1533 |      * [!] Method is generated. Documentation taken from corresponding module.
1534 |      *
1535 |      * If your page triggers an ajax request, you can perform it manually.
1536 |      * This action sends a POST ajax request with specified params.
1537 |      * Additional params can be passed as array.
1538 |      *
1539 |      * Example:
1540 |      *
1541 |      * Imagine that by clicking checkbox you trigger ajax request which updates user settings.
1542 |      * We emulate that click by running this ajax request manually.
1543 |      *
1544 |      * ``` php
1545 |      * <?php
1546 |      * $I->sendAjaxPostRequest('/updateSettings', array('notifications' => true)); // POST
1547 |      * $I->sendAjaxGetRequest('/updateSettings', array('notifications' => true)); // GET
1548 |      *
1549 |      * ```
1550 |      *
1551 |      * @param $uri
1552 |      * @param $params
1553 |      * @see \Codeception\Lib\InnerBrowser::sendAjaxPostRequest()
1554 |      */
1555 |     public function sendAjaxPostRequest($uri, $params = null) {
1556 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('sendAjaxPostRequest', func_get_args()));
1557 |     }
1558 | 
1559 |  
1560 |     /**
1561 |      * [!] Method is generated. Documentation taken from corresponding module.
1562 |      *
1563 |      * If your page triggers an ajax request, you can perform it manually.
1564 |      * This action sends an ajax request with specified method and params.
1565 |      *
1566 |      * Example:
1567 |      *
1568 |      * You need to perform an ajax request specifying the HTTP method.
1569 |      *
1570 |      * ``` php
1571 |      * <?php
1572 |      * $I->sendAjaxRequest('PUT', '/posts/7', array('title' => 'new title'));
1573 |      *
1574 |      * ```
1575 |      *
1576 |      * @param $method
1577 |      * @param $uri
1578 |      * @param $params
1579 |      * @see \Codeception\Lib\InnerBrowser::sendAjaxRequest()
1580 |      */
1581 |     public function sendAjaxRequest($method, $uri, $params = null) {
1582 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('sendAjaxRequest', func_get_args()));
1583 |     }
1584 | 
1585 |  
1586 |     /**
1587 |      * [!] Method is generated. Documentation taken from corresponding module.
1588 |      *
1589 |      * Finds and returns the text contents of the given element.
1590 |      * If a fuzzy locator is used, the element is found using CSS, XPath,
1591 |      * and by matching the full page source by regular expression.
1592 |      *
1593 |      * ``` php
1594 |      * <?php
1595 |      * $heading = $I->grabTextFrom('h1');
1596 |      * $heading = $I->grabTextFrom('descendant-or-self::h1');
1597 |      * $value = $I->grabTextFrom('~<input value=(.*?)]~sgi'); // match with a regex
1598 |      * ?>
1599 |      * ```
1600 |      *
1601 |      * @param $cssOrXPathOrRegex
1602 |      *
1603 |      * @return mixed
1604 |      * @see \Codeception\Lib\InnerBrowser::grabTextFrom()
1605 |      */
1606 |     public function grabTextFrom($cssOrXPathOrRegex) {
1607 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('grabTextFrom', func_get_args()));
1608 |     }
1609 | 
1610 |  
1611 |     /**
1612 |      * [!] Method is generated. Documentation taken from corresponding module.
1613 |      *
1614 |      * Grabs the value of the given attribute value from the given element.
1615 |      * Fails if element is not found.
1616 |      *
1617 |      * ``` php
1618 |      * <?php
1619 |      * $I->grabAttributeFrom('#tooltip', 'title');
1620 |      * ?>
1621 |      * ```
1622 |      *
1623 |      *
1624 |      * @param $cssOrXpath
1625 |      * @param $attribute
1626 |      *
1627 |      * @return mixed
1628 |      * @see \Codeception\Lib\InnerBrowser::grabAttributeFrom()
1629 |      */
1630 |     public function grabAttributeFrom($cssOrXpath, $attribute) {
1631 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('grabAttributeFrom', func_get_args()));
1632 |     }
1633 | 
1634 |  
1635 |     /**
1636 |      * [!] Method is generated. Documentation taken from corresponding module.
1637 |      *
1638 |      * Grabs either the text content, or attribute values, of nodes
1639 |      * matched by $cssOrXpath and returns them as an array.
1640 |      *
1641 |      * ```html
1642 |      * <a href="#first">First</a>
1643 |      * <a href="#second">Second</a>
1644 |      * <a href="#third">Third</a>
1645 |      * ```
1646 |      *
1647 |      * ```php
1648 |      * <?php
1649 |      * // would return ['First', 'Second', 'Third']
1650 |      * $aLinkText = $I->grabMultiple('a');
1651 |      *
1652 |      * // would return ['#first', '#second', '#third']
1653 |      * $aLinks = $I->grabMultiple('a', 'href');
1654 |      * ?>
1655 |      * ```
1656 |      *
1657 |      * @param $cssOrXpath
1658 |      * @param $attribute
1659 |      * @return string[]
1660 |      * @see \Codeception\Lib\InnerBrowser::grabMultiple()
1661 |      */
1662 |     public function grabMultiple($cssOrXpath, $attribute = null) {
1663 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('grabMultiple', func_get_args()));
1664 |     }
1665 | 
1666 |  
1667 |     /**
1668 |      * [!] Method is generated. Documentation taken from corresponding module.
1669 |      *
1670 |      * @param $field
1671 |      *
1672 |      * @return array|mixed|null|string
1673 |      * @see \Codeception\Lib\InnerBrowser::grabValueFrom()
1674 |      */
1675 |     public function grabValueFrom($field) {
1676 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('grabValueFrom', func_get_args()));
1677 |     }
1678 | 
1679 |  
1680 |     /**
1681 |      * [!] Method is generated. Documentation taken from corresponding module.
1682 |      *
1683 |      * Sets a cookie with the given name and value.
1684 |      * You can set additional cookie params like `domain`, `path`, `expires`, `secure` in array passed as last argument.
1685 |      *
1686 |      * ``` php
1687 |      * <?php
1688 |      * $I->setCookie('PHPSESSID', 'el4ukv0kqbvoirg7nkp4dncpk3');
1689 |      * ?>
1690 |      * ```
1691 |      *
1692 |      * @param $name
1693 |      * @param $val
1694 |      * @param array $params
1695 |      *
1696 |      * @return mixed
1697 |      * @see \Codeception\Lib\InnerBrowser::setCookie()
1698 |      */
1699 |     public function setCookie($name, $val, $params = null) {
1700 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('setCookie', func_get_args()));
1701 |     }
1702 | 
1703 |  
1704 |     /**
1705 |      * [!] Method is generated. Documentation taken from corresponding module.
1706 |      *
1707 |      * Grabs a cookie value.
1708 |      * You can set additional cookie params like `domain`, `path` in array passed as last argument.
1709 |      *
1710 |      * @param $cookie
1711 |      *
1712 |      * @param array $params
1713 |      * @return mixed
1714 |      * @see \Codeception\Lib\InnerBrowser::grabCookie()
1715 |      */
1716 |     public function grabCookie($cookie, $params = null) {
1717 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('grabCookie', func_get_args()));
1718 |     }
1719 | 
1720 |  
1721 |     /**
1722 |      * [!] Method is generated. Documentation taken from corresponding module.
1723 |      *
1724 |      * Grabs current page source code.
1725 |      *
1726 |      * @throws ModuleException if no page was opened.
1727 |      *
1728 |      * @return string Current page source code.
1729 |      * @see \Codeception\Lib\InnerBrowser::grabPageSource()
1730 |      */
1731 |     public function grabPageSource() {
1732 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('grabPageSource', func_get_args()));
1733 |     }
1734 | 
1735 |  
1736 |     /**
1737 |      * [!] Method is generated. Documentation taken from corresponding module.
1738 |      *
1739 |      * Checks that a cookie with the given name is set.
1740 |      * You can set additional cookie params like `domain`, `path` as array passed in last argument.
1741 |      *
1742 |      * ``` php
1743 |      * <?php
1744 |      * $I->seeCookie('PHPSESSID');
1745 |      * ?>
1746 |      * ```
1747 |      *
1748 |      * @param $cookie
1749 |      * @param array $params
1750 |      * @return mixed
1751 |      * Conditional Assertion: Test won't be stopped on fail
1752 |      * @see \Codeception\Lib\InnerBrowser::seeCookie()
1753 |      */
1754 |     public function canSeeCookie($cookie, $params = null) {
1755 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeCookie', func_get_args()));
1756 |     }
1757 |     /**
1758 |      * [!] Method is generated. Documentation taken from corresponding module.
1759 |      *
1760 |      * Checks that a cookie with the given name is set.
1761 |      * You can set additional cookie params like `domain`, `path` as array passed in last argument.
1762 |      *
1763 |      * ``` php
1764 |      * <?php
1765 |      * $I->seeCookie('PHPSESSID');
1766 |      * ?>
1767 |      * ```
1768 |      *
1769 |      * @param $cookie
1770 |      * @param array $params
1771 |      * @return mixed
1772 |      * @see \Codeception\Lib\InnerBrowser::seeCookie()
1773 |      */
1774 |     public function seeCookie($cookie, $params = null) {
1775 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCookie', func_get_args()));
1776 |     }
1777 | 
1778 |  
1779 |     /**
1780 |      * [!] Method is generated. Documentation taken from corresponding module.
1781 |      *
1782 |      * Checks that there isn't a cookie with the given name.
1783 |      * You can set additional cookie params like `domain`, `path` as array passed in last argument.
1784 |      *
1785 |      * @param $cookie
1786 |      *
1787 |      * @param array $params
1788 |      * @return mixed
1789 |      * Conditional Assertion: Test won't be stopped on fail
1790 |      * @see \Codeception\Lib\InnerBrowser::dontSeeCookie()
1791 |      */
1792 |     public function cantSeeCookie($cookie, $params = null) {
1793 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeCookie', func_get_args()));
1794 |     }
1795 |     /**
1796 |      * [!] Method is generated. Documentation taken from corresponding module.
1797 |      *
1798 |      * Checks that there isn't a cookie with the given name.
1799 |      * You can set additional cookie params like `domain`, `path` as array passed in last argument.
1800 |      *
1801 |      * @param $cookie
1802 |      *
1803 |      * @param array $params
1804 |      * @return mixed
1805 |      * @see \Codeception\Lib\InnerBrowser::dontSeeCookie()
1806 |      */
1807 |     public function dontSeeCookie($cookie, $params = null) {
1808 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeCookie', func_get_args()));
1809 |     }
1810 | 
1811 |  
1812 |     /**
1813 |      * [!] Method is generated. Documentation taken from corresponding module.
1814 |      *
1815 |      * Unsets cookie with the given name.
1816 |      * You can set additional cookie params like `domain`, `path` in array passed as last argument.
1817 |      *
1818 |      * @param $cookie
1819 |      *
1820 |      * @param array $params
1821 |      * @return mixed
1822 |      * @see \Codeception\Lib\InnerBrowser::resetCookie()
1823 |      */
1824 |     public function resetCookie($name, $params = null) {
1825 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('resetCookie', func_get_args()));
1826 |     }
1827 | 
1828 |  
1829 |     /**
1830 |      * [!] Method is generated. Documentation taken from corresponding module.
1831 |      *
1832 |      * Checks that the given element exists on the page and is visible.
1833 |      * You can also specify expected attributes of this element.
1834 |      *
1835 |      * ``` php
1836 |      * <?php
1837 |      * $I->seeElement('.error');
1838 |      * $I->seeElement('//form/input[1]');
1839 |      * $I->seeElement('input', ['name' => 'login']);
1840 |      * $I->seeElement('input', ['value' => '123456']);
1841 |      *
1842 |      * // strict locator in first arg, attributes in second
1843 |      * $I->seeElement(['css' => 'form input'], ['name' => 'login']);
1844 |      * ?>
1845 |      * ```
1846 |      *
1847 |      * @param $selector
1848 |      * @param array $attributes
1849 |      * @return
1850 |      * Conditional Assertion: Test won't be stopped on fail
1851 |      * @see \Codeception\Lib\InnerBrowser::seeElement()
1852 |      */
1853 |     public function canSeeElement($selector, $attributes = null) {
1854 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeElement', func_get_args()));
1855 |     }
1856 |     /**
1857 |      * [!] Method is generated. Documentation taken from corresponding module.
1858 |      *
1859 |      * Checks that the given element exists on the page and is visible.
1860 |      * You can also specify expected attributes of this element.
1861 |      *
1862 |      * ``` php
1863 |      * <?php
1864 |      * $I->seeElement('.error');
1865 |      * $I->seeElement('//form/input[1]');
1866 |      * $I->seeElement('input', ['name' => 'login']);
1867 |      * $I->seeElement('input', ['value' => '123456']);
1868 |      *
1869 |      * // strict locator in first arg, attributes in second
1870 |      * $I->seeElement(['css' => 'form input'], ['name' => 'login']);
1871 |      * ?>
1872 |      * ```
1873 |      *
1874 |      * @param $selector
1875 |      * @param array $attributes
1876 |      * @return
1877 |      * @see \Codeception\Lib\InnerBrowser::seeElement()
1878 |      */
1879 |     public function seeElement($selector, $attributes = null) {
1880 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeElement', func_get_args()));
1881 |     }
1882 | 
1883 |  
1884 |     /**
1885 |      * [!] Method is generated. Documentation taken from corresponding module.
1886 |      *
1887 |      * Checks that the given element is invisible or not present on the page.
1888 |      * You can also specify expected attributes of this element.
1889 |      *
1890 |      * ``` php
1891 |      * <?php
1892 |      * $I->dontSeeElement('.error');
1893 |      * $I->dontSeeElement('//form/input[1]');
1894 |      * $I->dontSeeElement('input', ['name' => 'login']);
1895 |      * $I->dontSeeElement('input', ['value' => '123456']);
1896 |      * ?>
1897 |      * ```
1898 |      *
1899 |      * @param $selector
1900 |      * @param array $attributes
1901 |      * Conditional Assertion: Test won't be stopped on fail
1902 |      * @see \Codeception\Lib\InnerBrowser::dontSeeElement()
1903 |      */
1904 |     public function cantSeeElement($selector, $attributes = null) {
1905 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeElement', func_get_args()));
1906 |     }
1907 |     /**
1908 |      * [!] Method is generated. Documentation taken from corresponding module.
1909 |      *
1910 |      * Checks that the given element is invisible or not present on the page.
1911 |      * You can also specify expected attributes of this element.
1912 |      *
1913 |      * ``` php
1914 |      * <?php
1915 |      * $I->dontSeeElement('.error');
1916 |      * $I->dontSeeElement('//form/input[1]');
1917 |      * $I->dontSeeElement('input', ['name' => 'login']);
1918 |      * $I->dontSeeElement('input', ['value' => '123456']);
1919 |      * ?>
1920 |      * ```
1921 |      *
1922 |      * @param $selector
1923 |      * @param array $attributes
1924 |      * @see \Codeception\Lib\InnerBrowser::dontSeeElement()
1925 |      */
1926 |     public function dontSeeElement($selector, $attributes = null) {
1927 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeElement', func_get_args()));
1928 |     }
1929 | 
1930 |  
1931 |     /**
1932 |      * [!] Method is generated. Documentation taken from corresponding module.
1933 |      *
1934 |      * Checks that there are a certain number of elements matched by the given locator on the page.
1935 |      *
1936 |      * ``` php
1937 |      * <?php
1938 |      * $I->seeNumberOfElements('tr', 10);
1939 |      * $I->seeNumberOfElements('tr', [0,10]); //between 0 and 10 elements
1940 |      * ?>
1941 |      * ```
1942 |      * @param $selector
1943 |      * @param mixed $expected :
1944 |      * - string: strict number
1945 |      * - array: range of numbers [0,10]
1946 |      * Conditional Assertion: Test won't be stopped on fail
1947 |      * @see \Codeception\Lib\InnerBrowser::seeNumberOfElements()
1948 |      */
1949 |     public function canSeeNumberOfElements($selector, $expected) {
1950 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeNumberOfElements', func_get_args()));
1951 |     }
1952 |     /**
1953 |      * [!] Method is generated. Documentation taken from corresponding module.
1954 |      *
1955 |      * Checks that there are a certain number of elements matched by the given locator on the page.
1956 |      *
1957 |      * ``` php
1958 |      * <?php
1959 |      * $I->seeNumberOfElements('tr', 10);
1960 |      * $I->seeNumberOfElements('tr', [0,10]); //between 0 and 10 elements
1961 |      * ?>
1962 |      * ```
1963 |      * @param $selector
1964 |      * @param mixed $expected :
1965 |      * - string: strict number
1966 |      * - array: range of numbers [0,10]
1967 |      * @see \Codeception\Lib\InnerBrowser::seeNumberOfElements()
1968 |      */
1969 |     public function seeNumberOfElements($selector, $expected) {
1970 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeNumberOfElements', func_get_args()));
1971 |     }
1972 | 
1973 |  
1974 |     /**
1975 |      * [!] Method is generated. Documentation taken from corresponding module.
1976 |      *
1977 |      * Checks that the given option is selected.
1978 |      *
1979 |      * ``` php
1980 |      * <?php
1981 |      * $I->seeOptionIsSelected('#form input[name=payment]', 'Visa');
1982 |      * ?>
1983 |      * ```
1984 |      *
1985 |      * @param $selector
1986 |      * @param $optionText
1987 |      *
1988 |      * @return mixed
1989 |      * Conditional Assertion: Test won't be stopped on fail
1990 |      * @see \Codeception\Lib\InnerBrowser::seeOptionIsSelected()
1991 |      */
1992 |     public function canSeeOptionIsSelected($selector, $optionText) {
1993 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeOptionIsSelected', func_get_args()));
1994 |     }
1995 |     /**
1996 |      * [!] Method is generated. Documentation taken from corresponding module.
1997 |      *
1998 |      * Checks that the given option is selected.
1999 |      *
2000 |      * ``` php
2001 |      * <?php
2002 |      * $I->seeOptionIsSelected('#form input[name=payment]', 'Visa');
2003 |      * ?>
2004 |      * ```
2005 |      *
2006 |      * @param $selector
2007 |      * @param $optionText
2008 |      *
2009 |      * @return mixed
2010 |      * @see \Codeception\Lib\InnerBrowser::seeOptionIsSelected()
2011 |      */
2012 |     public function seeOptionIsSelected($selector, $optionText) {
2013 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeOptionIsSelected', func_get_args()));
2014 |     }
2015 | 
2016 |  
2017 |     /**
2018 |      * [!] Method is generated. Documentation taken from corresponding module.
2019 |      *
2020 |      * Checks that the given option is not selected.
2021 |      *
2022 |      * ``` php
2023 |      * <?php
2024 |      * $I->dontSeeOptionIsSelected('#form input[name=payment]', 'Visa');
2025 |      * ?>
2026 |      * ```
2027 |      *
2028 |      * @param $selector
2029 |      * @param $optionText
2030 |      *
2031 |      * @return mixed
2032 |      * Conditional Assertion: Test won't be stopped on fail
2033 |      * @see \Codeception\Lib\InnerBrowser::dontSeeOptionIsSelected()
2034 |      */
2035 |     public function cantSeeOptionIsSelected($selector, $optionText) {
2036 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeOptionIsSelected', func_get_args()));
2037 |     }
2038 |     /**
2039 |      * [!] Method is generated. Documentation taken from corresponding module.
2040 |      *
2041 |      * Checks that the given option is not selected.
2042 |      *
2043 |      * ``` php
2044 |      * <?php
2045 |      * $I->dontSeeOptionIsSelected('#form input[name=payment]', 'Visa');
2046 |      * ?>
2047 |      * ```
2048 |      *
2049 |      * @param $selector
2050 |      * @param $optionText
2051 |      *
2052 |      * @return mixed
2053 |      * @see \Codeception\Lib\InnerBrowser::dontSeeOptionIsSelected()
2054 |      */
2055 |     public function dontSeeOptionIsSelected($selector, $optionText) {
2056 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeOptionIsSelected', func_get_args()));
2057 |     }
2058 | 
2059 |  
2060 |     /**
2061 |      * [!] Method is generated. Documentation taken from corresponding module.
2062 |      *
2063 |      * Asserts that current page has 404 response status code.
2064 |      * Conditional Assertion: Test won't be stopped on fail
2065 |      * @see \Codeception\Lib\InnerBrowser::seePageNotFound()
2066 |      */
2067 |     public function canSeePageNotFound() {
2068 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seePageNotFound', func_get_args()));
2069 |     }
2070 |     /**
2071 |      * [!] Method is generated. Documentation taken from corresponding module.
2072 |      *
2073 |      * Asserts that current page has 404 response status code.
2074 |      * @see \Codeception\Lib\InnerBrowser::seePageNotFound()
2075 |      */
2076 |     public function seePageNotFound() {
2077 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seePageNotFound', func_get_args()));
2078 |     }
2079 | 
2080 |  
2081 |     /**
2082 |      * [!] Method is generated. Documentation taken from corresponding module.
2083 |      *
2084 |      * Checks that response code is equal to value provided.
2085 |      *
2086 |      * ```php
2087 |      * <?php
2088 |      * $I->seeResponseCodeIs(200);
2089 |      *
2090 |      * // recommended \Codeception\Util\HttpCode
2091 |      * $I->seeResponseCodeIs(\Codeception\Util\HttpCode::OK);
2092 |      * ```
2093 |      *
2094 |      * @param $code
2095 |      * Conditional Assertion: Test won't be stopped on fail
2096 |      * @see \Codeception\Lib\InnerBrowser::seeResponseCodeIs()
2097 |      */
2098 |     public function canSeeResponseCodeIs($code) {
2099 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeResponseCodeIs', func_get_args()));
2100 |     }
2101 |     /**
2102 |      * [!] Method is generated. Documentation taken from corresponding module.
2103 |      *
2104 |      * Checks that response code is equal to value provided.
2105 |      *
2106 |      * ```php
2107 |      * <?php
2108 |      * $I->seeResponseCodeIs(200);
2109 |      *
2110 |      * // recommended \Codeception\Util\HttpCode
2111 |      * $I->seeResponseCodeIs(\Codeception\Util\HttpCode::OK);
2112 |      * ```
2113 |      *
2114 |      * @param $code
2115 |      * @see \Codeception\Lib\InnerBrowser::seeResponseCodeIs()
2116 |      */
2117 |     public function seeResponseCodeIs($code) {
2118 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeResponseCodeIs', func_get_args()));
2119 |     }
2120 | 
2121 |  
2122 |     /**
2123 |      * [!] Method is generated. Documentation taken from corresponding module.
2124 |      *
2125 |      * Checks that response code is equal to value provided.
2126 |      *
2127 |      * ```php
2128 |      * <?php
2129 |      * $I->dontSeeResponseCodeIs(200);
2130 |      *
2131 |      * // recommended \Codeception\Util\HttpCode
2132 |      * $I->dontSeeResponseCodeIs(\Codeception\Util\HttpCode::OK);
2133 |      * ```
2134 |      * @param $code
2135 |      * Conditional Assertion: Test won't be stopped on fail
2136 |      * @see \Codeception\Lib\InnerBrowser::dontSeeResponseCodeIs()
2137 |      */
2138 |     public function cantSeeResponseCodeIs($code) {
2139 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeResponseCodeIs', func_get_args()));
2140 |     }
2141 |     /**
2142 |      * [!] Method is generated. Documentation taken from corresponding module.
2143 |      *
2144 |      * Checks that response code is equal to value provided.
2145 |      *
2146 |      * ```php
2147 |      * <?php
2148 |      * $I->dontSeeResponseCodeIs(200);
2149 |      *
2150 |      * // recommended \Codeception\Util\HttpCode
2151 |      * $I->dontSeeResponseCodeIs(\Codeception\Util\HttpCode::OK);
2152 |      * ```
2153 |      * @param $code
2154 |      * @see \Codeception\Lib\InnerBrowser::dontSeeResponseCodeIs()
2155 |      */
2156 |     public function dontSeeResponseCodeIs($code) {
2157 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeResponseCodeIs', func_get_args()));
2158 |     }
2159 | 
2160 |  
2161 |     /**
2162 |      * [!] Method is generated. Documentation taken from corresponding module.
2163 |      *
2164 |      * Checks that the page title contains the given string.
2165 |      *
2166 |      * ``` php
2167 |      * <?php
2168 |      * $I->seeInTitle('Blog - Post #1');
2169 |      * ?>
2170 |      * ```
2171 |      *
2172 |      * @param $title
2173 |      *
2174 |      * @return mixed
2175 |      * Conditional Assertion: Test won't be stopped on fail
2176 |      * @see \Codeception\Lib\InnerBrowser::seeInTitle()
2177 |      */
2178 |     public function canSeeInTitle($title) {
2179 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInTitle', func_get_args()));
2180 |     }
2181 |     /**
2182 |      * [!] Method is generated. Documentation taken from corresponding module.
2183 |      *
2184 |      * Checks that the page title contains the given string.
2185 |      *
2186 |      * ``` php
2187 |      * <?php
2188 |      * $I->seeInTitle('Blog - Post #1');
2189 |      * ?>
2190 |      * ```
2191 |      *
2192 |      * @param $title
2193 |      *
2194 |      * @return mixed
2195 |      * @see \Codeception\Lib\InnerBrowser::seeInTitle()
2196 |      */
2197 |     public function seeInTitle($title) {
2198 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInTitle', func_get_args()));
2199 |     }
2200 | 
2201 |  
2202 |     /**
2203 |      * [!] Method is generated. Documentation taken from corresponding module.
2204 |      *
2205 |      * Checks that the page title does not contain the given string.
2206 |      *
2207 |      * @param $title
2208 |      *
2209 |      * @return mixed
2210 |      * Conditional Assertion: Test won't be stopped on fail
2211 |      * @see \Codeception\Lib\InnerBrowser::dontSeeInTitle()
2212 |      */
2213 |     public function cantSeeInTitle($title) {
2214 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInTitle', func_get_args()));
2215 |     }
2216 |     /**
2217 |      * [!] Method is generated. Documentation taken from corresponding module.
2218 |      *
2219 |      * Checks that the page title does not contain the given string.
2220 |      *
2221 |      * @param $title
2222 |      *
2223 |      * @return mixed
2224 |      * @see \Codeception\Lib\InnerBrowser::dontSeeInTitle()
2225 |      */
2226 |     public function dontSeeInTitle($title) {
2227 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeInTitle', func_get_args()));
2228 |     }
2229 | 
2230 |  
2231 |     /**
2232 |      * [!] Method is generated. Documentation taken from corresponding module.
2233 |      *
2234 |      * Switch to iframe or frame on the page.
2235 |      *
2236 |      * Example:
2237 |      * ``` html
2238 |      * <iframe name="another_frame" src="http://example.com">
2239 |      * ```
2240 |      *
2241 |      * ``` php
2242 |      * <?php
2243 |      * # switch to iframe
2244 |      * $I->switchToIframe("another_frame");
2245 |      * ```
2246 |      *
2247 |      * @param string $name
2248 |      * @see \Codeception\Lib\InnerBrowser::switchToIframe()
2249 |      */
2250 |     public function switchToIframe($name) {
2251 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('switchToIframe', func_get_args()));
2252 |     }
2253 | 
2254 |  
2255 |     /**
2256 |      * [!] Method is generated. Documentation taken from corresponding module.
2257 |      *
2258 |      * Moves back in history.
2259 |      *
2260 |      * @param int $numberOfSteps (default value 1)
2261 |      * @see \Codeception\Lib\InnerBrowser::moveBack()
2262 |      */
2263 |     public function moveBack($numberOfSteps = null) {
2264 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('moveBack', func_get_args()));
2265 |     }
2266 | }
2267 | 


--------------------------------------------------------------------------------
/tests/tests/_support/_generated/FunctionalTesterActions.php:
--------------------------------------------------------------------------------
   1 | <?php  //[STAMP] e9812a073bd71ee3ac3750592f7e35a4
   2 | namespace _generated;
   3 | 
   4 | // This class was automatically generated by build task
   5 | // You should not change it manually as it will be overwritten on next build
   6 | // @codingStandardsIgnoreFile
   7 | 
   8 | use Helper\Functional;
   9 | use Codeception\Module\Yii2;
  10 | 
  11 | trait FunctionalTesterActions
  12 | {
  13 |     /**
  14 |      * @return \Codeception\Scenario
  15 |      */
  16 |     abstract protected function getScenario();
  17 | 
  18 |     
  19 |     /**
  20 |      * [!] Method is generated. Documentation taken from corresponding module.
  21 |      *
  22 |      * Authorizes user on a site without submitting login form.
  23 |      * Use it for fast pragmatic authorization in functional tests.
  24 |      *
  25 |      * ```php
  26 |      * <?php
  27 |      * // User is found by id
  28 |      * $I->amLoggedInAs(1);
  29 |      *
  30 |      * // User object is passed as parameter
  31 |      * $admin = \app\models\User::findByUsername('admin');
  32 |      * $I->amLoggedInAs($admin);
  33 |      * ```
  34 |      * Requires `user` component to be enabled and configured.
  35 |      *
  36 |      * @param $user
  37 |      * @throws ModuleException
  38 |      * @see \Codeception\Module\Yii2::amLoggedInAs()
  39 |      */
  40 |     public function amLoggedInAs($user) {
  41 |         return $this->getScenario()->runStep(new \Codeception\Step\Condition('amLoggedInAs', func_get_args()));
  42 |     }
  43 | 
  44 |  
  45 |     /**
  46 |      * [!] Method is generated. Documentation taken from corresponding module.
  47 |      *
  48 |      * Creates and loads fixtures from a config.
  49 |      * Signature is the same as for `fixtures()` method of `yii\test\FixtureTrait`
  50 |      *
  51 |      * ```php
  52 |      * <?php
  53 |      * $I->haveFixtures([
  54 |      *     'posts' => PostsFixture::className(),
  55 |      *     'user' => [
  56 |      *         'class' => UserFixture::className(),
  57 |      *         'dataFile' => '@tests/_data/models/user.php',
  58 |      *      ],
  59 |      * ]);
  60 |      * ```
  61 |      *
  62 |      * Note: if you need to load fixtures before the test (probably before the cleanup transaction is started;
  63 |      * `cleanup` options is `true` by default), you can specify fixtures with _fixtures method of a testcase
  64 |      * ```php
  65 |      * <?php
  66 |      * // inside Cest file or Codeception\TestCase\Unit
  67 |      * public function _fixtures(){
  68 |      *     return [
  69 |      *         'user' => [
  70 |      *             'class' => UserFixture::className(),
  71 |      *             'dataFile' => codecept_data_dir() . 'user.php'
  72 |      *         ]
  73 |      *     ];
  74 |      * }
  75 |      * ```
  76 |      * instead of defining `haveFixtures` in Cest `_before`
  77 |      *
  78 |      * @param $fixtures
  79 |      * @part fixtures
  80 |      * @see \Codeception\Module\Yii2::haveFixtures()
  81 |      */
  82 |     public function haveFixtures($fixtures) {
  83 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('haveFixtures', func_get_args()));
  84 |     }
  85 | 
  86 |  
  87 |     /**
  88 |      * [!] Method is generated. Documentation taken from corresponding module.
  89 |      *
  90 |      * Returns all loaded fixtures.
  91 |      * Array of fixture instances
  92 |      *
  93 |      * @part fixtures
  94 |      * @return array
  95 |      * @see \Codeception\Module\Yii2::grabFixtures()
  96 |      */
  97 |     public function grabFixtures() {
  98 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('grabFixtures', func_get_args()));
  99 |     }
 100 | 
 101 |  
 102 |     /**
 103 |      * [!] Method is generated. Documentation taken from corresponding module.
 104 |      *
 105 |      * Gets a fixture by name.
 106 |      * Returns a Fixture instance. If a fixture is an instance of `\yii\test\BaseActiveFixture` a second parameter
 107 |      * can be used to return a specific model:
 108 |      *
 109 |      * ```php
 110 |      * <?php
 111 |      * $I->haveFixtures(['users' => UserFixture::className()]);
 112 |      *
 113 |      * $users = $I->grabFixture('users');
 114 |      *
 115 |      * // get first user by key, if a fixture is instance of ActiveFixture
 116 |      * $user = $I->grabFixture('users', 'user1');
 117 |      * ```
 118 |      *
 119 |      * @param $name
 120 |      * @return mixed
 121 |      * @throws ModuleException if a fixture is not found
 122 |      * @part fixtures
 123 |      * @see \Codeception\Module\Yii2::grabFixture()
 124 |      */
 125 |     public function grabFixture($name, $index = null) {
 126 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('grabFixture', func_get_args()));
 127 |     }
 128 | 
 129 |  
 130 |     /**
 131 |      * [!] Method is generated. Documentation taken from corresponding module.
 132 |      *
 133 |      * Inserts record into the database.
 134 |      *
 135 |      * ``` php
 136 |      * <?php
 137 |      * $user_id = $I->haveRecord('app\models\User', array('name' => 'Davert'));
 138 |      * ?>
 139 |      * ```
 140 |      *
 141 |      * @param $model
 142 |      * @param array $attributes
 143 |      * @return mixed
 144 |      * @part orm
 145 |      * @see \Codeception\Module\Yii2::haveRecord()
 146 |      */
 147 |     public function haveRecord($model, $attributes = null) {
 148 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('haveRecord', func_get_args()));
 149 |     }
 150 | 
 151 |  
 152 |     /**
 153 |      * [!] Method is generated. Documentation taken from corresponding module.
 154 |      *
 155 |      * Checks that record exists in database.
 156 |      *
 157 |      * ``` php
 158 |      * $I->seeRecord('app\models\User', array('name' => 'davert'));
 159 |      * ```
 160 |      *
 161 |      * @param $model
 162 |      * @param array $attributes
 163 |      * @part orm
 164 |      * Conditional Assertion: Test won't be stopped on fail
 165 |      * @see \Codeception\Module\Yii2::seeRecord()
 166 |      */
 167 |     public function canSeeRecord($model, $attributes = null) {
 168 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeRecord', func_get_args()));
 169 |     }
 170 |     /**
 171 |      * [!] Method is generated. Documentation taken from corresponding module.
 172 |      *
 173 |      * Checks that record exists in database.
 174 |      *
 175 |      * ``` php
 176 |      * $I->seeRecord('app\models\User', array('name' => 'davert'));
 177 |      * ```
 178 |      *
 179 |      * @param $model
 180 |      * @param array $attributes
 181 |      * @part orm
 182 |      * @see \Codeception\Module\Yii2::seeRecord()
 183 |      */
 184 |     public function seeRecord($model, $attributes = null) {
 185 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeRecord', func_get_args()));
 186 |     }
 187 | 
 188 |  
 189 |     /**
 190 |      * [!] Method is generated. Documentation taken from corresponding module.
 191 |      *
 192 |      * Checks that record does not exist in database.
 193 |      *
 194 |      * ``` php
 195 |      * $I->dontSeeRecord('app\models\User', array('name' => 'davert'));
 196 |      * ```
 197 |      *
 198 |      * @param $model
 199 |      * @param array $attributes
 200 |      * @part orm
 201 |      * Conditional Assertion: Test won't be stopped on fail
 202 |      * @see \Codeception\Module\Yii2::dontSeeRecord()
 203 |      */
 204 |     public function cantSeeRecord($model, $attributes = null) {
 205 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeRecord', func_get_args()));
 206 |     }
 207 |     /**
 208 |      * [!] Method is generated. Documentation taken from corresponding module.
 209 |      *
 210 |      * Checks that record does not exist in database.
 211 |      *
 212 |      * ``` php
 213 |      * $I->dontSeeRecord('app\models\User', array('name' => 'davert'));
 214 |      * ```
 215 |      *
 216 |      * @param $model
 217 |      * @param array $attributes
 218 |      * @part orm
 219 |      * @see \Codeception\Module\Yii2::dontSeeRecord()
 220 |      */
 221 |     public function dontSeeRecord($model, $attributes = null) {
 222 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeRecord', func_get_args()));
 223 |     }
 224 | 
 225 |  
 226 |     /**
 227 |      * [!] Method is generated. Documentation taken from corresponding module.
 228 |      *
 229 |      * Retrieves record from database
 230 |      *
 231 |      * ``` php
 232 |      * $category = $I->grabRecord('app\models\User', array('name' => 'davert'));
 233 |      * ```
 234 |      *
 235 |      * @param $model
 236 |      * @param array $attributes
 237 |      * @return mixed
 238 |      * @part orm
 239 |      * @see \Codeception\Module\Yii2::grabRecord()
 240 |      */
 241 |     public function grabRecord($model, $attributes = null) {
 242 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('grabRecord', func_get_args()));
 243 |     }
 244 | 
 245 |  
 246 |     /**
 247 |      * [!] Method is generated. Documentation taken from corresponding module.
 248 |      *
 249 |      * Similar to amOnPage but accepts route as first argument and params as second
 250 |      *
 251 |      * ```
 252 |      * $I->amOnRoute('site/view', ['page' => 'about']);
 253 |      * ```
 254 |      *
 255 |      * @see \Codeception\Module\Yii2::amOnRoute()
 256 |      */
 257 |     public function amOnRoute($route, $params = null) {
 258 |         return $this->getScenario()->runStep(new \Codeception\Step\Condition('amOnRoute', func_get_args()));
 259 |     }
 260 | 
 261 |  
 262 |     /**
 263 |      * [!] Method is generated. Documentation taken from corresponding module.
 264 |      *
 265 |      * Gets a component from Yii container. Throws exception if component is not available
 266 |      *
 267 |      * ```php
 268 |      * <?php
 269 |      * $mailer = $I->grabComponent('mailer');
 270 |      * ```
 271 |      *
 272 |      * @param $component
 273 |      * @return mixed
 274 |      * @throws ModuleException
 275 |      * @see \Codeception\Module\Yii2::grabComponent()
 276 |      */
 277 |     public function grabComponent($component) {
 278 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('grabComponent', func_get_args()));
 279 |     }
 280 | 
 281 |  
 282 |     /**
 283 |      * [!] Method is generated. Documentation taken from corresponding module.
 284 |      *
 285 |      * Checks that email is sent.
 286 |      *
 287 |      * ```php
 288 |      * <?php
 289 |      * // check that at least 1 email was sent
 290 |      * $I->seeEmailIsSent();
 291 |      *
 292 |      * // check that only 3 emails were sent
 293 |      * $I->seeEmailIsSent(3);
 294 |      * ```
 295 |      *
 296 |      * @param int $num
 297 |      * @throws ModuleException
 298 |      * @part email
 299 |      * Conditional Assertion: Test won't be stopped on fail
 300 |      * @see \Codeception\Module\Yii2::seeEmailIsSent()
 301 |      */
 302 |     public function canSeeEmailIsSent($num = null) {
 303 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeEmailIsSent', func_get_args()));
 304 |     }
 305 |     /**
 306 |      * [!] Method is generated. Documentation taken from corresponding module.
 307 |      *
 308 |      * Checks that email is sent.
 309 |      *
 310 |      * ```php
 311 |      * <?php
 312 |      * // check that at least 1 email was sent
 313 |      * $I->seeEmailIsSent();
 314 |      *
 315 |      * // check that only 3 emails were sent
 316 |      * $I->seeEmailIsSent(3);
 317 |      * ```
 318 |      *
 319 |      * @param int $num
 320 |      * @throws ModuleException
 321 |      * @part email
 322 |      * @see \Codeception\Module\Yii2::seeEmailIsSent()
 323 |      */
 324 |     public function seeEmailIsSent($num = null) {
 325 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeEmailIsSent', func_get_args()));
 326 |     }
 327 | 
 328 |  
 329 |     /**
 330 |      * [!] Method is generated. Documentation taken from corresponding module.
 331 |      *
 332 |      * Checks that no email was sent
 333 |      *
 334 |      * @part email
 335 |      * Conditional Assertion: Test won't be stopped on fail
 336 |      * @see \Codeception\Module\Yii2::dontSeeEmailIsSent()
 337 |      */
 338 |     public function cantSeeEmailIsSent() {
 339 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeEmailIsSent', func_get_args()));
 340 |     }
 341 |     /**
 342 |      * [!] Method is generated. Documentation taken from corresponding module.
 343 |      *
 344 |      * Checks that no email was sent
 345 |      *
 346 |      * @part email
 347 |      * @see \Codeception\Module\Yii2::dontSeeEmailIsSent()
 348 |      */
 349 |     public function dontSeeEmailIsSent() {
 350 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeEmailIsSent', func_get_args()));
 351 |     }
 352 | 
 353 |  
 354 |     /**
 355 |      * [!] Method is generated. Documentation taken from corresponding module.
 356 |      *
 357 |      * Returns array of all sent email messages.
 358 |      * Each message implements `yii\mail\Message` interface.
 359 |      * Useful to perform additional checks using `Asserts` module:
 360 |      *
 361 |      * ```php
 362 |      * <?php
 363 |      * $I->seeEmailIsSent();
 364 |      * $messages = $I->grabSentEmails();
 365 |      * $I->assertEquals('admin@site,com', $messages[0]->getTo());
 366 |      * ```
 367 |      *
 368 |      * @part email
 369 |      * @return array
 370 |      * @throws ModuleException
 371 |      * @see \Codeception\Module\Yii2::grabSentEmails()
 372 |      */
 373 |     public function grabSentEmails() {
 374 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('grabSentEmails', func_get_args()));
 375 |     }
 376 | 
 377 |  
 378 |     /**
 379 |      * [!] Method is generated. Documentation taken from corresponding module.
 380 |      *
 381 |      * Returns last sent email:
 382 |      *
 383 |      * ```php
 384 |      * <?php
 385 |      * $I->seeEmailIsSent();
 386 |      * $message = $I->grabLastSentEmail();
 387 |      * $I->assertEquals('admin@site,com', $message->getTo());
 388 |      * ```
 389 |      * @part email
 390 |      * @see \Codeception\Module\Yii2::grabLastSentEmail()
 391 |      */
 392 |     public function grabLastSentEmail() {
 393 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('grabLastSentEmail', func_get_args()));
 394 |     }
 395 | 
 396 |  
 397 |     /**
 398 |      * [!] Method is generated. Documentation taken from corresponding module.
 399 |      *
 400 |      * Returns a list of regex patterns for recognized domain names
 401 |      *
 402 |      * @return array
 403 |      * @see \Codeception\Module\Yii2::getInternalDomains()
 404 |      */
 405 |     public function getInternalDomains() {
 406 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('getInternalDomains', func_get_args()));
 407 |     }
 408 | 
 409 |  
 410 |     /**
 411 |      * [!] Method is generated. Documentation taken from corresponding module.
 412 |      *
 413 |      * Authenticates user for HTTP_AUTH
 414 |      *
 415 |      * @param $username
 416 |      * @param $password
 417 |      * @see \Codeception\Lib\InnerBrowser::amHttpAuthenticated()
 418 |      */
 419 |     public function amHttpAuthenticated($username, $password) {
 420 |         return $this->getScenario()->runStep(new \Codeception\Step\Condition('amHttpAuthenticated', func_get_args()));
 421 |     }
 422 | 
 423 |  
 424 |     /**
 425 |      * [!] Method is generated. Documentation taken from corresponding module.
 426 |      *
 427 |      * Sets the HTTP header to the passed value - which is used on
 428 |      * subsequent HTTP requests through PhpBrowser.
 429 |      *
 430 |      * Example:
 431 |      * ```php
 432 |      * <?php
 433 |      * $I->setHeader('X-Requested-With', 'Codeception');
 434 |      * $I->amOnPage('test-headers.php');
 435 |      * ?>
 436 |      * ```
 437 |      *
 438 |      * @param string $name the name of the request header
 439 |      * @param string $value the value to set it to for subsequent
 440 |      *        requests
 441 |      * @see \Codeception\Lib\InnerBrowser::haveHttpHeader()
 442 |      */
 443 |     public function haveHttpHeader($name, $value) {
 444 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('haveHttpHeader', func_get_args()));
 445 |     }
 446 | 
 447 |  
 448 |     /**
 449 |      * [!] Method is generated. Documentation taken from corresponding module.
 450 |      *
 451 |      * Deletes the header with the passed name.  Subsequent requests
 452 |      * will not have the deleted header in its request.
 453 |      *
 454 |      * Example:
 455 |      * ```php
 456 |      * <?php
 457 |      * $I->haveHttpHeader('X-Requested-With', 'Codeception');
 458 |      * $I->amOnPage('test-headers.php');
 459 |      * // ...
 460 |      * $I->deleteHeader('X-Requested-With');
 461 |      * $I->amOnPage('some-other-page.php');
 462 |      * ?>
 463 |      * ```
 464 |      *
 465 |      * @param string $name the name of the header to delete.
 466 |      * @see \Codeception\Lib\InnerBrowser::deleteHeader()
 467 |      */
 468 |     public function deleteHeader($name) {
 469 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('deleteHeader', func_get_args()));
 470 |     }
 471 | 
 472 |  
 473 |     /**
 474 |      * [!] Method is generated. Documentation taken from corresponding module.
 475 |      *
 476 |      * Opens the page for the given relative URI.
 477 |      *
 478 |      * ``` php
 479 |      * <?php
 480 |      * // opens front page
 481 |      * $I->amOnPage('/');
 482 |      * // opens /register page
 483 |      * $I->amOnPage('/register');
 484 |      * ```
 485 |      *
 486 |      * @param $page
 487 |      * @see \Codeception\Lib\InnerBrowser::amOnPage()
 488 |      */
 489 |     public function amOnPage($page) {
 490 |         return $this->getScenario()->runStep(new \Codeception\Step\Condition('amOnPage', func_get_args()));
 491 |     }
 492 | 
 493 |  
 494 |     /**
 495 |      * [!] Method is generated. Documentation taken from corresponding module.
 496 |      *
 497 |      * Perform a click on a link or a button, given by a locator.
 498 |      * If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.
 499 |      * For buttons, the "value" attribute, "name" attribute, and inner text are searched.
 500 |      * For links, the link text is searched.
 501 |      * For images, the "alt" attribute and inner text of any parent links are searched.
 502 |      *
 503 |      * The second parameter is a context (CSS or XPath locator) to narrow the search.
 504 |      *
 505 |      * Note that if the locator matches a button of type `submit`, the form will be submitted.
 506 |      *
 507 |      * ``` php
 508 |      * <?php
 509 |      * // simple link
 510 |      * $I->click('Logout');
 511 |      * // button of form
 512 |      * $I->click('Submit');
 513 |      * // CSS button
 514 |      * $I->click('#form input[type=submit]');
 515 |      * // XPath
 516 |      * $I->click('//form/*[@type=submit]');
 517 |      * // link in context
 518 |      * $I->click('Logout', '#nav');
 519 |      * // using strict locator
 520 |      * $I->click(['link' => 'Login']);
 521 |      * ?>
 522 |      * ```
 523 |      *
 524 |      * @param $link
 525 |      * @param $context
 526 |      * @see \Codeception\Lib\InnerBrowser::click()
 527 |      */
 528 |     public function click($link, $context = null) {
 529 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('click', func_get_args()));
 530 |     }
 531 | 
 532 |  
 533 |     /**
 534 |      * [!] Method is generated. Documentation taken from corresponding module.
 535 |      *
 536 |      * Checks that the current page contains the given string (case insensitive).
 537 |      *
 538 |      * You can specify a specific HTML element (via CSS or XPath) as the second
 539 |      * parameter to only search within that element.
 540 |      *
 541 |      * ``` php
 542 |      * <?php
 543 |      * $I->see('Logout');                        // I can suppose user is logged in
 544 |      * $I->see('Sign Up', 'h1');                 // I can suppose it's a signup page
 545 |      * $I->see('Sign Up', '//body/h1');          // with XPath
 546 |      * $I->see('Sign Up', ['css' => 'body h1']); // with strict CSS locator
 547 |      * ```
 548 |      *
 549 |      * Note that the search is done after stripping all HTML tags from the body,
 550 |      * so `$I->see('strong')` will return true for strings like:
 551 |      *
 552 |      *   - `<p>I am Stronger than thou</p>`
 553 |      *   - `<script>document.createElement('strong');</script>`
 554 |      *
 555 |      * But will *not* be true for strings like:
 556 |      *
 557 |      *   - `<strong>Home</strong>`
 558 |      *   - `<div class="strong">Home</strong>`
 559 |      *   - `<!-- strong -->`
 560 |      *
 561 |      * For checking the raw source code, use `seeInSource()`.
 562 |      *
 563 |      * @param      $text
 564 |      * @param null $selector
 565 |      * Conditional Assertion: Test won't be stopped on fail
 566 |      * @see \Codeception\Lib\InnerBrowser::see()
 567 |      */
 568 |     public function canSee($text, $selector = null) {
 569 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('see', func_get_args()));
 570 |     }
 571 |     /**
 572 |      * [!] Method is generated. Documentation taken from corresponding module.
 573 |      *
 574 |      * Checks that the current page contains the given string (case insensitive).
 575 |      *
 576 |      * You can specify a specific HTML element (via CSS or XPath) as the second
 577 |      * parameter to only search within that element.
 578 |      *
 579 |      * ``` php
 580 |      * <?php
 581 |      * $I->see('Logout');                        // I can suppose user is logged in
 582 |      * $I->see('Sign Up', 'h1');                 // I can suppose it's a signup page
 583 |      * $I->see('Sign Up', '//body/h1');          // with XPath
 584 |      * $I->see('Sign Up', ['css' => 'body h1']); // with strict CSS locator
 585 |      * ```
 586 |      *
 587 |      * Note that the search is done after stripping all HTML tags from the body,
 588 |      * so `$I->see('strong')` will return true for strings like:
 589 |      *
 590 |      *   - `<p>I am Stronger than thou</p>`
 591 |      *   - `<script>document.createElement('strong');</script>`
 592 |      *
 593 |      * But will *not* be true for strings like:
 594 |      *
 595 |      *   - `<strong>Home</strong>`
 596 |      *   - `<div class="strong">Home</strong>`
 597 |      *   - `<!-- strong -->`
 598 |      *
 599 |      * For checking the raw source code, use `seeInSource()`.
 600 |      *
 601 |      * @param      $text
 602 |      * @param null $selector
 603 |      * @see \Codeception\Lib\InnerBrowser::see()
 604 |      */
 605 |     public function see($text, $selector = null) {
 606 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('see', func_get_args()));
 607 |     }
 608 | 
 609 |  
 610 |     /**
 611 |      * [!] Method is generated. Documentation taken from corresponding module.
 612 |      *
 613 |      * Checks that the current page doesn't contain the text specified (case insensitive).
 614 |      * Give a locator as the second parameter to match a specific region.
 615 |      *
 616 |      * ```php
 617 |      * <?php
 618 |      * $I->dontSee('Login');                         // I can suppose user is already logged in
 619 |      * $I->dontSee('Sign Up','h1');                  // I can suppose it's not a signup page
 620 |      * $I->dontSee('Sign Up','//body/h1');           // with XPath
 621 |      * $I->dontSee('Sign Up', ['css' => 'body h1']); // with strict CSS locator
 622 |      * ```
 623 |      *
 624 |      * Note that the search is done after stripping all HTML tags from the body,
 625 |      * so `$I->dontSee('strong')` will fail on strings like:
 626 |      *
 627 |      *   - `<p>I am Stronger than thou</p>`
 628 |      *   - `<script>document.createElement('strong');</script>`
 629 |      *
 630 |      * But will ignore strings like:
 631 |      *
 632 |      *   - `<strong>Home</strong>`
 633 |      *   - `<div class="strong">Home</strong>`
 634 |      *   - `<!-- strong -->`
 635 |      *
 636 |      * For checking the raw source code, use `seeInSource()`.
 637 |      *
 638 |      * @param      $text
 639 |      * @param null $selector
 640 |      * Conditional Assertion: Test won't be stopped on fail
 641 |      * @see \Codeception\Lib\InnerBrowser::dontSee()
 642 |      */
 643 |     public function cantSee($text, $selector = null) {
 644 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSee', func_get_args()));
 645 |     }
 646 |     /**
 647 |      * [!] Method is generated. Documentation taken from corresponding module.
 648 |      *
 649 |      * Checks that the current page doesn't contain the text specified (case insensitive).
 650 |      * Give a locator as the second parameter to match a specific region.
 651 |      *
 652 |      * ```php
 653 |      * <?php
 654 |      * $I->dontSee('Login');                         // I can suppose user is already logged in
 655 |      * $I->dontSee('Sign Up','h1');                  // I can suppose it's not a signup page
 656 |      * $I->dontSee('Sign Up','//body/h1');           // with XPath
 657 |      * $I->dontSee('Sign Up', ['css' => 'body h1']); // with strict CSS locator
 658 |      * ```
 659 |      *
 660 |      * Note that the search is done after stripping all HTML tags from the body,
 661 |      * so `$I->dontSee('strong')` will fail on strings like:
 662 |      *
 663 |      *   - `<p>I am Stronger than thou</p>`
 664 |      *   - `<script>document.createElement('strong');</script>`
 665 |      *
 666 |      * But will ignore strings like:
 667 |      *
 668 |      *   - `<strong>Home</strong>`
 669 |      *   - `<div class="strong">Home</strong>`
 670 |      *   - `<!-- strong -->`
 671 |      *
 672 |      * For checking the raw source code, use `seeInSource()`.
 673 |      *
 674 |      * @param      $text
 675 |      * @param null $selector
 676 |      * @see \Codeception\Lib\InnerBrowser::dontSee()
 677 |      */
 678 |     public function dontSee($text, $selector = null) {
 679 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSee', func_get_args()));
 680 |     }
 681 | 
 682 |  
 683 |     /**
 684 |      * [!] Method is generated. Documentation taken from corresponding module.
 685 |      *
 686 |      * Checks that the current page contains the given string in its
 687 |      * raw source code.
 688 |      *
 689 |      * ``` php
 690 |      * <?php
 691 |      * $I->seeInSource('<h1>Green eggs &amp; ham</h1>');
 692 |      * ```
 693 |      *
 694 |      * @param      $raw
 695 |      * Conditional Assertion: Test won't be stopped on fail
 696 |      * @see \Codeception\Lib\InnerBrowser::seeInSource()
 697 |      */
 698 |     public function canSeeInSource($raw) {
 699 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInSource', func_get_args()));
 700 |     }
 701 |     /**
 702 |      * [!] Method is generated. Documentation taken from corresponding module.
 703 |      *
 704 |      * Checks that the current page contains the given string in its
 705 |      * raw source code.
 706 |      *
 707 |      * ``` php
 708 |      * <?php
 709 |      * $I->seeInSource('<h1>Green eggs &amp; ham</h1>');
 710 |      * ```
 711 |      *
 712 |      * @param      $raw
 713 |      * @see \Codeception\Lib\InnerBrowser::seeInSource()
 714 |      */
 715 |     public function seeInSource($raw) {
 716 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInSource', func_get_args()));
 717 |     }
 718 | 
 719 |  
 720 |     /**
 721 |      * [!] Method is generated. Documentation taken from corresponding module.
 722 |      *
 723 |      * Checks that the current page contains the given string in its
 724 |      * raw source code.
 725 |      *
 726 |      * ```php
 727 |      * <?php
 728 |      * $I->dontSeeInSource('<h1>Green eggs &amp; ham</h1>');
 729 |      * ```
 730 |      *
 731 |      * @param      $raw
 732 |      * Conditional Assertion: Test won't be stopped on fail
 733 |      * @see \Codeception\Lib\InnerBrowser::dontSeeInSource()
 734 |      */
 735 |     public function cantSeeInSource($raw) {
 736 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInSource', func_get_args()));
 737 |     }
 738 |     /**
 739 |      * [!] Method is generated. Documentation taken from corresponding module.
 740 |      *
 741 |      * Checks that the current page contains the given string in its
 742 |      * raw source code.
 743 |      *
 744 |      * ```php
 745 |      * <?php
 746 |      * $I->dontSeeInSource('<h1>Green eggs &amp; ham</h1>');
 747 |      * ```
 748 |      *
 749 |      * @param      $raw
 750 |      * @see \Codeception\Lib\InnerBrowser::dontSeeInSource()
 751 |      */
 752 |     public function dontSeeInSource($raw) {
 753 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeInSource', func_get_args()));
 754 |     }
 755 | 
 756 |  
 757 |     /**
 758 |      * [!] Method is generated. Documentation taken from corresponding module.
 759 |      *
 760 |      * Checks that there's a link with the specified text.
 761 |      * Give a full URL as the second parameter to match links with that exact URL.
 762 |      *
 763 |      * ``` php
 764 |      * <?php
 765 |      * $I->seeLink('Logout'); // matches <a href="#">Logout</a>
 766 |      * $I->seeLink('Logout','/logout'); // matches <a href="/logout">Logout</a>
 767 |      * ?>
 768 |      * ```
 769 |      *
 770 |      * @param      $text
 771 |      * @param null $url
 772 |      * Conditional Assertion: Test won't be stopped on fail
 773 |      * @see \Codeception\Lib\InnerBrowser::seeLink()
 774 |      */
 775 |     public function canSeeLink($text, $url = null) {
 776 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeLink', func_get_args()));
 777 |     }
 778 |     /**
 779 |      * [!] Method is generated. Documentation taken from corresponding module.
 780 |      *
 781 |      * Checks that there's a link with the specified text.
 782 |      * Give a full URL as the second parameter to match links with that exact URL.
 783 |      *
 784 |      * ``` php
 785 |      * <?php
 786 |      * $I->seeLink('Logout'); // matches <a href="#">Logout</a>
 787 |      * $I->seeLink('Logout','/logout'); // matches <a href="/logout">Logout</a>
 788 |      * ?>
 789 |      * ```
 790 |      *
 791 |      * @param      $text
 792 |      * @param null $url
 793 |      * @see \Codeception\Lib\InnerBrowser::seeLink()
 794 |      */
 795 |     public function seeLink($text, $url = null) {
 796 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeLink', func_get_args()));
 797 |     }
 798 | 
 799 |  
 800 |     /**
 801 |      * [!] Method is generated. Documentation taken from corresponding module.
 802 |      *
 803 |      * Checks that the page doesn't contain a link with the given string.
 804 |      * If the second parameter is given, only links with a matching "href" attribute will be checked.
 805 |      *
 806 |      * ``` php
 807 |      * <?php
 808 |      * $I->dontSeeLink('Logout'); // I suppose user is not logged in
 809 |      * $I->dontSeeLink('Checkout now', '/store/cart.php');
 810 |      * ?>
 811 |      * ```
 812 |      *
 813 |      * @param $text
 814 |      * @param null $url
 815 |      * Conditional Assertion: Test won't be stopped on fail
 816 |      * @see \Codeception\Lib\InnerBrowser::dontSeeLink()
 817 |      */
 818 |     public function cantSeeLink($text, $url = null) {
 819 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeLink', func_get_args()));
 820 |     }
 821 |     /**
 822 |      * [!] Method is generated. Documentation taken from corresponding module.
 823 |      *
 824 |      * Checks that the page doesn't contain a link with the given string.
 825 |      * If the second parameter is given, only links with a matching "href" attribute will be checked.
 826 |      *
 827 |      * ``` php
 828 |      * <?php
 829 |      * $I->dontSeeLink('Logout'); // I suppose user is not logged in
 830 |      * $I->dontSeeLink('Checkout now', '/store/cart.php');
 831 |      * ?>
 832 |      * ```
 833 |      *
 834 |      * @param $text
 835 |      * @param null $url
 836 |      * @see \Codeception\Lib\InnerBrowser::dontSeeLink()
 837 |      */
 838 |     public function dontSeeLink($text, $url = null) {
 839 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeLink', func_get_args()));
 840 |     }
 841 | 
 842 |  
 843 |     /**
 844 |      * [!] Method is generated. Documentation taken from corresponding module.
 845 |      *
 846 |      * Checks that current URI contains the given string.
 847 |      *
 848 |      * ``` php
 849 |      * <?php
 850 |      * // to match: /home/dashboard
 851 |      * $I->seeInCurrentUrl('home');
 852 |      * // to match: /users/1
 853 |      * $I->seeInCurrentUrl('/users/');
 854 |      * ?>
 855 |      * ```
 856 |      *
 857 |      * @param $uri
 858 |      * Conditional Assertion: Test won't be stopped on fail
 859 |      * @see \Codeception\Lib\InnerBrowser::seeInCurrentUrl()
 860 |      */
 861 |     public function canSeeInCurrentUrl($uri) {
 862 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInCurrentUrl', func_get_args()));
 863 |     }
 864 |     /**
 865 |      * [!] Method is generated. Documentation taken from corresponding module.
 866 |      *
 867 |      * Checks that current URI contains the given string.
 868 |      *
 869 |      * ``` php
 870 |      * <?php
 871 |      * // to match: /home/dashboard
 872 |      * $I->seeInCurrentUrl('home');
 873 |      * // to match: /users/1
 874 |      * $I->seeInCurrentUrl('/users/');
 875 |      * ?>
 876 |      * ```
 877 |      *
 878 |      * @param $uri
 879 |      * @see \Codeception\Lib\InnerBrowser::seeInCurrentUrl()
 880 |      */
 881 |     public function seeInCurrentUrl($uri) {
 882 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInCurrentUrl', func_get_args()));
 883 |     }
 884 | 
 885 |  
 886 |     /**
 887 |      * [!] Method is generated. Documentation taken from corresponding module.
 888 |      *
 889 |      * Checks that the current URI doesn't contain the given string.
 890 |      *
 891 |      * ``` php
 892 |      * <?php
 893 |      * $I->dontSeeInCurrentUrl('/users/');
 894 |      * ?>
 895 |      * ```
 896 |      *
 897 |      * @param $uri
 898 |      * Conditional Assertion: Test won't be stopped on fail
 899 |      * @see \Codeception\Lib\InnerBrowser::dontSeeInCurrentUrl()
 900 |      */
 901 |     public function cantSeeInCurrentUrl($uri) {
 902 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInCurrentUrl', func_get_args()));
 903 |     }
 904 |     /**
 905 |      * [!] Method is generated. Documentation taken from corresponding module.
 906 |      *
 907 |      * Checks that the current URI doesn't contain the given string.
 908 |      *
 909 |      * ``` php
 910 |      * <?php
 911 |      * $I->dontSeeInCurrentUrl('/users/');
 912 |      * ?>
 913 |      * ```
 914 |      *
 915 |      * @param $uri
 916 |      * @see \Codeception\Lib\InnerBrowser::dontSeeInCurrentUrl()
 917 |      */
 918 |     public function dontSeeInCurrentUrl($uri) {
 919 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeInCurrentUrl', func_get_args()));
 920 |     }
 921 | 
 922 |  
 923 |     /**
 924 |      * [!] Method is generated. Documentation taken from corresponding module.
 925 |      *
 926 |      * Checks that the current URL is equal to the given string.
 927 |      * Unlike `seeInCurrentUrl`, this only matches the full URL.
 928 |      *
 929 |      * ``` php
 930 |      * <?php
 931 |      * // to match root url
 932 |      * $I->seeCurrentUrlEquals('/');
 933 |      * ?>
 934 |      * ```
 935 |      *
 936 |      * @param $uri
 937 |      * Conditional Assertion: Test won't be stopped on fail
 938 |      * @see \Codeception\Lib\InnerBrowser::seeCurrentUrlEquals()
 939 |      */
 940 |     public function canSeeCurrentUrlEquals($uri) {
 941 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeCurrentUrlEquals', func_get_args()));
 942 |     }
 943 |     /**
 944 |      * [!] Method is generated. Documentation taken from corresponding module.
 945 |      *
 946 |      * Checks that the current URL is equal to the given string.
 947 |      * Unlike `seeInCurrentUrl`, this only matches the full URL.
 948 |      *
 949 |      * ``` php
 950 |      * <?php
 951 |      * // to match root url
 952 |      * $I->seeCurrentUrlEquals('/');
 953 |      * ?>
 954 |      * ```
 955 |      *
 956 |      * @param $uri
 957 |      * @see \Codeception\Lib\InnerBrowser::seeCurrentUrlEquals()
 958 |      */
 959 |     public function seeCurrentUrlEquals($uri) {
 960 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCurrentUrlEquals', func_get_args()));
 961 |     }
 962 | 
 963 |  
 964 |     /**
 965 |      * [!] Method is generated. Documentation taken from corresponding module.
 966 |      *
 967 |      * Checks that the current URL doesn't equal the given string.
 968 |      * Unlike `dontSeeInCurrentUrl`, this only matches the full URL.
 969 |      *
 970 |      * ``` php
 971 |      * <?php
 972 |      * // current url is not root
 973 |      * $I->dontSeeCurrentUrlEquals('/');
 974 |      * ?>
 975 |      * ```
 976 |      *
 977 |      * @param $uri
 978 |      * Conditional Assertion: Test won't be stopped on fail
 979 |      * @see \Codeception\Lib\InnerBrowser::dontSeeCurrentUrlEquals()
 980 |      */
 981 |     public function cantSeeCurrentUrlEquals($uri) {
 982 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeCurrentUrlEquals', func_get_args()));
 983 |     }
 984 |     /**
 985 |      * [!] Method is generated. Documentation taken from corresponding module.
 986 |      *
 987 |      * Checks that the current URL doesn't equal the given string.
 988 |      * Unlike `dontSeeInCurrentUrl`, this only matches the full URL.
 989 |      *
 990 |      * ``` php
 991 |      * <?php
 992 |      * // current url is not root
 993 |      * $I->dontSeeCurrentUrlEquals('/');
 994 |      * ?>
 995 |      * ```
 996 |      *
 997 |      * @param $uri
 998 |      * @see \Codeception\Lib\InnerBrowser::dontSeeCurrentUrlEquals()
 999 |      */
1000 |     public function dontSeeCurrentUrlEquals($uri) {
1001 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeCurrentUrlEquals', func_get_args()));
1002 |     }
1003 | 
1004 |  
1005 |     /**
1006 |      * [!] Method is generated. Documentation taken from corresponding module.
1007 |      *
1008 |      * Checks that the current URL matches the given regular expression.
1009 |      *
1010 |      * ``` php
1011 |      * <?php
1012 |      * // to match root url
1013 |      * $I->seeCurrentUrlMatches('~$/users/(\d+)~');
1014 |      * ?>
1015 |      * ```
1016 |      *
1017 |      * @param $uri
1018 |      * Conditional Assertion: Test won't be stopped on fail
1019 |      * @see \Codeception\Lib\InnerBrowser::seeCurrentUrlMatches()
1020 |      */
1021 |     public function canSeeCurrentUrlMatches($uri) {
1022 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeCurrentUrlMatches', func_get_args()));
1023 |     }
1024 |     /**
1025 |      * [!] Method is generated. Documentation taken from corresponding module.
1026 |      *
1027 |      * Checks that the current URL matches the given regular expression.
1028 |      *
1029 |      * ``` php
1030 |      * <?php
1031 |      * // to match root url
1032 |      * $I->seeCurrentUrlMatches('~$/users/(\d+)~');
1033 |      * ?>
1034 |      * ```
1035 |      *
1036 |      * @param $uri
1037 |      * @see \Codeception\Lib\InnerBrowser::seeCurrentUrlMatches()
1038 |      */
1039 |     public function seeCurrentUrlMatches($uri) {
1040 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCurrentUrlMatches', func_get_args()));
1041 |     }
1042 | 
1043 |  
1044 |     /**
1045 |      * [!] Method is generated. Documentation taken from corresponding module.
1046 |      *
1047 |      * Checks that current url doesn't match the given regular expression.
1048 |      *
1049 |      * ``` php
1050 |      * <?php
1051 |      * // to match root url
1052 |      * $I->dontSeeCurrentUrlMatches('~$/users/(\d+)~');
1053 |      * ?>
1054 |      * ```
1055 |      *
1056 |      * @param $uri
1057 |      * Conditional Assertion: Test won't be stopped on fail
1058 |      * @see \Codeception\Lib\InnerBrowser::dontSeeCurrentUrlMatches()
1059 |      */
1060 |     public function cantSeeCurrentUrlMatches($uri) {
1061 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeCurrentUrlMatches', func_get_args()));
1062 |     }
1063 |     /**
1064 |      * [!] Method is generated. Documentation taken from corresponding module.
1065 |      *
1066 |      * Checks that current url doesn't match the given regular expression.
1067 |      *
1068 |      * ``` php
1069 |      * <?php
1070 |      * // to match root url
1071 |      * $I->dontSeeCurrentUrlMatches('~$/users/(\d+)~');
1072 |      * ?>
1073 |      * ```
1074 |      *
1075 |      * @param $uri
1076 |      * @see \Codeception\Lib\InnerBrowser::dontSeeCurrentUrlMatches()
1077 |      */
1078 |     public function dontSeeCurrentUrlMatches($uri) {
1079 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeCurrentUrlMatches', func_get_args()));
1080 |     }
1081 | 
1082 |  
1083 |     /**
1084 |      * [!] Method is generated. Documentation taken from corresponding module.
1085 |      *
1086 |      * Executes the given regular expression against the current URI and returns the first match.
1087 |      * If no parameters are provided, the full URI is returned.
1088 |      *
1089 |      * ``` php
1090 |      * <?php
1091 |      * $user_id = $I->grabFromCurrentUrl('~$/user/(\d+)/~');
1092 |      * $uri = $I->grabFromCurrentUrl();
1093 |      * ?>
1094 |      * ```
1095 |      *
1096 |      * @param null $uri
1097 |      *
1098 |      * @return mixed
1099 |      * @see \Codeception\Lib\InnerBrowser::grabFromCurrentUrl()
1100 |      */
1101 |     public function grabFromCurrentUrl($uri = null) {
1102 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('grabFromCurrentUrl', func_get_args()));
1103 |     }
1104 | 
1105 |  
1106 |     /**
1107 |      * [!] Method is generated. Documentation taken from corresponding module.
1108 |      *
1109 |      * Checks that the specified checkbox is checked.
1110 |      *
1111 |      * ``` php
1112 |      * <?php
1113 |      * $I->seeCheckboxIsChecked('#agree'); // I suppose user agreed to terms
1114 |      * $I->seeCheckboxIsChecked('#signup_form input[type=checkbox]'); // I suppose user agreed to terms, If there is only one checkbox in form.
1115 |      * $I->seeCheckboxIsChecked('//form/input[@type=checkbox and @name=agree]');
1116 |      * ?>
1117 |      * ```
1118 |      *
1119 |      * @param $checkbox
1120 |      * Conditional Assertion: Test won't be stopped on fail
1121 |      * @see \Codeception\Lib\InnerBrowser::seeCheckboxIsChecked()
1122 |      */
1123 |     public function canSeeCheckboxIsChecked($checkbox) {
1124 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeCheckboxIsChecked', func_get_args()));
1125 |     }
1126 |     /**
1127 |      * [!] Method is generated. Documentation taken from corresponding module.
1128 |      *
1129 |      * Checks that the specified checkbox is checked.
1130 |      *
1131 |      * ``` php
1132 |      * <?php
1133 |      * $I->seeCheckboxIsChecked('#agree'); // I suppose user agreed to terms
1134 |      * $I->seeCheckboxIsChecked('#signup_form input[type=checkbox]'); // I suppose user agreed to terms, If there is only one checkbox in form.
1135 |      * $I->seeCheckboxIsChecked('//form/input[@type=checkbox and @name=agree]');
1136 |      * ?>
1137 |      * ```
1138 |      *
1139 |      * @param $checkbox
1140 |      * @see \Codeception\Lib\InnerBrowser::seeCheckboxIsChecked()
1141 |      */
1142 |     public function seeCheckboxIsChecked($checkbox) {
1143 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCheckboxIsChecked', func_get_args()));
1144 |     }
1145 | 
1146 |  
1147 |     /**
1148 |      * [!] Method is generated. Documentation taken from corresponding module.
1149 |      *
1150 |      * Check that the specified checkbox is unchecked.
1151 |      *
1152 |      * ``` php
1153 |      * <?php
1154 |      * $I->dontSeeCheckboxIsChecked('#agree'); // I suppose user didn't agree to terms
1155 |      * $I->seeCheckboxIsChecked('#signup_form input[type=checkbox]'); // I suppose user didn't check the first checkbox in form.
1156 |      * ?>
1157 |      * ```
1158 |      *
1159 |      * @param $checkbox
1160 |      * Conditional Assertion: Test won't be stopped on fail
1161 |      * @see \Codeception\Lib\InnerBrowser::dontSeeCheckboxIsChecked()
1162 |      */
1163 |     public function cantSeeCheckboxIsChecked($checkbox) {
1164 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeCheckboxIsChecked', func_get_args()));
1165 |     }
1166 |     /**
1167 |      * [!] Method is generated. Documentation taken from corresponding module.
1168 |      *
1169 |      * Check that the specified checkbox is unchecked.
1170 |      *
1171 |      * ``` php
1172 |      * <?php
1173 |      * $I->dontSeeCheckboxIsChecked('#agree'); // I suppose user didn't agree to terms
1174 |      * $I->seeCheckboxIsChecked('#signup_form input[type=checkbox]'); // I suppose user didn't check the first checkbox in form.
1175 |      * ?>
1176 |      * ```
1177 |      *
1178 |      * @param $checkbox
1179 |      * @see \Codeception\Lib\InnerBrowser::dontSeeCheckboxIsChecked()
1180 |      */
1181 |     public function dontSeeCheckboxIsChecked($checkbox) {
1182 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeCheckboxIsChecked', func_get_args()));
1183 |     }
1184 | 
1185 |  
1186 |     /**
1187 |      * [!] Method is generated. Documentation taken from corresponding module.
1188 |      *
1189 |      * Checks that the given input field or textarea contains the given value.
1190 |      * For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
1191 |      *
1192 |      * ``` php
1193 |      * <?php
1194 |      * $I->seeInField('Body','Type your comment here');
1195 |      * $I->seeInField('form textarea[name=body]','Type your comment here');
1196 |      * $I->seeInField('form input[type=hidden]','hidden_value');
1197 |      * $I->seeInField('#searchform input','Search');
1198 |      * $I->seeInField('//form/*[@name=search]','Search');
1199 |      * $I->seeInField(['name' => 'search'], 'Search');
1200 |      * ?>
1201 |      * ```
1202 |      *
1203 |      * @param $field
1204 |      * @param $value
1205 |      * Conditional Assertion: Test won't be stopped on fail
1206 |      * @see \Codeception\Lib\InnerBrowser::seeInField()
1207 |      */
1208 |     public function canSeeInField($field, $value) {
1209 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInField', func_get_args()));
1210 |     }
1211 |     /**
1212 |      * [!] Method is generated. Documentation taken from corresponding module.
1213 |      *
1214 |      * Checks that the given input field or textarea contains the given value.
1215 |      * For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
1216 |      *
1217 |      * ``` php
1218 |      * <?php
1219 |      * $I->seeInField('Body','Type your comment here');
1220 |      * $I->seeInField('form textarea[name=body]','Type your comment here');
1221 |      * $I->seeInField('form input[type=hidden]','hidden_value');
1222 |      * $I->seeInField('#searchform input','Search');
1223 |      * $I->seeInField('//form/*[@name=search]','Search');
1224 |      * $I->seeInField(['name' => 'search'], 'Search');
1225 |      * ?>
1226 |      * ```
1227 |      *
1228 |      * @param $field
1229 |      * @param $value
1230 |      * @see \Codeception\Lib\InnerBrowser::seeInField()
1231 |      */
1232 |     public function seeInField($field, $value) {
1233 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInField', func_get_args()));
1234 |     }
1235 | 
1236 |  
1237 |     /**
1238 |      * [!] Method is generated. Documentation taken from corresponding module.
1239 |      *
1240 |      * Checks that an input field or textarea doesn't contain the given value.
1241 |      * For fuzzy locators, the field is matched by label text, CSS and XPath.
1242 |      *
1243 |      * ``` php
1244 |      * <?php
1245 |      * $I->dontSeeInField('Body','Type your comment here');
1246 |      * $I->dontSeeInField('form textarea[name=body]','Type your comment here');
1247 |      * $I->dontSeeInField('form input[type=hidden]','hidden_value');
1248 |      * $I->dontSeeInField('#searchform input','Search');
1249 |      * $I->dontSeeInField('//form/*[@name=search]','Search');
1250 |      * $I->dontSeeInField(['name' => 'search'], 'Search');
1251 |      * ?>
1252 |      * ```
1253 |      *
1254 |      * @param $field
1255 |      * @param $value
1256 |      * Conditional Assertion: Test won't be stopped on fail
1257 |      * @see \Codeception\Lib\InnerBrowser::dontSeeInField()
1258 |      */
1259 |     public function cantSeeInField($field, $value) {
1260 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInField', func_get_args()));
1261 |     }
1262 |     /**
1263 |      * [!] Method is generated. Documentation taken from corresponding module.
1264 |      *
1265 |      * Checks that an input field or textarea doesn't contain the given value.
1266 |      * For fuzzy locators, the field is matched by label text, CSS and XPath.
1267 |      *
1268 |      * ``` php
1269 |      * <?php
1270 |      * $I->dontSeeInField('Body','Type your comment here');
1271 |      * $I->dontSeeInField('form textarea[name=body]','Type your comment here');
1272 |      * $I->dontSeeInField('form input[type=hidden]','hidden_value');
1273 |      * $I->dontSeeInField('#searchform input','Search');
1274 |      * $I->dontSeeInField('//form/*[@name=search]','Search');
1275 |      * $I->dontSeeInField(['name' => 'search'], 'Search');
1276 |      * ?>
1277 |      * ```
1278 |      *
1279 |      * @param $field
1280 |      * @param $value
1281 |      * @see \Codeception\Lib\InnerBrowser::dontSeeInField()
1282 |      */
1283 |     public function dontSeeInField($field, $value) {
1284 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeInField', func_get_args()));
1285 |     }
1286 | 
1287 |  
1288 |     /**
1289 |      * [!] Method is generated. Documentation taken from corresponding module.
1290 |      *
1291 |      * Checks if the array of form parameters (name => value) are set on the form matched with the
1292 |      * passed selector.
1293 |      *
1294 |      * ``` php
1295 |      * <?php
1296 |      * $I->seeInFormFields('form[name=myform]', [
1297 |      *      'input1' => 'value',
1298 |      *      'input2' => 'other value',
1299 |      * ]);
1300 |      * ?>
1301 |      * ```
1302 |      *
1303 |      * For multi-select elements, or to check values of multiple elements with the same name, an
1304 |      * array may be passed:
1305 |      *
1306 |      * ``` php
1307 |      * <?php
1308 |      * $I->seeInFormFields('.form-class', [
1309 |      *      'multiselect' => [
1310 |      *          'value1',
1311 |      *          'value2',
1312 |      *      ],
1313 |      *      'checkbox[]' => [
1314 |      *          'a checked value',
1315 |      *          'another checked value',
1316 |      *      ],
1317 |      * ]);
1318 |      * ?>
1319 |      * ```
1320 |      *
1321 |      * Additionally, checkbox values can be checked with a boolean.
1322 |      *
1323 |      * ``` php
1324 |      * <?php
1325 |      * $I->seeInFormFields('#form-id', [
1326 |      *      'checkbox1' => true,        // passes if checked
1327 |      *      'checkbox2' => false,       // passes if unchecked
1328 |      * ]);
1329 |      * ?>
1330 |      * ```
1331 |      *
1332 |      * Pair this with submitForm for quick testing magic.
1333 |      *
1334 |      * ``` php
1335 |      * <?php
1336 |      * $form = [
1337 |      *      'field1' => 'value',
1338 |      *      'field2' => 'another value',
1339 |      *      'checkbox1' => true,
1340 |      *      // ...
1341 |      * ];
1342 |      * $I->submitForm('//form[@id=my-form]', $form, 'submitButton');
1343 |      * // $I->amOnPage('/path/to/form-page') may be needed
1344 |      * $I->seeInFormFields('//form[@id=my-form]', $form);
1345 |      * ?>
1346 |      * ```
1347 |      *
1348 |      * @param $formSelector
1349 |      * @param $params
1350 |      * Conditional Assertion: Test won't be stopped on fail
1351 |      * @see \Codeception\Lib\InnerBrowser::seeInFormFields()
1352 |      */
1353 |     public function canSeeInFormFields($formSelector, $params) {
1354 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInFormFields', func_get_args()));
1355 |     }
1356 |     /**
1357 |      * [!] Method is generated. Documentation taken from corresponding module.
1358 |      *
1359 |      * Checks if the array of form parameters (name => value) are set on the form matched with the
1360 |      * passed selector.
1361 |      *
1362 |      * ``` php
1363 |      * <?php
1364 |      * $I->seeInFormFields('form[name=myform]', [
1365 |      *      'input1' => 'value',
1366 |      *      'input2' => 'other value',
1367 |      * ]);
1368 |      * ?>
1369 |      * ```
1370 |      *
1371 |      * For multi-select elements, or to check values of multiple elements with the same name, an
1372 |      * array may be passed:
1373 |      *
1374 |      * ``` php
1375 |      * <?php
1376 |      * $I->seeInFormFields('.form-class', [
1377 |      *      'multiselect' => [
1378 |      *          'value1',
1379 |      *          'value2',
1380 |      *      ],
1381 |      *      'checkbox[]' => [
1382 |      *          'a checked value',
1383 |      *          'another checked value',
1384 |      *      ],
1385 |      * ]);
1386 |      * ?>
1387 |      * ```
1388 |      *
1389 |      * Additionally, checkbox values can be checked with a boolean.
1390 |      *
1391 |      * ``` php
1392 |      * <?php
1393 |      * $I->seeInFormFields('#form-id', [
1394 |      *      'checkbox1' => true,        // passes if checked
1395 |      *      'checkbox2' => false,       // passes if unchecked
1396 |      * ]);
1397 |      * ?>
1398 |      * ```
1399 |      *
1400 |      * Pair this with submitForm for quick testing magic.
1401 |      *
1402 |      * ``` php
1403 |      * <?php
1404 |      * $form = [
1405 |      *      'field1' => 'value',
1406 |      *      'field2' => 'another value',
1407 |      *      'checkbox1' => true,
1408 |      *      // ...
1409 |      * ];
1410 |      * $I->submitForm('//form[@id=my-form]', $form, 'submitButton');
1411 |      * // $I->amOnPage('/path/to/form-page') may be needed
1412 |      * $I->seeInFormFields('//form[@id=my-form]', $form);
1413 |      * ?>
1414 |      * ```
1415 |      *
1416 |      * @param $formSelector
1417 |      * @param $params
1418 |      * @see \Codeception\Lib\InnerBrowser::seeInFormFields()
1419 |      */
1420 |     public function seeInFormFields($formSelector, $params) {
1421 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInFormFields', func_get_args()));
1422 |     }
1423 | 
1424 |  
1425 |     /**
1426 |      * [!] Method is generated. Documentation taken from corresponding module.
1427 |      *
1428 |      * Checks if the array of form parameters (name => value) are not set on the form matched with
1429 |      * the passed selector.
1430 |      *
1431 |      * ``` php
1432 |      * <?php
1433 |      * $I->dontSeeInFormFields('form[name=myform]', [
1434 |      *      'input1' => 'non-existent value',
1435 |      *      'input2' => 'other non-existent value',
1436 |      * ]);
1437 |      * ?>
1438 |      * ```
1439 |      *
1440 |      * To check that an element hasn't been assigned any one of many values, an array can be passed
1441 |      * as the value:
1442 |      *
1443 |      * ``` php
1444 |      * <?php
1445 |      * $I->dontSeeInFormFields('.form-class', [
1446 |      *      'fieldName' => [
1447 |      *          'This value shouldn\'t be set',
1448 |      *          'And this value shouldn\'t be set',
1449 |      *      ],
1450 |      * ]);
1451 |      * ?>
1452 |      * ```
1453 |      *
1454 |      * Additionally, checkbox values can be checked with a boolean.
1455 |      *
1456 |      * ``` php
1457 |      * <?php
1458 |      * $I->dontSeeInFormFields('#form-id', [
1459 |      *      'checkbox1' => true,        // fails if checked
1460 |      *      'checkbox2' => false,       // fails if unchecked
1461 |      * ]);
1462 |      * ?>
1463 |      * ```
1464 |      *
1465 |      * @param $formSelector
1466 |      * @param $params
1467 |      * Conditional Assertion: Test won't be stopped on fail
1468 |      * @see \Codeception\Lib\InnerBrowser::dontSeeInFormFields()
1469 |      */
1470 |     public function cantSeeInFormFields($formSelector, $params) {
1471 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInFormFields', func_get_args()));
1472 |     }
1473 |     /**
1474 |      * [!] Method is generated. Documentation taken from corresponding module.
1475 |      *
1476 |      * Checks if the array of form parameters (name => value) are not set on the form matched with
1477 |      * the passed selector.
1478 |      *
1479 |      * ``` php
1480 |      * <?php
1481 |      * $I->dontSeeInFormFields('form[name=myform]', [
1482 |      *      'input1' => 'non-existent value',
1483 |      *      'input2' => 'other non-existent value',
1484 |      * ]);
1485 |      * ?>
1486 |      * ```
1487 |      *
1488 |      * To check that an element hasn't been assigned any one of many values, an array can be passed
1489 |      * as the value:
1490 |      *
1491 |      * ``` php
1492 |      * <?php
1493 |      * $I->dontSeeInFormFields('.form-class', [
1494 |      *      'fieldName' => [
1495 |      *          'This value shouldn\'t be set',
1496 |      *          'And this value shouldn\'t be set',
1497 |      *      ],
1498 |      * ]);
1499 |      * ?>
1500 |      * ```
1501 |      *
1502 |      * Additionally, checkbox values can be checked with a boolean.
1503 |      *
1504 |      * ``` php
1505 |      * <?php
1506 |      * $I->dontSeeInFormFields('#form-id', [
1507 |      *      'checkbox1' => true,        // fails if checked
1508 |      *      'checkbox2' => false,       // fails if unchecked
1509 |      * ]);
1510 |      * ?>
1511 |      * ```
1512 |      *
1513 |      * @param $formSelector
1514 |      * @param $params
1515 |      * @see \Codeception\Lib\InnerBrowser::dontSeeInFormFields()
1516 |      */
1517 |     public function dontSeeInFormFields($formSelector, $params) {
1518 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeInFormFields', func_get_args()));
1519 |     }
1520 | 
1521 |  
1522 |     /**
1523 |      * [!] Method is generated. Documentation taken from corresponding module.
1524 |      *
1525 |      * Submits the given form on the page, optionally with the given form
1526 |      * values.  Pass the form field's values as an array in the second
1527 |      * parameter.
1528 |      *
1529 |      * Although this function can be used as a short-hand version of
1530 |      * `fillField()`, `selectOption()`, `click()` etc. it has some important
1531 |      * differences:
1532 |      *
1533 |      *  * Only field *names* may be used, not CSS/XPath selectors nor field labels
1534 |      *  * If a field is sent to this function that does *not* exist on the page,
1535 |      *    it will silently be added to the HTTP request.  This is helpful for testing
1536 |      *    some types of forms, but be aware that you will *not* get an exception
1537 |      *    like you would if you called `fillField()` or `selectOption()` with
1538 |      *    a missing field.
1539 |      *
1540 |      * Fields that are not provided will be filled by their values from the page,
1541 |      * or from any previous calls to `fillField()`, `selectOption()` etc.
1542 |      * You don't need to click the 'Submit' button afterwards.
1543 |      * This command itself triggers the request to form's action.
1544 |      *
1545 |      * You can optionally specify which button's value to include
1546 |      * in the request with the last parameter (as an alternative to
1547 |      * explicitly setting its value in the second parameter), as
1548 |      * button values are not otherwise included in the request.
1549 |      *
1550 |      * Examples:
1551 |      *
1552 |      * ``` php
1553 |      * <?php
1554 |      * $I->submitForm('#login', [
1555 |      *     'login' => 'davert',
1556 |      *     'password' => '123456'
1557 |      * ]);
1558 |      * // or
1559 |      * $I->submitForm('#login', [
1560 |      *     'login' => 'davert',
1561 |      *     'password' => '123456'
1562 |      * ], 'submitButtonName');
1563 |      *
1564 |      * ```
1565 |      *
1566 |      * For example, given this sample "Sign Up" form:
1567 |      *
1568 |      * ``` html
1569 |      * <form action="/sign_up">
1570 |      *     Login:
1571 |      *     <input type="text" name="user[login]" /><br/>
1572 |      *     Password:
1573 |      *     <input type="password" name="user[password]" /><br/>
1574 |      *     Do you agree to our terms?
1575 |      *     <input type="checkbox" name="user[agree]" /><br/>
1576 |      *     Select pricing plan:
1577 |      *     <select name="plan">
1578 |      *         <option value="1">Free</option>
1579 |      *         <option value="2" selected="selected">Paid</option>
1580 |      *     </select>
1581 |      *     <input type="submit" name="submitButton" value="Submit" />
1582 |      * </form>
1583 |      * ```
1584 |      *
1585 |      * You could write the following to submit it:
1586 |      *
1587 |      * ``` php
1588 |      * <?php
1589 |      * $I->submitForm(
1590 |      *     '#userForm',
1591 |      *     [
1592 |      *         'user' => [
1593 |      *             'login' => 'Davert',
1594 |      *             'password' => '123456',
1595 |      *             'agree' => true
1596 |      *         ]
1597 |      *     ],
1598 |      *     'submitButton'
1599 |      * );
1600 |      * ```
1601 |      * Note that "2" will be the submitted value for the "plan" field, as it is
1602 |      * the selected option.
1603 |      *
1604 |      * You can also emulate a JavaScript submission by not specifying any
1605 |      * buttons in the third parameter to submitForm.
1606 |      *
1607 |      * ```php
1608 |      * <?php
1609 |      * $I->submitForm(
1610 |      *     '#userForm',
1611 |      *     [
1612 |      *         'user' => [
1613 |      *             'login' => 'Davert',
1614 |      *             'password' => '123456',
1615 |      *             'agree' => true
1616 |      *         ]
1617 |      *     ]
1618 |      * );
1619 |      * ```
1620 |      *
1621 |      * This function works well when paired with `seeInFormFields()`
1622 |      * for quickly testing CRUD interfaces and form validation logic.
1623 |      *
1624 |      * ``` php
1625 |      * <?php
1626 |      * $form = [
1627 |      *      'field1' => 'value',
1628 |      *      'field2' => 'another value',
1629 |      *      'checkbox1' => true,
1630 |      *      // ...
1631 |      * ];
1632 |      * $I->submitForm('#my-form', $form, 'submitButton');
1633 |      * // $I->amOnPage('/path/to/form-page') may be needed
1634 |      * $I->seeInFormFields('#my-form', $form);
1635 |      * ```
1636 |      *
1637 |      * Parameter values can be set to arrays for multiple input fields
1638 |      * of the same name, or multi-select combo boxes.  For checkboxes,
1639 |      * you can use either the string value or boolean `true`/`false` which will
1640 |      * be replaced by the checkbox's value in the DOM.
1641 |      *
1642 |      * ``` php
1643 |      * <?php
1644 |      * $I->submitForm('#my-form', [
1645 |      *      'field1' => 'value',
1646 |      *      'checkbox' => [
1647 |      *          'value of first checkbox',
1648 |      *          'value of second checkbox',
1649 |      *      ],
1650 |      *      'otherCheckboxes' => [
1651 |      *          true,
1652 |      *          false,
1653 |      *          false
1654 |      *      ],
1655 |      *      'multiselect' => [
1656 |      *          'first option value',
1657 |      *          'second option value'
1658 |      *      ]
1659 |      * ]);
1660 |      * ```
1661 |      *
1662 |      * Mixing string and boolean values for a checkbox's value is not supported
1663 |      * and may produce unexpected results.
1664 |      *
1665 |      * Field names ending in `[]` must be passed without the trailing square
1666 |      * bracket characters, and must contain an array for its value.  This allows
1667 |      * submitting multiple values with the same name, consider:
1668 |      *
1669 |      * ```php
1670 |      * <?php
1671 |      * // This will NOT work correctly
1672 |      * $I->submitForm('#my-form', [
1673 |      *     'field[]' => 'value',
1674 |      *     'field[]' => 'another value',  // 'field[]' is already a defined key
1675 |      * ]);
1676 |      * ```
1677 |      *
1678 |      * The solution is to pass an array value:
1679 |      *
1680 |      * ```php
1681 |      * <?php
1682 |      * // This way both values are submitted
1683 |      * $I->submitForm('#my-form', [
1684 |      *     'field' => [
1685 |      *         'value',
1686 |      *         'another value',
1687 |      *     ]
1688 |      * ]);
1689 |      * ```
1690 |      *
1691 |      * @param $selector
1692 |      * @param $params
1693 |      * @param $button
1694 |      * @see \Codeception\Lib\InnerBrowser::submitForm()
1695 |      */
1696 |     public function submitForm($selector, $params, $button = null) {
1697 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('submitForm', func_get_args()));
1698 |     }
1699 | 
1700 |  
1701 |     /**
1702 |      * [!] Method is generated. Documentation taken from corresponding module.
1703 |      *
1704 |      * Fills a text field or textarea with the given string.
1705 |      *
1706 |      * ``` php
1707 |      * <?php
1708 |      * $I->fillField("//input[@type='text']", "Hello World!");
1709 |      * $I->fillField(['name' => 'email'], 'jon@mail.com');
1710 |      * ?>
1711 |      * ```
1712 |      *
1713 |      * @param $field
1714 |      * @param $value
1715 |      * @see \Codeception\Lib\InnerBrowser::fillField()
1716 |      */
1717 |     public function fillField($field, $value) {
1718 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('fillField', func_get_args()));
1719 |     }
1720 | 
1721 |  
1722 |     /**
1723 |      * [!] Method is generated. Documentation taken from corresponding module.
1724 |      *
1725 |      * Selects an option in a select tag or in radio button group.
1726 |      *
1727 |      * ``` php
1728 |      * <?php
1729 |      * $I->selectOption('form select[name=account]', 'Premium');
1730 |      * $I->selectOption('form input[name=payment]', 'Monthly');
1731 |      * $I->selectOption('//form/select[@name=account]', 'Monthly');
1732 |      * ?>
1733 |      * ```
1734 |      *
1735 |      * Provide an array for the second argument to select multiple options:
1736 |      *
1737 |      * ``` php
1738 |      * <?php
1739 |      * $I->selectOption('Which OS do you use?', array('Windows','Linux'));
1740 |      * ?>
1741 |      * ```
1742 |      *
1743 |      * Or provide an associative array for the second argument to specifically define which selection method should be used:
1744 |      *
1745 |      * ``` php
1746 |      * <?php
1747 |      * $I->selectOption('Which OS do you use?', array('text' => 'Windows')); // Only search by text 'Windows'
1748 |      * $I->selectOption('Which OS do you use?', array('value' => 'windows')); // Only search by value 'windows'
1749 |      * ?>
1750 |      * ```
1751 |      *
1752 |      * @param $select
1753 |      * @param $option
1754 |      * @see \Codeception\Lib\InnerBrowser::selectOption()
1755 |      */
1756 |     public function selectOption($select, $option) {
1757 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('selectOption', func_get_args()));
1758 |     }
1759 | 
1760 |  
1761 |     /**
1762 |      * [!] Method is generated. Documentation taken from corresponding module.
1763 |      *
1764 |      * Ticks a checkbox. For radio buttons, use the `selectOption` method instead.
1765 |      *
1766 |      * ``` php
1767 |      * <?php
1768 |      * $I->checkOption('#agree');
1769 |      * ?>
1770 |      * ```
1771 |      *
1772 |      * @param $option
1773 |      * @see \Codeception\Lib\InnerBrowser::checkOption()
1774 |      */
1775 |     public function checkOption($option) {
1776 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('checkOption', func_get_args()));
1777 |     }
1778 | 
1779 |  
1780 |     /**
1781 |      * [!] Method is generated. Documentation taken from corresponding module.
1782 |      *
1783 |      * Unticks a checkbox.
1784 |      *
1785 |      * ``` php
1786 |      * <?php
1787 |      * $I->uncheckOption('#notify');
1788 |      * ?>
1789 |      * ```
1790 |      *
1791 |      * @param $option
1792 |      * @see \Codeception\Lib\InnerBrowser::uncheckOption()
1793 |      */
1794 |     public function uncheckOption($option) {
1795 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('uncheckOption', func_get_args()));
1796 |     }
1797 | 
1798 |  
1799 |     /**
1800 |      * [!] Method is generated. Documentation taken from corresponding module.
1801 |      *
1802 |      * Attaches a file relative to the Codeception data directory to the given file upload field.
1803 |      *
1804 |      * ``` php
1805 |      * <?php
1806 |      * // file is stored in 'tests/_data/prices.xls'
1807 |      * $I->attachFile('input[@type="file"]', 'prices.xls');
1808 |      * ?>
1809 |      * ```
1810 |      *
1811 |      * @param $field
1812 |      * @param $filename
1813 |      * @see \Codeception\Lib\InnerBrowser::attachFile()
1814 |      */
1815 |     public function attachFile($field, $filename) {
1816 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('attachFile', func_get_args()));
1817 |     }
1818 | 
1819 |  
1820 |     /**
1821 |      * [!] Method is generated. Documentation taken from corresponding module.
1822 |      *
1823 |      * If your page triggers an ajax request, you can perform it manually.
1824 |      * This action sends a GET ajax request with specified params.
1825 |      *
1826 |      * See ->sendAjaxPostRequest for examples.
1827 |      *
1828 |      * @param $uri
1829 |      * @param $params
1830 |      * @see \Codeception\Lib\InnerBrowser::sendAjaxGetRequest()
1831 |      */
1832 |     public function sendAjaxGetRequest($uri, $params = null) {
1833 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('sendAjaxGetRequest', func_get_args()));
1834 |     }
1835 | 
1836 |  
1837 |     /**
1838 |      * [!] Method is generated. Documentation taken from corresponding module.
1839 |      *
1840 |      * If your page triggers an ajax request, you can perform it manually.
1841 |      * This action sends a POST ajax request with specified params.
1842 |      * Additional params can be passed as array.
1843 |      *
1844 |      * Example:
1845 |      *
1846 |      * Imagine that by clicking checkbox you trigger ajax request which updates user settings.
1847 |      * We emulate that click by running this ajax request manually.
1848 |      *
1849 |      * ``` php
1850 |      * <?php
1851 |      * $I->sendAjaxPostRequest('/updateSettings', array('notifications' => true)); // POST
1852 |      * $I->sendAjaxGetRequest('/updateSettings', array('notifications' => true)); // GET
1853 |      *
1854 |      * ```
1855 |      *
1856 |      * @param $uri
1857 |      * @param $params
1858 |      * @see \Codeception\Lib\InnerBrowser::sendAjaxPostRequest()
1859 |      */
1860 |     public function sendAjaxPostRequest($uri, $params = null) {
1861 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('sendAjaxPostRequest', func_get_args()));
1862 |     }
1863 | 
1864 |  
1865 |     /**
1866 |      * [!] Method is generated. Documentation taken from corresponding module.
1867 |      *
1868 |      * If your page triggers an ajax request, you can perform it manually.
1869 |      * This action sends an ajax request with specified method and params.
1870 |      *
1871 |      * Example:
1872 |      *
1873 |      * You need to perform an ajax request specifying the HTTP method.
1874 |      *
1875 |      * ``` php
1876 |      * <?php
1877 |      * $I->sendAjaxRequest('PUT', '/posts/7', array('title' => 'new title'));
1878 |      *
1879 |      * ```
1880 |      *
1881 |      * @param $method
1882 |      * @param $uri
1883 |      * @param $params
1884 |      * @see \Codeception\Lib\InnerBrowser::sendAjaxRequest()
1885 |      */
1886 |     public function sendAjaxRequest($method, $uri, $params = null) {
1887 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('sendAjaxRequest', func_get_args()));
1888 |     }
1889 | 
1890 |  
1891 |     /**
1892 |      * [!] Method is generated. Documentation taken from corresponding module.
1893 |      *
1894 |      * Finds and returns the text contents of the given element.
1895 |      * If a fuzzy locator is used, the element is found using CSS, XPath,
1896 |      * and by matching the full page source by regular expression.
1897 |      *
1898 |      * ``` php
1899 |      * <?php
1900 |      * $heading = $I->grabTextFrom('h1');
1901 |      * $heading = $I->grabTextFrom('descendant-or-self::h1');
1902 |      * $value = $I->grabTextFrom('~<input value=(.*?)]~sgi'); // match with a regex
1903 |      * ?>
1904 |      * ```
1905 |      *
1906 |      * @param $cssOrXPathOrRegex
1907 |      *
1908 |      * @return mixed
1909 |      * @see \Codeception\Lib\InnerBrowser::grabTextFrom()
1910 |      */
1911 |     public function grabTextFrom($cssOrXPathOrRegex) {
1912 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('grabTextFrom', func_get_args()));
1913 |     }
1914 | 
1915 |  
1916 |     /**
1917 |      * [!] Method is generated. Documentation taken from corresponding module.
1918 |      *
1919 |      * Grabs the value of the given attribute value from the given element.
1920 |      * Fails if element is not found.
1921 |      *
1922 |      * ``` php
1923 |      * <?php
1924 |      * $I->grabAttributeFrom('#tooltip', 'title');
1925 |      * ?>
1926 |      * ```
1927 |      *
1928 |      *
1929 |      * @param $cssOrXpath
1930 |      * @param $attribute
1931 |      *
1932 |      * @return mixed
1933 |      * @see \Codeception\Lib\InnerBrowser::grabAttributeFrom()
1934 |      */
1935 |     public function grabAttributeFrom($cssOrXpath, $attribute) {
1936 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('grabAttributeFrom', func_get_args()));
1937 |     }
1938 | 
1939 |  
1940 |     /**
1941 |      * [!] Method is generated. Documentation taken from corresponding module.
1942 |      *
1943 |      * Grabs either the text content, or attribute values, of nodes
1944 |      * matched by $cssOrXpath and returns them as an array.
1945 |      *
1946 |      * ```html
1947 |      * <a href="#first">First</a>
1948 |      * <a href="#second">Second</a>
1949 |      * <a href="#third">Third</a>
1950 |      * ```
1951 |      *
1952 |      * ```php
1953 |      * <?php
1954 |      * // would return ['First', 'Second', 'Third']
1955 |      * $aLinkText = $I->grabMultiple('a');
1956 |      *
1957 |      * // would return ['#first', '#second', '#third']
1958 |      * $aLinks = $I->grabMultiple('a', 'href');
1959 |      * ?>
1960 |      * ```
1961 |      *
1962 |      * @param $cssOrXpath
1963 |      * @param $attribute
1964 |      * @return string[]
1965 |      * @see \Codeception\Lib\InnerBrowser::grabMultiple()
1966 |      */
1967 |     public function grabMultiple($cssOrXpath, $attribute = null) {
1968 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('grabMultiple', func_get_args()));
1969 |     }
1970 | 
1971 |  
1972 |     /**
1973 |      * [!] Method is generated. Documentation taken from corresponding module.
1974 |      *
1975 |      * @param $field
1976 |      *
1977 |      * @return array|mixed|null|string
1978 |      * @see \Codeception\Lib\InnerBrowser::grabValueFrom()
1979 |      */
1980 |     public function grabValueFrom($field) {
1981 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('grabValueFrom', func_get_args()));
1982 |     }
1983 | 
1984 |  
1985 |     /**
1986 |      * [!] Method is generated. Documentation taken from corresponding module.
1987 |      *
1988 |      * Sets a cookie with the given name and value.
1989 |      * You can set additional cookie params like `domain`, `path`, `expires`, `secure` in array passed as last argument.
1990 |      *
1991 |      * ``` php
1992 |      * <?php
1993 |      * $I->setCookie('PHPSESSID', 'el4ukv0kqbvoirg7nkp4dncpk3');
1994 |      * ?>
1995 |      * ```
1996 |      *
1997 |      * @param $name
1998 |      * @param $val
1999 |      * @param array $params
2000 |      *
2001 |      * @return mixed
2002 |      * @see \Codeception\Lib\InnerBrowser::setCookie()
2003 |      */
2004 |     public function setCookie($name, $val, $params = null) {
2005 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('setCookie', func_get_args()));
2006 |     }
2007 | 
2008 |  
2009 |     /**
2010 |      * [!] Method is generated. Documentation taken from corresponding module.
2011 |      *
2012 |      * Grabs a cookie value.
2013 |      * You can set additional cookie params like `domain`, `path` in array passed as last argument.
2014 |      *
2015 |      * @param $cookie
2016 |      *
2017 |      * @param array $params
2018 |      * @return mixed
2019 |      * @see \Codeception\Lib\InnerBrowser::grabCookie()
2020 |      */
2021 |     public function grabCookie($cookie, $params = null) {
2022 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('grabCookie', func_get_args()));
2023 |     }
2024 | 
2025 |  
2026 |     /**
2027 |      * [!] Method is generated. Documentation taken from corresponding module.
2028 |      *
2029 |      * Grabs current page source code.
2030 |      *
2031 |      * @throws ModuleException if no page was opened.
2032 |      *
2033 |      * @return string Current page source code.
2034 |      * @see \Codeception\Lib\InnerBrowser::grabPageSource()
2035 |      */
2036 |     public function grabPageSource() {
2037 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('grabPageSource', func_get_args()));
2038 |     }
2039 | 
2040 |  
2041 |     /**
2042 |      * [!] Method is generated. Documentation taken from corresponding module.
2043 |      *
2044 |      * Checks that a cookie with the given name is set.
2045 |      * You can set additional cookie params like `domain`, `path` as array passed in last argument.
2046 |      *
2047 |      * ``` php
2048 |      * <?php
2049 |      * $I->seeCookie('PHPSESSID');
2050 |      * ?>
2051 |      * ```
2052 |      *
2053 |      * @param $cookie
2054 |      * @param array $params
2055 |      * @return mixed
2056 |      * Conditional Assertion: Test won't be stopped on fail
2057 |      * @see \Codeception\Lib\InnerBrowser::seeCookie()
2058 |      */
2059 |     public function canSeeCookie($cookie, $params = null) {
2060 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeCookie', func_get_args()));
2061 |     }
2062 |     /**
2063 |      * [!] Method is generated. Documentation taken from corresponding module.
2064 |      *
2065 |      * Checks that a cookie with the given name is set.
2066 |      * You can set additional cookie params like `domain`, `path` as array passed in last argument.
2067 |      *
2068 |      * ``` php
2069 |      * <?php
2070 |      * $I->seeCookie('PHPSESSID');
2071 |      * ?>
2072 |      * ```
2073 |      *
2074 |      * @param $cookie
2075 |      * @param array $params
2076 |      * @return mixed
2077 |      * @see \Codeception\Lib\InnerBrowser::seeCookie()
2078 |      */
2079 |     public function seeCookie($cookie, $params = null) {
2080 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCookie', func_get_args()));
2081 |     }
2082 | 
2083 |  
2084 |     /**
2085 |      * [!] Method is generated. Documentation taken from corresponding module.
2086 |      *
2087 |      * Checks that there isn't a cookie with the given name.
2088 |      * You can set additional cookie params like `domain`, `path` as array passed in last argument.
2089 |      *
2090 |      * @param $cookie
2091 |      *
2092 |      * @param array $params
2093 |      * @return mixed
2094 |      * Conditional Assertion: Test won't be stopped on fail
2095 |      * @see \Codeception\Lib\InnerBrowser::dontSeeCookie()
2096 |      */
2097 |     public function cantSeeCookie($cookie, $params = null) {
2098 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeCookie', func_get_args()));
2099 |     }
2100 |     /**
2101 |      * [!] Method is generated. Documentation taken from corresponding module.
2102 |      *
2103 |      * Checks that there isn't a cookie with the given name.
2104 |      * You can set additional cookie params like `domain`, `path` as array passed in last argument.
2105 |      *
2106 |      * @param $cookie
2107 |      *
2108 |      * @param array $params
2109 |      * @return mixed
2110 |      * @see \Codeception\Lib\InnerBrowser::dontSeeCookie()
2111 |      */
2112 |     public function dontSeeCookie($cookie, $params = null) {
2113 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeCookie', func_get_args()));
2114 |     }
2115 | 
2116 |  
2117 |     /**
2118 |      * [!] Method is generated. Documentation taken from corresponding module.
2119 |      *
2120 |      * Unsets cookie with the given name.
2121 |      * You can set additional cookie params like `domain`, `path` in array passed as last argument.
2122 |      *
2123 |      * @param $cookie
2124 |      *
2125 |      * @param array $params
2126 |      * @return mixed
2127 |      * @see \Codeception\Lib\InnerBrowser::resetCookie()
2128 |      */
2129 |     public function resetCookie($name, $params = null) {
2130 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('resetCookie', func_get_args()));
2131 |     }
2132 | 
2133 |  
2134 |     /**
2135 |      * [!] Method is generated. Documentation taken from corresponding module.
2136 |      *
2137 |      * Checks that the given element exists on the page and is visible.
2138 |      * You can also specify expected attributes of this element.
2139 |      *
2140 |      * ``` php
2141 |      * <?php
2142 |      * $I->seeElement('.error');
2143 |      * $I->seeElement('//form/input[1]');
2144 |      * $I->seeElement('input', ['name' => 'login']);
2145 |      * $I->seeElement('input', ['value' => '123456']);
2146 |      *
2147 |      * // strict locator in first arg, attributes in second
2148 |      * $I->seeElement(['css' => 'form input'], ['name' => 'login']);
2149 |      * ?>
2150 |      * ```
2151 |      *
2152 |      * @param $selector
2153 |      * @param array $attributes
2154 |      * @return
2155 |      * Conditional Assertion: Test won't be stopped on fail
2156 |      * @see \Codeception\Lib\InnerBrowser::seeElement()
2157 |      */
2158 |     public function canSeeElement($selector, $attributes = null) {
2159 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeElement', func_get_args()));
2160 |     }
2161 |     /**
2162 |      * [!] Method is generated. Documentation taken from corresponding module.
2163 |      *
2164 |      * Checks that the given element exists on the page and is visible.
2165 |      * You can also specify expected attributes of this element.
2166 |      *
2167 |      * ``` php
2168 |      * <?php
2169 |      * $I->seeElement('.error');
2170 |      * $I->seeElement('//form/input[1]');
2171 |      * $I->seeElement('input', ['name' => 'login']);
2172 |      * $I->seeElement('input', ['value' => '123456']);
2173 |      *
2174 |      * // strict locator in first arg, attributes in second
2175 |      * $I->seeElement(['css' => 'form input'], ['name' => 'login']);
2176 |      * ?>
2177 |      * ```
2178 |      *
2179 |      * @param $selector
2180 |      * @param array $attributes
2181 |      * @return
2182 |      * @see \Codeception\Lib\InnerBrowser::seeElement()
2183 |      */
2184 |     public function seeElement($selector, $attributes = null) {
2185 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeElement', func_get_args()));
2186 |     }
2187 | 
2188 |  
2189 |     /**
2190 |      * [!] Method is generated. Documentation taken from corresponding module.
2191 |      *
2192 |      * Checks that the given element is invisible or not present on the page.
2193 |      * You can also specify expected attributes of this element.
2194 |      *
2195 |      * ``` php
2196 |      * <?php
2197 |      * $I->dontSeeElement('.error');
2198 |      * $I->dontSeeElement('//form/input[1]');
2199 |      * $I->dontSeeElement('input', ['name' => 'login']);
2200 |      * $I->dontSeeElement('input', ['value' => '123456']);
2201 |      * ?>
2202 |      * ```
2203 |      *
2204 |      * @param $selector
2205 |      * @param array $attributes
2206 |      * Conditional Assertion: Test won't be stopped on fail
2207 |      * @see \Codeception\Lib\InnerBrowser::dontSeeElement()
2208 |      */
2209 |     public function cantSeeElement($selector, $attributes = null) {
2210 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeElement', func_get_args()));
2211 |     }
2212 |     /**
2213 |      * [!] Method is generated. Documentation taken from corresponding module.
2214 |      *
2215 |      * Checks that the given element is invisible or not present on the page.
2216 |      * You can also specify expected attributes of this element.
2217 |      *
2218 |      * ``` php
2219 |      * <?php
2220 |      * $I->dontSeeElement('.error');
2221 |      * $I->dontSeeElement('//form/input[1]');
2222 |      * $I->dontSeeElement('input', ['name' => 'login']);
2223 |      * $I->dontSeeElement('input', ['value' => '123456']);
2224 |      * ?>
2225 |      * ```
2226 |      *
2227 |      * @param $selector
2228 |      * @param array $attributes
2229 |      * @see \Codeception\Lib\InnerBrowser::dontSeeElement()
2230 |      */
2231 |     public function dontSeeElement($selector, $attributes = null) {
2232 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeElement', func_get_args()));
2233 |     }
2234 | 
2235 |  
2236 |     /**
2237 |      * [!] Method is generated. Documentation taken from corresponding module.
2238 |      *
2239 |      * Checks that there are a certain number of elements matched by the given locator on the page.
2240 |      *
2241 |      * ``` php
2242 |      * <?php
2243 |      * $I->seeNumberOfElements('tr', 10);
2244 |      * $I->seeNumberOfElements('tr', [0,10]); //between 0 and 10 elements
2245 |      * ?>
2246 |      * ```
2247 |      * @param $selector
2248 |      * @param mixed $expected :
2249 |      * - string: strict number
2250 |      * - array: range of numbers [0,10]
2251 |      * Conditional Assertion: Test won't be stopped on fail
2252 |      * @see \Codeception\Lib\InnerBrowser::seeNumberOfElements()
2253 |      */
2254 |     public function canSeeNumberOfElements($selector, $expected) {
2255 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeNumberOfElements', func_get_args()));
2256 |     }
2257 |     /**
2258 |      * [!] Method is generated. Documentation taken from corresponding module.
2259 |      *
2260 |      * Checks that there are a certain number of elements matched by the given locator on the page.
2261 |      *
2262 |      * ``` php
2263 |      * <?php
2264 |      * $I->seeNumberOfElements('tr', 10);
2265 |      * $I->seeNumberOfElements('tr', [0,10]); //between 0 and 10 elements
2266 |      * ?>
2267 |      * ```
2268 |      * @param $selector
2269 |      * @param mixed $expected :
2270 |      * - string: strict number
2271 |      * - array: range of numbers [0,10]
2272 |      * @see \Codeception\Lib\InnerBrowser::seeNumberOfElements()
2273 |      */
2274 |     public function seeNumberOfElements($selector, $expected) {
2275 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeNumberOfElements', func_get_args()));
2276 |     }
2277 | 
2278 |  
2279 |     /**
2280 |      * [!] Method is generated. Documentation taken from corresponding module.
2281 |      *
2282 |      * Checks that the given option is selected.
2283 |      *
2284 |      * ``` php
2285 |      * <?php
2286 |      * $I->seeOptionIsSelected('#form input[name=payment]', 'Visa');
2287 |      * ?>
2288 |      * ```
2289 |      *
2290 |      * @param $selector
2291 |      * @param $optionText
2292 |      *
2293 |      * @return mixed
2294 |      * Conditional Assertion: Test won't be stopped on fail
2295 |      * @see \Codeception\Lib\InnerBrowser::seeOptionIsSelected()
2296 |      */
2297 |     public function canSeeOptionIsSelected($selector, $optionText) {
2298 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeOptionIsSelected', func_get_args()));
2299 |     }
2300 |     /**
2301 |      * [!] Method is generated. Documentation taken from corresponding module.
2302 |      *
2303 |      * Checks that the given option is selected.
2304 |      *
2305 |      * ``` php
2306 |      * <?php
2307 |      * $I->seeOptionIsSelected('#form input[name=payment]', 'Visa');
2308 |      * ?>
2309 |      * ```
2310 |      *
2311 |      * @param $selector
2312 |      * @param $optionText
2313 |      *
2314 |      * @return mixed
2315 |      * @see \Codeception\Lib\InnerBrowser::seeOptionIsSelected()
2316 |      */
2317 |     public function seeOptionIsSelected($selector, $optionText) {
2318 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeOptionIsSelected', func_get_args()));
2319 |     }
2320 | 
2321 |  
2322 |     /**
2323 |      * [!] Method is generated. Documentation taken from corresponding module.
2324 |      *
2325 |      * Checks that the given option is not selected.
2326 |      *
2327 |      * ``` php
2328 |      * <?php
2329 |      * $I->dontSeeOptionIsSelected('#form input[name=payment]', 'Visa');
2330 |      * ?>
2331 |      * ```
2332 |      *
2333 |      * @param $selector
2334 |      * @param $optionText
2335 |      *
2336 |      * @return mixed
2337 |      * Conditional Assertion: Test won't be stopped on fail
2338 |      * @see \Codeception\Lib\InnerBrowser::dontSeeOptionIsSelected()
2339 |      */
2340 |     public function cantSeeOptionIsSelected($selector, $optionText) {
2341 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeOptionIsSelected', func_get_args()));
2342 |     }
2343 |     /**
2344 |      * [!] Method is generated. Documentation taken from corresponding module.
2345 |      *
2346 |      * Checks that the given option is not selected.
2347 |      *
2348 |      * ``` php
2349 |      * <?php
2350 |      * $I->dontSeeOptionIsSelected('#form input[name=payment]', 'Visa');
2351 |      * ?>
2352 |      * ```
2353 |      *
2354 |      * @param $selector
2355 |      * @param $optionText
2356 |      *
2357 |      * @return mixed
2358 |      * @see \Codeception\Lib\InnerBrowser::dontSeeOptionIsSelected()
2359 |      */
2360 |     public function dontSeeOptionIsSelected($selector, $optionText) {
2361 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeOptionIsSelected', func_get_args()));
2362 |     }
2363 | 
2364 |  
2365 |     /**
2366 |      * [!] Method is generated. Documentation taken from corresponding module.
2367 |      *
2368 |      * Asserts that current page has 404 response status code.
2369 |      * Conditional Assertion: Test won't be stopped on fail
2370 |      * @see \Codeception\Lib\InnerBrowser::seePageNotFound()
2371 |      */
2372 |     public function canSeePageNotFound() {
2373 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seePageNotFound', func_get_args()));
2374 |     }
2375 |     /**
2376 |      * [!] Method is generated. Documentation taken from corresponding module.
2377 |      *
2378 |      * Asserts that current page has 404 response status code.
2379 |      * @see \Codeception\Lib\InnerBrowser::seePageNotFound()
2380 |      */
2381 |     public function seePageNotFound() {
2382 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seePageNotFound', func_get_args()));
2383 |     }
2384 | 
2385 |  
2386 |     /**
2387 |      * [!] Method is generated. Documentation taken from corresponding module.
2388 |      *
2389 |      * Checks that response code is equal to value provided.
2390 |      *
2391 |      * ```php
2392 |      * <?php
2393 |      * $I->seeResponseCodeIs(200);
2394 |      *
2395 |      * // recommended \Codeception\Util\HttpCode
2396 |      * $I->seeResponseCodeIs(\Codeception\Util\HttpCode::OK);
2397 |      * ```
2398 |      *
2399 |      * @param $code
2400 |      * Conditional Assertion: Test won't be stopped on fail
2401 |      * @see \Codeception\Lib\InnerBrowser::seeResponseCodeIs()
2402 |      */
2403 |     public function canSeeResponseCodeIs($code) {
2404 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeResponseCodeIs', func_get_args()));
2405 |     }
2406 |     /**
2407 |      * [!] Method is generated. Documentation taken from corresponding module.
2408 |      *
2409 |      * Checks that response code is equal to value provided.
2410 |      *
2411 |      * ```php
2412 |      * <?php
2413 |      * $I->seeResponseCodeIs(200);
2414 |      *
2415 |      * // recommended \Codeception\Util\HttpCode
2416 |      * $I->seeResponseCodeIs(\Codeception\Util\HttpCode::OK);
2417 |      * ```
2418 |      *
2419 |      * @param $code
2420 |      * @see \Codeception\Lib\InnerBrowser::seeResponseCodeIs()
2421 |      */
2422 |     public function seeResponseCodeIs($code) {
2423 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeResponseCodeIs', func_get_args()));
2424 |     }
2425 | 
2426 |  
2427 |     /**
2428 |      * [!] Method is generated. Documentation taken from corresponding module.
2429 |      *
2430 |      * Checks that response code is equal to value provided.
2431 |      *
2432 |      * ```php
2433 |      * <?php
2434 |      * $I->dontSeeResponseCodeIs(200);
2435 |      *
2436 |      * // recommended \Codeception\Util\HttpCode
2437 |      * $I->dontSeeResponseCodeIs(\Codeception\Util\HttpCode::OK);
2438 |      * ```
2439 |      * @param $code
2440 |      * Conditional Assertion: Test won't be stopped on fail
2441 |      * @see \Codeception\Lib\InnerBrowser::dontSeeResponseCodeIs()
2442 |      */
2443 |     public function cantSeeResponseCodeIs($code) {
2444 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeResponseCodeIs', func_get_args()));
2445 |     }
2446 |     /**
2447 |      * [!] Method is generated. Documentation taken from corresponding module.
2448 |      *
2449 |      * Checks that response code is equal to value provided.
2450 |      *
2451 |      * ```php
2452 |      * <?php
2453 |      * $I->dontSeeResponseCodeIs(200);
2454 |      *
2455 |      * // recommended \Codeception\Util\HttpCode
2456 |      * $I->dontSeeResponseCodeIs(\Codeception\Util\HttpCode::OK);
2457 |      * ```
2458 |      * @param $code
2459 |      * @see \Codeception\Lib\InnerBrowser::dontSeeResponseCodeIs()
2460 |      */
2461 |     public function dontSeeResponseCodeIs($code) {
2462 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeResponseCodeIs', func_get_args()));
2463 |     }
2464 | 
2465 |  
2466 |     /**
2467 |      * [!] Method is generated. Documentation taken from corresponding module.
2468 |      *
2469 |      * Checks that the page title contains the given string.
2470 |      *
2471 |      * ``` php
2472 |      * <?php
2473 |      * $I->seeInTitle('Blog - Post #1');
2474 |      * ?>
2475 |      * ```
2476 |      *
2477 |      * @param $title
2478 |      *
2479 |      * @return mixed
2480 |      * Conditional Assertion: Test won't be stopped on fail
2481 |      * @see \Codeception\Lib\InnerBrowser::seeInTitle()
2482 |      */
2483 |     public function canSeeInTitle($title) {
2484 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInTitle', func_get_args()));
2485 |     }
2486 |     /**
2487 |      * [!] Method is generated. Documentation taken from corresponding module.
2488 |      *
2489 |      * Checks that the page title contains the given string.
2490 |      *
2491 |      * ``` php
2492 |      * <?php
2493 |      * $I->seeInTitle('Blog - Post #1');
2494 |      * ?>
2495 |      * ```
2496 |      *
2497 |      * @param $title
2498 |      *
2499 |      * @return mixed
2500 |      * @see \Codeception\Lib\InnerBrowser::seeInTitle()
2501 |      */
2502 |     public function seeInTitle($title) {
2503 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInTitle', func_get_args()));
2504 |     }
2505 | 
2506 |  
2507 |     /**
2508 |      * [!] Method is generated. Documentation taken from corresponding module.
2509 |      *
2510 |      * Checks that the page title does not contain the given string.
2511 |      *
2512 |      * @param $title
2513 |      *
2514 |      * @return mixed
2515 |      * Conditional Assertion: Test won't be stopped on fail
2516 |      * @see \Codeception\Lib\InnerBrowser::dontSeeInTitle()
2517 |      */
2518 |     public function cantSeeInTitle($title) {
2519 |         return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInTitle', func_get_args()));
2520 |     }
2521 |     /**
2522 |      * [!] Method is generated. Documentation taken from corresponding module.
2523 |      *
2524 |      * Checks that the page title does not contain the given string.
2525 |      *
2526 |      * @param $title
2527 |      *
2528 |      * @return mixed
2529 |      * @see \Codeception\Lib\InnerBrowser::dontSeeInTitle()
2530 |      */
2531 |     public function dontSeeInTitle($title) {
2532 |         return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeInTitle', func_get_args()));
2533 |     }
2534 | 
2535 |  
2536 |     /**
2537 |      * [!] Method is generated. Documentation taken from corresponding module.
2538 |      *
2539 |      * Switch to iframe or frame on the page.
2540 |      *
2541 |      * Example:
2542 |      * ``` html
2543 |      * <iframe name="another_frame" src="http://example.com">
2544 |      * ```
2545 |      *
2546 |      * ``` php
2547 |      * <?php
2548 |      * # switch to iframe
2549 |      * $I->switchToIframe("another_frame");
2550 |      * ```
2551 |      *
2552 |      * @param string $name
2553 |      * @see \Codeception\Lib\InnerBrowser::switchToIframe()
2554 |      */
2555 |     public function switchToIframe($name) {
2556 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('switchToIframe', func_get_args()));
2557 |     }
2558 | 
2559 |  
2560 |     /**
2561 |      * [!] Method is generated. Documentation taken from corresponding module.
2562 |      *
2563 |      * Moves back in history.
2564 |      *
2565 |      * @param int $numberOfSteps (default value 1)
2566 |      * @see \Codeception\Lib\InnerBrowser::moveBack()
2567 |      */
2568 |     public function moveBack($numberOfSteps = null) {
2569 |         return $this->getScenario()->runStep(new \Codeception\Step\Action('moveBack', func_get_args()));
2570 |     }
2571 | }
2572 | 


--------------------------------------------------------------------------------
/tests/tests/acceptance.suite.yml:
--------------------------------------------------------------------------------
 1 | # Codeception Test Suite Configuration
 2 | #
 3 | # Suite for acceptance tests.
 4 | # Perform tests in browser using the WebDriver or PhpBrowser.
 5 | # If you need both WebDriver and PHPBrowser tests - create a separate suite.
 6 | 
 7 | actor: AcceptanceTester
 8 | modules:
 9 |     enabled:
10 |         - PhpBrowser
11 |     config:
12 |         PhpBrowser:
13 |           # PLEASE ADJUST IT TO THE ACTUAL ENTRY POINT WITHOUT PATH INFO
14 |           url: http://localhost:8081
15 | 


--------------------------------------------------------------------------------
/tests/tests/acceptance/_bootstrap.php:
--------------------------------------------------------------------------------
1 | <?php
2 | //new yii\web\Application(require(dirname(__DIR__) . '/config/acceptance.php'));


--------------------------------------------------------------------------------
/tests/tests/config/config-local.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: gx
 5 |  * Date: 27/07/17
 6 |  * Time: 15.19
 7 |  */
 8 | return yii\helpers\ArrayHelper::merge(
 9 | 	require(__DIR__ . '/config.php'),
10 | 	require(__DIR__ . '/web.php'),
11 | 	[
12 | 	]
13 | );


--------------------------------------------------------------------------------
/tests/tests/config/config.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Application configuration shared by all test types
 4 |  */
 5 | return [
 6 | 	'id' => 'grptx-yii2-firebase-test',
 7 | 	'basePath' => dirname(dirname(__DIR__)), // @tests
 8 | 	'vendorPath' => dirname(dirname(dirname(__DIR__))) . '/vendor',
 9 | 	'language' => 'en-US',
10 | 
11 | 	'controllerMap' => [
12 | 		'fixture' => [
13 | 			'class' => 'yii\console\controllers\FixtureController',
14 | 			'namespace' => 'tests\codeception\fixtures',
15 | 		],
16 | 
17 | 	],
18 | 	'components' => [
19 | 		'mailer' => [
20 | 			'useFileTransport' => true,
21 | 		],
22 | 		'urlManager' => [
23 | 			'showScriptName' => true,
24 | 		],
25 | 		'authManager' => [
26 | 			'class' => 'yii\rbac\DbManager'
27 | 		],
28 | 		'cache' => [
29 | 			'class' => 'yii\caching\DummyCache',
30 | 		],
31 | 		'firebase' => [
32 | 			'class'=>'grptx\tests\FirebaseTest',
33 | 
34 | 			'database_uri'=>'https://yii2-firebase-2ed8f.firebaseio.com', // (optional)
35 | 		]
36 | 	],
37 | ];


--------------------------------------------------------------------------------
/tests/tests/config/web.php:
--------------------------------------------------------------------------------
1 | <?php
2 | return[
3 | 	'components' => [
4 | 		'request' => [
5 | 			'cookieValidationKey' => 'testme',
6 | 		],
7 | 	]
8 | ];


--------------------------------------------------------------------------------
/tests/tests/functional.suite.yml:
--------------------------------------------------------------------------------
 1 | # Codeception Test Suite Configuration
 2 | #
 3 | # Suite for functional tests
 4 | # Emulate web requests and make application process them
 5 | # Include one of framework modules (Symfony2, Yii2, Laravel5) to use it
 6 | # Remove this suite if you don't use frameworks
 7 | 
 8 | actor: FunctionalTester
 9 | modules:
10 |     enabled:
11 |         # add a framework module here
12 |         - \Helper\Functional
13 |         - Yii2


--------------------------------------------------------------------------------
/tests/tests/functional/_bootstrap.php:
--------------------------------------------------------------------------------
1 | <?php
2 | /**
3 |  * Created by PhpStorm.
4 |  * User: gx
5 |  * Date: 27/07/17
6 |  * Time: 15.20
7 |  */


--------------------------------------------------------------------------------
/tests/tests/unit.suite.yml:
--------------------------------------------------------------------------------
 1 | # Codeception Test Suite Configuration
 2 | #
 3 | # Suite for unit or integration tests.
 4 | 
 5 | class_name: UnitTester
 6 | modules:
 7 |     enabled:
 8 |         - Asserts
 9 |         - \Helper\Unit
10 |         - Yii2:
11 |             parts: [orm, email]


--------------------------------------------------------------------------------
/tests/tests/unit/FirebaseDatabaseTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | 
 4 | class FirebaseDatabaseTest extends \Codeception\Test\Unit {
 5 | 	/**
 6 | 	 * @var \UnitTester
 7 | 	 */
 8 | 	protected $tester;
 9 | 
10 | 
11 | 	protected function _before() {
12 | 	}
13 | 
14 | 	protected function _after() {
15 | 	}
16 | 
17 | 	// tests
18 | 	public function testRetrieveDb() {
19 | 		$database = \Yii::$app->firebase->getDatabase();
20 | 
21 | 		expect_that( $database instanceof \Kreait\Firebase\Database );
22 | 
23 | 	}
24 | 
25 | 	public function testGetReference() {
26 | 		$reference = \Yii::$app->firebase->getReference( 'node/path' );
27 | 
28 | 		expect_that( $reference instanceof \Kreait\Firebase\Database\Reference );
29 | 	}
30 | 
31 | }


--------------------------------------------------------------------------------
/tests/tests/unit/_bootstrap.php:
--------------------------------------------------------------------------------
1 | <?php
2 | /**
3 |  * Created by PhpStorm.
4 |  * User: gx
5 |  * Date: 27/07/17
6 |  * Time: 15.20
7 |  */


--------------------------------------------------------------------------------
/tests/web/assets/.gitignore:
--------------------------------------------------------------------------------
1 | *
2 | !.gitignore


--------------------------------------------------------------------------------
/tests/web/index-test.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | // NOTE: Make sure this file is not accessible when deployed to production
 3 | if (!in_array(@$_SERVER['REMOTE_ADDR'], ['127.0.0.1', '::1'])) {
 4 | 	die('You are not allowed to access this file.');
 5 | }
 6 | defined('YII_DEBUG') or define('YII_DEBUG', true);
 7 | defined('YII_ENV') or define('YII_ENV', 'test');
 8 | require(__DIR__ . '/../../vendor/autoload.php');
 9 | require(__DIR__ . '/../../vendor/yiisoft/yii2/Yii.php');
10 | $config = require(__DIR__ . '/../tests/config/config-local.php');
11 | (new yii\web\Application($config))->run();


--------------------------------------------------------------------------------