Updated docs and changelog

Naktibalda · Naktibalda · commit ebc660978b08 · 2020-07-05T19:04:49.000+03:00
diff --git a/changelog.markdown b/changelog.markdown
@@ -8,6 +8,10 @@ title: Codeception Changelog
 # Changelog
 
 
+#### 4.1.6
+
+* Compatibility with PHPUnit 9.2
+
 #### 4.1.5
 
 * Fixed docker images
diff --git a/docs/modules/Laravel5.md b/docs/modules/Laravel5.md
@@ -1234,6 +1234,8 @@ Sets SERVER parameter valid for all next requests.
 $I->haveServerParameter('name', 'value');
 
 {% endhighlight %}
+ * `param` $name
+ * `param` $value
 
 
 #### haveSingleton
@@ -2020,6 +2022,7 @@ this will remove old ones.
 $I->setServerParameters([]);
 
 {% endhighlight %}
+ * `param array` $params
 
 
 #### submitForm
diff --git a/docs/modules/Lumen.md b/docs/modules/Lumen.md
@@ -1007,6 +1007,8 @@ Sets SERVER parameter valid for all next requests.
 $I->haveServerParameter('name', 'value');
 
 {% endhighlight %}
+ * `param` $name
+ * `param` $value
 
 
 #### haveSingleton
@@ -1629,6 +1631,7 @@ this will remove old ones.
 $I->setServerParameters([]);
 
 {% endhighlight %}
+ * `param array` $params
 
 
 #### submitForm
diff --git a/docs/modules/Mezzio.md b/docs/modules/Mezzio.md
@@ -739,6 +739,8 @@ Sets SERVER parameter valid for all next requests.
 $I->haveServerParameter('name', 'value');
 
 {% endhighlight %}
+ * `param` $name
+ * `param` $value
 
 
 #### makeHtmlSnapshot
@@ -1270,6 +1272,7 @@ this will remove old ones.
 $I->setServerParameters([]);
 
 {% endhighlight %}
+ * `param array` $params
 
 
 #### submitForm
diff --git a/docs/modules/Phalcon.md b/docs/modules/Phalcon.md
@@ -903,6 +903,8 @@ Sets SERVER parameter valid for all next requests.
 $I->haveServerParameter('name', 'value');
 
 {% endhighlight %}
+ * `param` $name
+ * `param` $value
 
 
 #### makeHtmlSnapshot
@@ -1518,6 +1520,7 @@ this will remove old ones.
 $I->setServerParameters([]);
 
 {% endhighlight %}
+ * `param array` $params
 
 
 #### submitForm
diff --git a/docs/modules/Phalcon4.md b/docs/modules/Phalcon4.md
@@ -899,6 +899,8 @@ Sets SERVER parameter valid for all next requests.
 $I->haveServerParameter('name', 'value');
 
 {% endhighlight %}
+ * `param` $name
+ * `param` $value
 
 
 #### makeHtmlSnapshot
@@ -1514,6 +1516,7 @@ this will remove old ones.
 $I->setServerParameters([]);
 
 {% endhighlight %}
+ * `param array` $params
 
 
 #### submitForm
diff --git a/docs/modules/PhpBrowser.md b/docs/modules/PhpBrowser.md
@@ -666,7 +666,7 @@ $I->executeInGuzzle(function (\GuzzleHttp\Client $client) {
 It is not recommended to use this command on a regular basis.
 If Codeception lacks important Guzzle Client methods, implement them and submit patches.
 
- * `param callable` $function
+ * `param Closure` $function
 
 
 #### fillField
@@ -840,6 +840,8 @@ Sets SERVER parameter valid for all next requests.
 $I->haveServerParameter('name', 'value');
 
 {% endhighlight %}
+ * `param` $name
+ * `param` $value
 
 
 #### makeHtmlSnapshot
@@ -1379,6 +1381,7 @@ this will remove old ones.
 $I->setServerParameters([]);
 
 {% endhighlight %}
+ * `param array` $params
 
 
 #### submitForm
diff --git a/docs/modules/REST.md b/docs/modules/REST.md
@@ -45,14 +45,22 @@ Otherwise, a PHPBrowser should be specified as a dependency to send requests and
 
 This module requires PHPBrowser or any of Framework modules enabled.
 
+In case you need to configure low-level HTTP fields, that's done on the PHPBrowser level.
+Check the example below for details.
+
 #### Example
 
     modules:
        enabled:
            - REST:
                depends: PhpBrowser
-               url: 'http://serviceapp/api/v1/'
+               url: &url 'http://serviceapp/api/v1/' # you only need the &url anchor for further PhpBrowser configs
                shortDebugResponse: 300 # only the first 300 chars of the response
+       config:
+           PhpBrowser:
+               url: *url # repeats the URL from the REST module; not needed if you don't have further settings like below
+               headers:
+                   Content-Type: application/json
 
 ### Public Properties
 
@@ -745,9 +753,9 @@ $I->seeResponseJsonMatchesXpath('/store//price');
 
 #### seeResponseMatchesJsonType
  
-Checks that Json matches provided types.
+Checks that JSON matches provided types.
 In case you don't know the actual values of JSON data returned you can match them by type.
-Starts check with a root element. If JSON data is array it will check the first element of an array.
+It starts the check with a root element. If JSON data is an array it will check all elements of it.
 You can specify the path in the json which should be checked with JsonPath
 
 Basic example:
@@ -769,16 +777,17 @@ $I->seeResponseMatchesJsonType(['name' => 'string'], '$.users[0]');
 
 {% endhighlight %}
 
-In this case you can match that record contains fields with data types you expected.
+You can check if the record contains fields with the data types you expect.
 The list of possible data types:
 
 * string
 * integer
 * float
 * array (json object is array as well)
 * boolean
+* null
 
-You can also use nested data type structures:
+You can also use nested data type structures, and define multiple types for the same field:
 
 {% highlight php %}
 
@@ -792,7 +801,8 @@ $I->seeResponseMatchesJsonType([
 
 {% endhighlight %}
 
-You can also apply filters to check values. Filter can be applied with `:` char after the type declaration.
+You can also apply filters to check values. Filter can be applied with a `:` char after the type declaration,
+or after another filter if you need more than one.
 
 Here is the list of possible filters:
 
@@ -817,17 +827,18 @@ $I->seeResponseMatchesJsonType([
 // {'user_id': '1'}
 $I->seeResponseMatchesJsonType([
      'user_id' => 'string:>0', // works with strings as well
-}
+]);
 ?>
 
 {% endhighlight %}
 
-You can also add custom filters y accessing `JsonType::addCustomFilter` method.
+You can also add custom filters by using `{@link JsonType::addCustomFilter()}`.
 See [JsonType reference](http://codeception.com/docs/reference/JsonType).
 
  * `[Part]` json
  * `param array` $jsonType
  * `param string` $jsonPath
+@see JsonType
  * `Available since` 2.1.3
 
 
diff --git a/docs/modules/Symfony.md b/docs/modules/Symfony.md
@@ -853,6 +853,8 @@ Sets SERVER parameter valid for all next requests.
 $I->haveServerParameter('name', 'value');
 
 {% endhighlight %}
+ * `param` $name
+ * `param` $value
 
 
 #### invalidateCachedRouter
@@ -1498,6 +1500,7 @@ this will remove old ones.
 $I->setServerParameters([]);
 
 {% endhighlight %}
+ * `param array` $params
 
 
 #### submitForm
diff --git a/docs/modules/Yii2.md b/docs/modules/Yii2.md
@@ -1122,6 +1122,8 @@ Sets SERVER parameter valid for all next requests.
 $I->haveServerParameter('name', 'value');
 
 {% endhighlight %}
+ * `param` $name
+ * `param` $value
 
 
 #### makeHtmlSnapshot
@@ -1677,6 +1679,7 @@ this will remove old ones.
 $I->setServerParameters([]);
 
 {% endhighlight %}
+ * `param array` $params
 
 
 #### submitForm
diff --git a/docs/modules/ZF2.md b/docs/modules/ZF2.md
@@ -803,6 +803,8 @@ Sets SERVER parameter valid for all next requests.
 $I->haveServerParameter('name', 'value');
 
 {% endhighlight %}
+ * `param` $name
+ * `param` $value
 
 
 #### makeHtmlSnapshot
@@ -1351,6 +1353,7 @@ this will remove old ones.
 $I->setServerParameters([]);
 
 {% endhighlight %}
+ * `param array` $params
 
 
 #### submitForm
diff --git a/docs/reference/Mock.md b/docs/reference/Mock.md
@@ -43,11 +43,11 @@ $this->make('User', ['save' => function () { return true; }]);
 $this->make('User', ['save' => true]);
 
 {% endhighlight %}
-
- * `param mixed` $class - A class to be mocked
+@template RealInstanceType of object
+ * `param class-string<RealInstanceType>|RealInstanceType|callable(): class-string<RealInstanceType>` $class - A class to be mocked
  * `param array` $params - properties and methods to set
 
-@return object - mock
+@return \PHPUnit\Framework\MockObject\MockObject&RealInstanceType - mock
 @throws \RuntimeException when class does not exist
 @throws \Exception
 
@@ -85,11 +85,12 @@ $this->makeEmpty('User', ['save' => true));
 
 {% endhighlight %}
 
- * `param mixed` $class
+@template RealInstanceType of object
+ * `param class-string<RealInstanceType>|RealInstanceType|callable(): class-string<RealInstanceType>` $class - A class to be mocked
  * `param array` $params
  * `param bool|\PHPUnit\Framework\TestCase` $testCase
 
-@return object
+@return \PHPUnit\Framework\MockObject\MockObject&RealInstanceType
 @throws \Exception
 
 #### *public* makeEmptyExcept($class, $method, $params = null) 
@@ -128,11 +129,12 @@ $this->makeEmptyExcept('User', 'save', ['isValid' => true]);
 
 {% endhighlight %}
 
- * `param mixed` $class
+@template RealInstanceType of object
+ * `param class-string<RealInstanceType>|RealInstanceType|callable(): class-string<RealInstanceType>` $class - A class to be mocked
  * `param string` $method
  * `param array` $params
 
-@return object
+@return \PHPUnit\Framework\MockObject\MockObject&RealInstanceType
 @throws \Exception
 
 #### *public* construct($class, $constructorParams = null, $params = null) 
@@ -172,12 +174,13 @@ $this->construct('User', [], ['save' => true]);
 
 {% endhighlight %}
 
- * `param mixed` $class
+@template RealInstanceType of object
+ * `param class-string<RealInstanceType>|RealInstanceType|callable(): class-string<RealInstanceType>` $class - A class to be mocked
  * `param array` $constructorParams
  * `param array` $params
  * `param bool|\PHPUnit\Framework\TestCase` $testCase
 
-@return object
+@return \PHPUnit\Framework\MockObject\MockObject&RealInstanceType
 @throws \Exception
 
 #### *public* constructEmpty($class, $constructorParams = null, $params = null) 
@@ -225,11 +228,12 @@ $this->constructEmpty('User', [], [
 
 {% endhighlight %}
 
- * `param mixed` $class
+@template RealInstanceType of object
+ * `param class-string<RealInstanceType>|RealInstanceType|callable(): class-string<RealInstanceType>` $class - A class to be mocked
  * `param array` $constructorParams
  * `param array` $params
 
-@return object
+@return \PHPUnit\Framework\MockObject\MockObject&RealInstanceType
 
 #### *public* constructEmptyExcept($class, $method, $constructorParams = null, $params = null) 
 Instantiates a class instance by running constructor with all methods replaced with dummies, except one.
@@ -268,12 +272,13 @@ $this->constructEmptyExcept('User', 'save', [], ['save' => true]);
 
 {% endhighlight %}
 
- * `param mixed` $class
+@template RealInstanceType of object
+ * `param class-string<RealInstanceType>|RealInstanceType|callable(): class-string<RealInstanceType>` $class - A class to be mocked
  * `param string` $method
  * `param array` $constructorParams
  * `param array` $params
 
-@return object
+@return \PHPUnit\Framework\MockObject\MockObject&RealInstanceType
 
 
 
diff --git a/docs/reference/Stub.md b/docs/reference/Stub.md
