auto updated documentation

DavertMik · DavertMik · commit c108fa5e334e · 2018-04-01T01:32:39.000+03:00
diff --git a/changelog.markdown b/changelog.markdown
@@ -7,6 +7,25 @@ title: Codeception Changelog
 
 # Changelog
 
+#### 2.4.1
+
+* Fixed `PHP Fatal error:  Uncaught Error: Call to undefined method Codeception\Test\Descriptor::getTestDataSetIndex()` when filtering tests
+* Better support of PHPUnit warning status by **[edno](https://github.com/edno)**:
+  * support PHPUnit addWarning()
+  * display 'W' instead of success for warning test cases
+* Fixed Running test with invalid dataprovider by **[okneloper](https://github.com/okneloper)**. Fixed  [#4888](https://github.com/Codeception/Codeception/issues/4888) by **[edno](https://github.com/edno)**
+* **[Yii2]** **Request flow and database transactions refactored** (by **[sammousa](https://github.com/sammousa)**):
+  * **Breaking** Application is no longer available in helpers via `$this->getModule('Yii2'')->app`, now you must use `\Yii::$app` everywhere
+  * Multiple databases are now supported
+  * More reliable application state before and during test execution
+  * Fixtures method is now configurable
+  * Subset of misconfigurations are now detected and informative messages created
+* Fixed using `$settings['path']` in `Codeception\Configuration::suiteSettings()` on Windows by **[olegpro](https://github.com/olegpro)** 
+* **[Laravel5]** Added Laravel 5.4+ (5.1+ backward compatible) support for `callArtisan` method in Laravel5 module. See [#4860](https://github.com/Codeception/Codeception/issues/4860) by **[mohamed-aiman](https://github.com/mohamed-aiman)** 
+* Fixed [#4854](https://github.com/Codeception/Codeception/issues/4854): unnecessary escaping in operation arguments logging by **[nicholascus](https://github.com/nicholascus)**
+* Fixed humanizing steps for utf8 strings by **[nicholascus](https://github.com/nicholascus)**. See [#4850](https://github.com/Codeception/Codeception/issues/4850)
+* Fixed parsing relative urls in `parse_url`. See [#4853](https://github.com/Codeception/Codeception/issues/4853) by **[quantum-x](https://github.com/quantum-x)**
+
 #### 2.4.0
 
 * **PHPUnit 7.x compatibility**
@@ -23,7 +42,9 @@ title: Codeception Changelog
 **Upgrade Notice**: If you face issues with underscore PHPUnit class names (like PHPUnit_Framework_Assert) you have two options:
 
 * Lock version for PHPUnit in composer.json: "phpunit/phpunit":"^5.0.0"
-* Update your codebase and replace underscore PHPUnit class names to namespaced (PHPUnit 6+ API) #### 2.3.9
+* Update your codebase and replace underscore PHPUnit class names to namespaced (PHPUnit 6+ API)
+
+#### 2.3.9
 
 * Added `Codeception\Step\Argument\PasswordArgument` to pass sensitive data into tests:
 
diff --git a/docs/07-AdvancedUsage.md b/docs/07-AdvancedUsage.md
@@ -72,19 +72,19 @@ class BasicCest
 
 {% endhighlight %}
 
-As you see, Cest classes have no parents. 
+As you see, Cest classes have no parents.
 This is done intentionally. It allows you to extend your classes with common behaviors and workarounds
 that may be used in child classes. But don't forget to make these methods `protected` so they won't be executed as tests.
 
-Cest format also can contain hooks based on test results: 
+Cest format also can contain hooks based on test results:
 
 * `_failed` will be executed on failed test
 * `_passed` will be executed on passed test
 
 {% highlight php %}
 
 <?php
-public function _failed(\AcceptanceTester $I) 
+public function _failed(\AcceptanceTester $I)
 {
     // will be executed on test failure
 }
@@ -201,7 +201,7 @@ Moreover, Codeception can resolve dependencies recursively (when `A` depends on
 and handle parameters of primitive types with default values (like `$param = 'default'`).
 Of course, you are not allowed to have *cyclic dependencies*.
 
-### Examples
+## Example Annotation
 
 What if you want to execute the same test scenario with different data? In this case you can inject examples
 as `\Codeception\Example` instances.
@@ -210,6 +210,8 @@ Data is defined via the `@example` annotation, using JSON or Doctrine-style nota
 {% highlight php %}
 
 <?php
+class EndpointCest
+{
  /**
   * @example ["/api/", 200]
   * @example ["/api/protected", 401]
@@ -221,6 +223,7 @@ Data is defined via the `@example` annotation, using JSON or Doctrine-style nota
     $I->sendGET($example[0]);
     $I->seeResponseCodeIs($example[1]);
   }
+}
 
 {% endhighlight %}
 
@@ -229,6 +232,8 @@ JSON:
 {% highlight php %}
 
 <?php
+class PageCest
+{
  /**
   * @example { "url": "/", "title": "Welcome" }
   * @example { "url": "/info", "title": "Info" }
@@ -241,6 +246,7 @@ JSON:
     $I->see($example['title'], 'h1');
     $I->seeInTitle($example['title']);
   }
+}
 
 {% endhighlight %}
 
@@ -254,6 +260,8 @@ Key-value data in Doctrine-style annotation syntax:
 {% highlight php %}
 
 <?php
+class PageCest
+{
  /**
   * @example(url="/", title="Welcome")
   * @example(url="/info", title="Info")
@@ -266,16 +274,21 @@ Key-value data in Doctrine-style annotation syntax:
     $I->see($example['title'], 'h1');
     $I->seeInTitle($example['title']);
   }
+}
 
 {% endhighlight %}
 
-You can also use the `@dataprovider` annotation for creating dynamic examples, using a protected method for providing example data:
+## DataProvider Annotations
+
+You can also use the `@dataProvider` annotation for creating dynamic examples for [Cest classes](#Cest-Classes), using a **protected method** for providing example data:
 
 {% highlight php %}
 
 <?php
+class PageCest
+{
    /**
-    * @dataprovider pageProvider
+    * @dataProvider pageProvider
     */
     public function staticPages(AcceptanceTester $I, \Codeception\Example $example)
     {
@@ -296,10 +309,14 @@ You can also use the `@dataprovider` annotation for creating dynamic examples, u
             ['url'=>"/contact", 'title'=>"Contact Us"]
         ];
     }
+}
 
 {% endhighlight %}
 
-### Before/After Annotations
+`@dataprovider` annotation is also available for [unit tests](https://codeception.com/docs/05-UnitTests), in this case the data provider **method must be public**.
+For more details about how to use data provider for unit tests, please refer to [PHPUnit documentation](https://phpunit.de/manual/current/en/writing-tests-for-phpunit.html#writing-tests-for-phpunit.data-providers).
+
+## Before/After Annotations
 
 You can control execution flow with `@before` and `@after` annotations. You may move common actions
 into protected (non-test) methods and invoke them before or after the test method by putting them into annotations.
diff --git a/docs/modules/Laravel5.md b/docs/modules/Laravel5.md
@@ -334,12 +334,14 @@ Call an Artisan command.
 <?php
 $I->callArtisan('command:name');
 $I->callArtisan('command:name', ['parameter' => 'value']);
-?>
 
 {% endhighlight %}
+Use 3rd parameter to pass in custom `OutputInterface`
 
  * `param string` $command
  * `param array` $parameters
+ * `param OutputInterface` $output
+ * `return` string
 
 
 #### checkOption
diff --git a/docs/modules/Yii2.md b/docs/modules/Yii2.md
@@ -12,6 +12,13 @@ title: Yii2 - Codeception - Documentation
 
 This module provides integration with [Yii framework](http://www.yiiframework.com/) (2.0).
 It initializes Yii framework in test environment and provides actions for functional testing.
+### Application state during testing
+This section details what you can expect when using this module.
+* You will get a fresh application in `\Yii::$app` at the start of each test (available in the test and in `_before()`).
+* When executing a request via one of the request functions the `request` and `response` component are both recreated.
+* After a request the whole application is available for inspection / interaction.
+* You may use multiple database connections, each will use a separate transaction; to prevent accidental mistakes we
+will warn you if you try to connect to the same database twice but we cannot reuse the same connection.
 
 ### Config
 
@@ -20,6 +27,8 @@ It initializes Yii framework in test environment and provides actions for functi
 * `entryScript` - front script title (like: index-test.php). If not set - taken from entryUrl.
 * `transaction` - (default: true) wrap all database connection inside a transaction and roll it back after the test. Should be disabled for acceptance testing..
 * `cleanup` - (default: true) cleanup fixtures after the test
+* `ignoreCollidingDSN` - (default: false) When 2 database connections use the same DSN but different settings an exception will be thrown, set this to true to disable this behavior.
+* `fixturesMethod` - (default: _fixtures) Name of the method used for creating fixtures.
 
 You can use this module by setting params in your functional.suite.yml:
 
@@ -132,6 +141,7 @@ $I->sendAjaxPostRequest(['/user/update', 'id' => 1], ['UserForm[name]' => 'G.Hop
 Maintainer: **samdark**
 Stability: **stable**
 
+@property \Codeception\Lib\Connector\Yii2 $client
 
 ### Actions
 
