Skip to content

Commit ebc6609

Browse files
NaktibaldaNaktibalda
committed
Updated docs and changelog
1 parent 6ff8b03 commit ebc6609

File tree

13 files changed

+87
-35
lines changed

13 files changed

+87
-35
lines changed

‎changelog.markdown

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ title: Codeception Changelog
88
# Changelog
99

1010

11+
#### 4.1.6
12+
13+
* Compatibility with PHPUnit 9.2
14+
1115
#### 4.1.5
1216

1317
* Fixed docker images

‎docs/modules/Laravel5.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1234,6 +1234,8 @@ Sets SERVER parameter valid for all next requests.
12341234
$I->haveServerParameter('name', 'value');
12351235

12361236
{% endhighlight %}
1237+
* `param` $name
1238+
* `param` $value
12371239

12381240

12391241
#### haveSingleton
@@ -2020,6 +2022,7 @@ this will remove old ones.
20202022
$I->setServerParameters([]);
20212023

20222024
{% endhighlight %}
2025+
* `param array` $params
20232026

20242027

20252028
#### submitForm

‎docs/modules/Lumen.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1007,6 +1007,8 @@ Sets SERVER parameter valid for all next requests.
10071007
$I->haveServerParameter('name', 'value');
10081008

10091009
{% endhighlight %}
1010+
* `param` $name
1011+
* `param` $value
10101012

10111013

10121014
#### haveSingleton
@@ -1629,6 +1631,7 @@ this will remove old ones.
16291631
$I->setServerParameters([]);
16301632

16311633
{% endhighlight %}
1634+
* `param array` $params
16321635

16331636

16341637
#### submitForm

‎docs/modules/Mezzio.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -739,6 +739,8 @@ Sets SERVER parameter valid for all next requests.
739739
$I->haveServerParameter('name', 'value');
740740

741741
{% endhighlight %}
742+
* `param` $name
743+
* `param` $value
742744

743745

744746
#### makeHtmlSnapshot
@@ -1270,6 +1272,7 @@ this will remove old ones.
12701272
$I->setServerParameters([]);
12711273

12721274
{% endhighlight %}
1275+
* `param array` $params
12731276

12741277

12751278
#### submitForm

‎docs/modules/Phalcon.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -903,6 +903,8 @@ Sets SERVER parameter valid for all next requests.
903903
$I->haveServerParameter('name', 'value');
904904

905905
{% endhighlight %}
906+
* `param` $name
907+
* `param` $value
906908

907909

908910
#### makeHtmlSnapshot
@@ -1518,6 +1520,7 @@ this will remove old ones.
15181520
$I->setServerParameters([]);
15191521

15201522
{% endhighlight %}
1523+
* `param array` $params
15211524

15221525

15231526
#### submitForm

‎docs/modules/Phalcon4.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -899,6 +899,8 @@ Sets SERVER parameter valid for all next requests.
899899
$I->haveServerParameter('name', 'value');
900900

901901
{% endhighlight %}
902+
* `param` $name
903+
* `param` $value
902904

903905

904906
#### makeHtmlSnapshot
@@ -1514,6 +1516,7 @@ this will remove old ones.
15141516
$I->setServerParameters([]);
15151517

15161518
{% endhighlight %}
1519+
* `param array` $params
15171520

15181521

15191522
#### submitForm

‎docs/modules/PhpBrowser.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -666,7 +666,7 @@ $I->executeInGuzzle(function (\GuzzleHttp\Client $client) {
666666
It is not recommended to use this command on a regular basis.
667667
If Codeception lacks important Guzzle Client methods, implement them and submit patches.
668668

669-
* `param callable` $function
669+
* `param Closure` $function
670670

671671

672672
#### fillField
@@ -840,6 +840,8 @@ Sets SERVER parameter valid for all next requests.
840840
$I->haveServerParameter('name', 'value');
841841

842842
{% endhighlight %}
843+
* `param` $name
844+
* `param` $value
843845

844846

845847
#### makeHtmlSnapshot
@@ -1379,6 +1381,7 @@ this will remove old ones.
13791381
$I->setServerParameters([]);
13801382

13811383
{% endhighlight %}
1384+
* `param array` $params
13821385

13831386

13841387
#### submitForm

‎docs/modules/REST.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,22 @@ Otherwise, a PHPBrowser should be specified as a dependency to send requests and
4545

4646
This module requires PHPBrowser or any of Framework modules enabled.
4747

48+
In case you need to configure low-level HTTP fields, that's done on the PHPBrowser level.
49+
Check the example below for details.
50+
4851
#### Example
4952

5053
modules:
5154
enabled:
5255
- REST:
5356
depends: PhpBrowser
54-
url: 'http://serviceapp/api/v1/'
57+
url: &url 'http://serviceapp/api/v1/' # you only need the &url anchor for further PhpBrowser configs
5558
shortDebugResponse: 300 # only the first 300 chars of the response
59+
config:
60+
PhpBrowser:
61+
url: *url # repeats the URL from the REST module; not needed if you don't have further settings like below
62+
headers:
63+
Content-Type: application/json
5664

5765
### Public Properties
5866

@@ -745,9 +753,9 @@ $I->seeResponseJsonMatchesXpath('/store//price');
745753

746754
#### seeResponseMatchesJsonType
747755

748-
Checks that Json matches provided types.
756+
Checks that JSON matches provided types.
749757
In case you don't know the actual values of JSON data returned you can match them by type.
750-
Starts check with a root element. If JSON data is array it will check the first element of an array.
758+
It starts the check with a root element. If JSON data is an array it will check all elements of it.
751759
You can specify the path in the json which should be checked with JsonPath
752760

753761
Basic example:
@@ -769,16 +777,17 @@ $I->seeResponseMatchesJsonType(['name' => 'string'], '$.users[0]');
769777

770778
{% endhighlight %}
771779

772-
In this case you can match that record contains fields with data types you expected.
780+
You can check if the record contains fields with the data types you expect.
773781
The list of possible data types:
774782

775783
* string
776784
* integer
777785
* float
778786
* array (json object is array as well)
779787
* boolean
788+
* null
780789

781-
You can also use nested data type structures:
790+
You can also use nested data type structures, and define multiple types for the same field:
782791

783792
{% highlight php %}
784793

@@ -792,7 +801,8 @@ $I->seeResponseMatchesJsonType([
792801

793802
{% endhighlight %}
794803

795-
You can also apply filters to check values. Filter can be applied with `:` char after the type declaration.
804+
You can also apply filters to check values. Filter can be applied with a `:` char after the type declaration,
805+
or after another filter if you need more than one.
796806

797807
Here is the list of possible filters:
798808

@@ -817,17 +827,18 @@ $I->seeResponseMatchesJsonType([
817827
// {'user_id': '1'}
818828
$I->seeResponseMatchesJsonType([
819829
'user_id' => 'string:>0', // works with strings as well
820-
}
830+
]);
821831
?>
822832

823833
{% endhighlight %}
824834

825-
You can also add custom filters y accessing `JsonType::addCustomFilter` method.
835+
You can also add custom filters by using `{@link JsonType::addCustomFilter()}`.
826836
See [JsonType reference](http://codeception.com/docs/reference/JsonType).
827837

828838
* `[Part]` json
829839
* `param array` $jsonType
830840
* `param string` $jsonPath
841+
@see JsonType
831842
* `Available since` 2.1.3
832843

833844

‎docs/modules/Symfony.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -853,6 +853,8 @@ Sets SERVER parameter valid for all next requests.
853853
$I->haveServerParameter('name', 'value');
854854

855855
{% endhighlight %}
856+
* `param` $name
857+
* `param` $value
856858

857859

858860
#### invalidateCachedRouter
@@ -1498,6 +1500,7 @@ this will remove old ones.
14981500
$I->setServerParameters([]);
14991501

15001502
{% endhighlight %}
1503+
* `param array` $params
15011504

15021505

15031506
#### submitForm

‎docs/modules/Yii2.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1122,6 +1122,8 @@ Sets SERVER parameter valid for all next requests.
11221122
$I->haveServerParameter('name', 'value');
11231123

11241124
{% endhighlight %}
1125+
* `param` $name
1126+
* `param` $value
11251127

11261128

11271129
#### makeHtmlSnapshot
@@ -1677,6 +1679,7 @@ this will remove old ones.
16771679
$I->setServerParameters([]);
16781680

16791681
{% endhighlight %}
1682+
* `param array` $params
16801683

16811684

16821685
#### submitForm

0 commit comments

Comments
 (0)