updated

Author: github-actions[bot]

docs/modules/Doctrine2.md renamed to docs/modules/Doctrine.md

@@ -1,17 +1,17 @@
 ---
 layout: doc
-title: Doctrine2 - Codeception - Documentation
+title: Doctrine - Codeception - Documentation
 ---
 
 
 
-<div class="btn-group" role="group" style="float: right" aria-label="..."><a class="btn btn-default" href="https://github.com/Codeception/module-Doctrine2/releases">Releases</a><a class="btn btn-default" href="https://github.com/Codeception/module-doctrine2/tree/master/src/Codeception/Module/Doctrine2.php"><strong>source</strong></a></div>
+<div class="btn-group" role="group" style="float: right" aria-label="..."><a class="btn btn-default" href="https://github.com/Codeception/module-Doctrine/releases">Releases</a><a class="btn btn-default" href="https://github.com/Codeception/module-doctrine/tree/master/src/Codeception/Module/Doctrine.php"><strong>source</strong></a></div>
 
-# Doctrine2
+# Doctrine
 ### Installation
 
 {% highlight yaml %}
-composer require --dev codeception/module-doctrine2
+composer require --dev codeception/module-doctrine
 
 {% endhighlight %}
 
@@ -29,7 +29,7 @@ Set up your `functional.suite.yml` like this:
 modules:
     enabled:
         - Symfony # 'ZF2' or 'Symfony'
-        - Doctrine2:
+        - Doctrine:
             depends: Symfony # Tells Doctrine to fetch the Entity Manager through Symfony
             cleanup: true # All doctrine queries will be wrapped in a transaction, which will be rolled back at the end of each test
 
@@ -41,7 +41,7 @@ If you don't provide a `depends` key, you need to specify a callback function to
 
 modules:
     enabled:
-        - Doctrine2:
+        - Doctrine:
             connection_callback: ['MyDb', 'createEntityManager'] # Call the static method `MyDb::createEntityManager()` to get the Entity Manager
 
 {% endhighlight %}
@@ -50,15 +50,15 @@ By default, the module will wrap everything into a transaction for each test and
 (this is controlled by the `cleanup` setting).
 By doing this, tests will run much faster and will be isolated from each other.
 
-To use the Doctrine2 Module in acceptance tests, set up your `acceptance.suite.yml` like this:
+To use the Doctrine Module in acceptance tests, set up your `acceptance.suite.yml` like this:
 
 {% highlight yaml %}
 
 modules:
     enabled:
         - Symfony:
             part: SERVICES
-        - Doctrine2:
+        - Doctrine:
             depends: Symfony
 
 {% endhighlight %}
@@ -72,7 +72,7 @@ are using to purge the database tables:
 
 modules:
     enabled:
-        - Doctrine2:
+        - Doctrine:
             purge_mode: 1 # 1: DELETE (=default), 2: TRUNCATE
 
 {% endhighlight %}
@@ -427,4 +427,4 @@ $I->seeInRepository(Client::class, ['User' => ['Company' => ['name' => 'Codegyre
 
 Fails if record for given criteria can\'t be found,
 
-<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/module-doctrine2/tree/master/src/Codeception/Module/Doctrine2.php">Help us to improve documentation. Edit module reference</a></div>
+<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/module-doctrine/tree/master/src/Codeception/Module/Doctrine.php">Help us to improve documentation. Edit module reference</a></div>

docs/modules/Laminas.md

@@ -736,7 +736,7 @@ $aLinks = $I->grabMultiple('a', 'href');
 
 #### grabPageSource
 
-* `throws ModuleException` if no page was opened.
+* `throws \Codeception\Exception\ModuleException` if no page was opened.
 * `return string` Current page source code.
 
 Grabs current page source code.

docs/modules/Laravel.md

@@ -1157,7 +1157,7 @@ $I->grabNumRecords('App\Models\User', ['name' => 'Davert']);
 
 #### grabPageSource
 
-* `throws ModuleException` if no page was opened.
+* `throws \Codeception\Exception\ModuleException` if no page was opened.
 * `return string` Current page source code.
 
 Grabs current page source code.

docs/modules/Lumen.md

@@ -772,7 +772,7 @@ $aLinks = $I->grabMultiple('a', 'href');
 
 #### grabPageSource
 
-* `throws ModuleException` if no page was opened.
+* `throws \Codeception\Exception\ModuleException` if no page was opened.
 * `return string` Current page source code.
 
 Grabs current page source code.

docs/modules/Mezzio.md

@@ -682,7 +682,7 @@ $aLinks = $I->grabMultiple('a', 'href');
 
 #### grabPageSource
 
-* `throws ModuleException` if no page was opened.
+* `throws \Codeception\Exception\ModuleException` if no page was opened.
 * `return string` Current page source code.
 
 Grabs current page source code.

docs/modules/PhpBrowser.md

@@ -786,7 +786,7 @@ $aLinks = $I->grabMultiple('a', 'href');
 
 #### grabPageSource
 
-* `throws ModuleException` if no page was opened.
+* `throws \Codeception\Exception\ModuleException` if no page was opened.
 * `return string` Current page source code.
 
 Grabs current page source code.

docs/modules/Symfony.md

@@ -23,7 +23,7 @@ This module uses [Symfony's DomCrawler](https://symfony.com/doc/current/componen
 and [HttpKernel Component](https://symfony.com/doc/current/components/http_kernel.html) to emulate requests and test response.
 
 * Access Symfony services through the dependency injection container: [`$I->grabService(...)`](#grabService)
-* Use Doctrine to test against the database: `$I->seeInRepository(...)` - see [Doctrine Module](https://codeception.com/docs/modules/Doctrine2)
+* Use Doctrine to test against the database: `$I->seeInRepository(...)` - see [Doctrine Module](https://codeception.com/docs/modules/Doctrine)
 * Assert that emails would have been sent: [`$I->seeEmailIsSent()`](#seeEmailIsSent)
 * Tests are wrapped into Doctrine transaction to speed them up.
 * Symfony Router can be cached between requests to speed up testing.
@@ -34,19 +34,19 @@ and [HttpKernel Component](https://symfony.com/doc/current/components/http_kerne
 
 ### Config
 
-#### Symfony 5.x or 4.4
+#### Symfony 5.4 or higher
 
-* app_path: 'src' - Specify custom path to your app dir, where the kernel interface is located.
-* environment: 'local' - Environment used for load kernel
-* kernel_class: 'App\Kernel' - Kernel class name
-* em_service: 'doctrine.orm.entity_manager' - Use the stated EntityManager to pair with Doctrine Module.
-* debug: true - Turn on/off debug mode
-* cache_router: 'false' - Enable router caching between tests in order to [increase performance](http://lakion.com/blog/how-did-we-speed-up-sylius-behat-suite-with-blackfire)
-* rebootable_client: 'true' - Reboot client's kernel before each request
-* guard: 'false' - Enable custom authentication system with guard (only for 4.x and 5.x versions of the symfony)
-* authenticator: 'false' - Reboot client's kernel before each request (only for 6.x versions of the symfony)
+* `app_path`: 'src' - Specify custom path to your app dir, where the kernel interface is located.
+* `environment`: 'local' - Environment used for load kernel
+* `kernel_class`: 'App\Kernel' - Kernel class name
+* `em_service`: 'doctrine.orm.entity_manager' - Use the stated EntityManager to pair with Doctrine Module.
+* `debug`: true - Turn on/off [debug mode](https://codeception.com/docs/Debugging)
+* `cache_router`: 'false' - Enable router caching between tests in order to [increase performance](http://lakion.com/blog/how-did-we-speed-up-sylius-behat-suite-with-blackfire)
+* `rebootable_client`: 'true' - Reboot client's kernel before each request
+* `guard`: 'false' - Enable custom authentication system with guard (only for Symfony 5.4)
+* `authenticator`: 'false' - Reboot client's kernel before each request (only for Symfony 6.0 or higher)
 
-##### Example (`functional.suite.yml`) - Symfony 4 Directory Structure
+##### Sample `Functional.suite.yml`
 
     modules:
        enabled:
@@ -80,15 +80,15 @@ modules:
     enabled:
         - Symfony:
             part: services
-        - Doctrine2:
+        - Doctrine:
             depends: Symfony
         - WebDriver:
             url: http://example.com
             browser: firefox
 
 {% endhighlight %}
 
-If you're using Symfony with Eloquent ORM (instead of Doctrine), you can load the [`ORM` part of Laravel module](https://codeception.com/docs/modules/Laravel5#Parts)
+If you're using Symfony with Eloquent ORM (instead of Doctrine), you can load the [`ORM` part of Laravel module](https://codeception.com/docs/modules/Laravel#Parts)
 in addition to Symfony module.
 
 
@@ -726,8 +726,7 @@ $I->dontSeeElement('input', ['value' => '123456']);
 Checks that no email was sent.
 
 The check is based on `\Symfony\Component\Mailer\EventListener\MessageLoggerListener`, which means:
-If your app performs a HTTP redirect, you need to suppress it using [stopFollowingRedirects()](https://codeception.com/docs/modules/Symfony#stopFollowingRedirects) first; otherwise this check will *always* pass.
-Starting with version 2.0.0, `codeception/module-symfony` requires your app to use [Symfony Mailer](https://symfony.com/doc/current/mailer.html). If your app still uses [Swift Mailer](https://symfony.com/doc/current/email.html), set your version constraint to `^1.6`.
+If your app performs an HTTP redirect, you need to suppress it using [stopFollowingRedirects()](https://codeception.com/docs/modules/Symfony#stopFollowingRedirects) first; otherwise this check will *always* pass.
 
 
 #### dontSeeEvent
@@ -1126,8 +1125,7 @@ $uri = $I->grabFromCurrentUrl();
 Returns the last sent email.
 
 The function is based on `\Symfony\Component\Mailer\EventListener\MessageLoggerListener`, which means:
-If your app performs a HTTP redirect after sending the email, you need to suppress it using [stopFollowingRedirects()](https://codeception.com/docs/modules/Symfony#stopFollowingRedirects) first.
-Starting with version 2.0.0, `codeception/module-symfony` requires your app to use [Symfony Mailer](https://symfony.com/doc/current/mailer.html). If your app still uses [Swift Mailer](https://symfony.com/doc/current/email.html), set your version constraint to `^1.6`.
+If your app performs an HTTP redirect after sending the email, you need to suppress it using [stopFollowingRedirects()](https://codeception.com/docs/modules/Symfony#stopFollowingRedirects) first.
 See also: [grabSentEmails()](https://codeception.com/docs/modules/Symfony#grabSentEmails)
 
 {% highlight php %}
@@ -1188,7 +1186,7 @@ $I->grabNumRecords('User::class', ['name' => 'davert']);
 
 #### grabPageSource
 
-* `throws ModuleException` if no page was opened.
+* `throws \Codeception\Exception\ModuleException` if no page was opened.
 * `return string` Current page source code.
 
 Grabs current page source code.
@@ -1197,7 +1195,7 @@ Grabs current page source code.
 #### grabParameter
 
 * `param string` $parameterName
-* `return array|bool|float|int|string|null`
+* `return \UnitEnum|array|string|int|float|bool|null`
 
 Grabs a Symfony parameter
 
@@ -1236,8 +1234,7 @@ $I->grabRepository(UserRepositoryInterface::class);
 Returns an array of all sent emails.
 
 The function is based on `\Symfony\Component\Mailer\EventListener\MessageLoggerListener`, which means:
-If your app performs a HTTP redirect after sending the email, you need to suppress it using [stopFollowingRedirects()](https://codeception.com/docs/modules/Symfony#stopFollowingRedirects) first.
-Starting with version 2.0.0, `codeception/module-symfony` requires your app to use [Symfony Mailer](https://symfony.com/doc/current/mailer.html). If your app still uses [Swift Mailer](https://symfony.com/doc/current/email.html), set your version constraint to `^1.6`.
+If your app performs an HTTP redirect after sending the email, you need to suppress it using [stopFollowingRedirects()](https://codeception.com/docs/modules/Symfony#stopFollowingRedirects) first.
 See also: [grabLastSentEmail()](https://codeception.com/docs/modules/Symfony#grabLastSentEmail)
 
 {% highlight php %}
@@ -1690,8 +1687,7 @@ $I->seeElement(['css' => 'form input'], ['name' => 'login']);
 Checks if the given number of emails was sent (default `$expectedCount`: 1).
 
 The check is based on `\Symfony\Component\Mailer\EventListener\MessageLoggerListener`, which means:
-If your app performs a HTTP redirect after sending the email, you need to suppress it using [stopFollowingRedirects()](https://codeception.com/docs/modules/Symfony#stopFollowingRedirects) first.
-Starting with version 2.0.0, `codeception/module-symfony` requires your app to use [Symfony Mailer](https://symfony.com/doc/current/mailer.html). If your app still uses [Swift Mailer](https://symfony.com/doc/current/email.html), set your version constraint to `^1.6`.
+If your app performs an HTTP redirect after sending the email, you need to suppress it using [stopFollowingRedirects()](https://codeception.com/docs/modules/Symfony#stopFollowingRedirects) first.
 
 {% highlight php %}
 
@@ -2117,7 +2113,7 @@ $I->seeOrphanEvent(['App\MyEvent', 'App\MyOtherEvent']);
 
 Verifies that a page is available.
 
-By default it checks the current page, specify the `$url` parameter to change it.
+By default, it checks the current page, specify the `$url` parameter to change it.
 
 {% highlight php %}
 
@@ -2192,7 +2188,7 @@ $I->seeRenderedTemplate('layout.html.twig');
 
 Asserts that the time a request lasted is less than expected.
 
-If the page performed a HTTP redirect, only the time of the last request will be taken into account.
+If the page performed an HTTP redirect, only the time of the last request will be taken into account.
 You can modify this behavior using [stopFollowingRedirects()](https://codeception.com/docs/modules/Symfony#stopFollowingRedirects) first.
 
 Also, note that using code coverage can significantly increase the time it takes to resolve a request,

docs/modules/WebDriver.md

@@ -60,8 +60,8 @@ modules:
          url: 'http://localhost/'
          browser: chrome
          capabilities:
-            chromeOptions:
-               args: ["--headless", "--disable-gpu"]
+            goog:chromeOptions:
+               args: ["--headless"]
 
 {% endhighlight %}
 
@@ -98,8 +98,8 @@ modules:
          window_size: 2000x1000
          port: 9515
          capabilities:
-             chromeOptions:
-                 args: ["--headless", "--disable-gpu"] # Run Chrome in headless mode
+             goog:chromeOptions:
+                 args: ["--headless"] # Run Chrome in headless mode
                  prefs:
                      download.default_directory: "..."
 
@@ -143,7 +143,7 @@ you should use a tunnel application provided by a service.
 
 1. Create an account at [SauceLabs.com](https://saucelabs.com/) to get your username and access key
 2. In the module configuration use the format `username`:`access_key`@ondemand.saucelabs.com' for `host`
-3. Configure `platform` under `capabilities` to define the [Operating System](https://docs.saucelabs.com/basics/platform-configurator/)
+3. Configure `platformName` under `capabilities` to define the [Operating System](https://docs.saucelabs.com/basics/platform-configurator/)
 4. run a tunnel app if your site can't be accessed from Internet
 
 {% highlight yaml %}
@@ -156,7 +156,7 @@ you should use a tunnel application provided by a service.
              port: 80
              browser: chrome
              capabilities:
-                 platform: 'Windows 10'
+                 platformName: 'Windows 10'
 
 {% endhighlight %}
 
@@ -177,9 +177,10 @@ you should use a tunnel application provided by a service.
              port: 80
              browser: chrome
              capabilities:
-                 os: Windows
-                 os_version: 10
-                 browserstack.local: true # for local testing
+                 bstack:options:
+                     os: Windows
+                     osVersion: 10
+                     local: true # for local testing
 
 {% endhighlight %}
 
@@ -212,7 +213,7 @@ you should use a tunnel application provided by a service.
 
 1. Create an account at [TestingBot](https://testingbot.com/) to get your key and secret
 2. In the module configuration use the format `key`:`secret`@hub.testingbot.com' for `host`
-3. Configure `platform` under `capabilities` to define the [Operating System](https://testingbot.com/support/getting-started/browsers.html)
+3. Configure `platformName` under `capabilities` to define the [Operating System](https://testingbot.com/support/getting-started/browsers.html)
 4. Run [TestingBot Tunnel](https://testingbot.com/support/other/tunnel) if your site can't be accessed from Internet
 
 {% highlight yaml %}
@@ -225,7 +226,7 @@ you should use a tunnel application provided by a service.
              port: 80
              browser: chrome
              capabilities:
-                 platform: Windows 10
+                 platformName: Windows 10
 
 {% endhighlight %}
 
@@ -264,8 +265,9 @@ Example (`acceptance.suite.yml`)
              browser: firefox
              window_size: 1024x768
              capabilities:
-                 unexpectedAlertBehaviour: 'accept'
-                 firefox_profile: '~/firefox-profiles/codeception-profile.zip.b64'
+                 unhandledPromptBehaviour: 'accept'
+                 moz:firefoxOptions:
+                     profile: '~/firefox-profiles/codeception-profile.zip.b64'
 
 {% endhighlight %}
 
@@ -1596,12 +1598,12 @@ For special keys, use the constants from [`Facebook\WebDriver\WebDriverKeys`](ht
 {% highlight php %}
 
 <?php
-// <input id="page" value="old" />
-$I->pressKey('#page','a'); // => olda
-$I->pressKey('#page',array('ctrl','a'),'new'); //=> new
-$I->pressKey('#page',array('shift','111'),'1','x'); //=> old!!!1x
+// <input id="page" value="old">
+$I->pressKey('#page', 'a'); // => olda
+$I->pressKey('#page', ['ctrl', 'a'],'new'); //=> new
+$I->pressKey('#page', ['shift', '111'],'1','x'); //=> old!!!1x
 $I->pressKey('descendant-or-self::*[@id='page']','u'); //=> oldu
-$I->pressKey('#name', array('ctrl', 'a'), \Facebook\WebDriver\WebDriverKeys::DELETE); //=>''
+$I->pressKey('#name', ['ctrl', 'a'], \Facebook\WebDriver\WebDriverKeys::DELETE); //=>''
 
 {% endhighlight %}
 
@@ -2183,17 +2185,17 @@ For example, given this sample "Sign Up" form:
 
 <form action="/sign_up">
     Login:
-    <input type="text" name="user[login]" /><br/>
+    <input type="text" name="user[login]"><br>
     Password:
-    <input type="password" name="user[password]" /><br/>
+    <input type="password" name="user[password]"><br>
     Do you agree to our terms?
-    <input type="checkbox" name="user[agree]" /><br/>
+    <input type="checkbox" name="user[agree]"><br>
     Select pricing plan:
     <select name="plan">
         <option value="1">Free</option>
         <option value="2" selected="selected">Paid</option>
     </select>
-    <input type="submit" name="submitButton" value="Submit" />
+    <input type="submit" name="submitButton" value="Submit">
 </form>
 
 {% endhighlight %}
@@ -2307,7 +2309,7 @@ For example, given the following HTML:
 
 {% highlight html %}
 
-<input type="submit" name="submitButton" value="Submit" />
+<input type="submit" name="submitButton" value="Submit">
 
 {% endhighlight %}
 

docs/modules/Yii2.md

@@ -962,7 +962,7 @@ $aLinks = $I->grabMultiple('a', 'href');
 
 #### grabPageSource
 
-* `throws ModuleException` if no page was opened.
+* `throws \Codeception\Exception\ModuleException` if no page was opened.
 * `return string` Current page source code.
 
 Grabs current page source code.