Skip to content

Commit b9c1d4b

Browse files
NaktibaldaNaktibalda
committed
Updated changelog and module documentation
1 parent 2510d73 commit b9c1d4b

12 files changed

Lines changed: 52 additions & 28 deletions

File tree

‎changelog.markdown‎

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

1010

11+
#### 4.1.15
12+
13+
* GroupManager: Show which group contains a missing file [#5938](https://github.com/Codeception/Codeception/issues/5938)
14+
* Ignore . namespace in generators when someone pass path as a class name, e.g. ./foo [#5818](https://github.com/Codeception/Codeception/issues/5818)
15+
* Removed "Running with seed" from CLI report ([#6088](https://github.com/Codeception/Codeception/issues/6088)) by **[eXorus](https://github.com/eXorus)**
16+
* Suggest most similar module in missing module exception [#6079](https://github.com/Codeception/Codeception/issues/6079) by **[c33s](https://github.com/c33s)**
17+
1118
#### 4.1.14
1219

1320
* Improved compatibility logic for Symfony EventDispatcher

‎docs/modules/Laminas.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -812,8 +812,7 @@ $I->haveServerParameter('name', 'value');
812812

813813
#### makeHtmlSnapshot
814814

815-
Saves current page's HTML into a temprary file.
816-
Use this method in debug mode within an interactive pause to get a source code of current page.
815+
Use this method within an [interactive pause](https://codeception.com/docs/02-GettingStarted#Interactive-Pause) to save the HTML source code of the current page.
817816

818817
{% highlight php %}
819818

‎docs/modules/Laravel.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1265,8 +1265,7 @@ $I->make('App\Models\User', [], 'admin');
12651265

12661266
#### makeHtmlSnapshot
12671267

1268-
Saves current page's HTML into a temprary file.
1269-
Use this method in debug mode within an interactive pause to get a source code of current page.
1268+
Use this method within an [interactive pause](https://codeception.com/docs/02-GettingStarted#Interactive-Pause) to save the HTML source code of the current page.
12701269

12711270
{% highlight php %}
12721271

‎docs/modules/Lumen.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1053,8 +1053,7 @@ $I->make('App\User', [], 'admin');
10531053

10541054
#### makeHtmlSnapshot
10551055

1056-
Saves current page's HTML into a temprary file.
1057-
Use this method in debug mode within an interactive pause to get a source code of current page.
1056+
Use this method within an [interactive pause](https://codeception.com/docs/02-GettingStarted#Interactive-Pause) to save the HTML source code of the current page.
10581057

10591058
{% highlight php %}
10601059

‎docs/modules/Mezzio.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -746,8 +746,7 @@ $I->haveServerParameter('name', 'value');
746746

747747
#### makeHtmlSnapshot
748748

749-
Saves current page's HTML into a temprary file.
750-
Use this method in debug mode within an interactive pause to get a source code of current page.
749+
Use this method within an [interactive pause](https://codeception.com/docs/02-GettingStarted#Interactive-Pause) to save the HTML source code of the current page.
751750

752751
{% highlight php %}
753752

‎docs/modules/Phalcon.md‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,9 @@ actions and avoid conflicts.
6969
* `orm` - include only `haveRecord/grabRecord/seeRecord/dontSeeRecord` actions.
7070
* `services` - allows to use `grabServiceFromContainer` and `addServiceToContainer`.
7171

72+
See [WebDriver module](https://codeception.com/docs/modules/WebDriver#Loading-Parts-from-other-Modules)
73+
for general information on how to load parts of a framework module.
74+
7275
Usage example:
7376

7477
Sample bootstrap (`app/config/bootstrap.php`):
@@ -805,7 +808,8 @@ Resolves the service based on its configuration from Phalcon's DI container
805808
Recommended to use for unit testing.
806809

807810
* `param string` $service Service name
808-
* `param array` $parameters Parameters [Optional]
811+
* `param array|null` $parameters Parameters [Optional]. Set it to null
812+
if you want service container to use parameters defined in the config of the container
809813
* `[Part]` services
810814

811815

@@ -910,8 +914,7 @@ $I->haveServerParameter('name', 'value');
910914

911915
#### makeHtmlSnapshot
912916

913-
Saves current page's HTML into a temprary file.
914-
Use this method in debug mode within an interactive pause to get a source code of current page.
917+
Use this method within an [interactive pause](https://codeception.com/docs/02-GettingStarted#Interactive-Pause) to save the HTML source code of the current page.
915918

916919
{% highlight php %}
917920

‎docs/modules/Phalcon4.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,10 @@ Sample bootstrap (`app/config/bootstrap.php`):
7272
{% highlight php %}
7373

7474
<?php
75+
$config = include __DIR__ . "/config.php";
76+
include __DIR__ . "/loader.php";
7577
$di = new \Phalcon\DI\FactoryDefault();
78+
include __DIR__ . "/services.php";
7679
return new \Phalcon\Mvc\Application($di);
7780
?>
7881

@@ -83,7 +86,7 @@ return new \Phalcon\Mvc\Application($di);
8386
actor: AcceptanceTester
8487
modules:
8588
enabled:
86-
- Phalcon4:
89+
- Phalcon:
8790
part: services
8891
bootstrap: 'app/config/bootstrap.php'
8992
cleanup: true
@@ -903,8 +906,7 @@ $I->haveServerParameter('name', 'value');
903906

904907
#### makeHtmlSnapshot
905908

906-
Saves current page's HTML into a temprary file.
907-
Use this method in debug mode within an interactive pause to get a source code of current page.
909+
Use this method within an [interactive pause](https://codeception.com/docs/02-GettingStarted#Interactive-Pause) to save the HTML source code of the current page.
908910

909911
{% highlight php %}
910912

‎docs/modules/PhpBrowser.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -847,8 +847,7 @@ $I->haveServerParameter('name', 'value');
847847

848848
#### makeHtmlSnapshot
849849

850-
Saves current page's HTML into a temprary file.
851-
Use this method in debug mode within an interactive pause to get a source code of current page.
850+
Use this method within an [interactive pause](https://codeception.com/docs/02-GettingStarted#Interactive-Pause) to save the HTML source code of the current page.
852851

853852
{% highlight php %}
854853

‎docs/modules/Symfony.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1019,8 +1019,7 @@ $I->logout();
10191019

10201020
#### makeHtmlSnapshot
10211021

1022-
Saves current page's HTML into a temprary file.
1023-
Use this method in debug mode within an interactive pause to get a source code of current page.
1022+
Use this method within an [interactive pause](https://codeception.com/docs/02-GettingStarted#Interactive-Pause) to save the HTML source code of the current page.
10241023

10251024
{% highlight php %}
10261025

‎docs/modules/WebDriver.md‎

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ you should use a tunnel application provided by a service.
197197

198198
### Configuration
199199

200-
* `url` *required* - Starting URL for your app.
200+
* `url` *required* - Base URL for your app (amOnPage opens URLs relative to this setting).
201201
* `browser` *required* - Browser to launch.
202202
* `host` - Selenium server host (127.0.0.1 by default).
203203
* `port` - Selenium server port (4444 by default).
@@ -212,6 +212,8 @@ you should use a tunnel application provided by a service.
212212
* `pageload_timeout` - amount of time to wait for a page load to complete before throwing an error (default 0 seconds).
213213
* `http_proxy` - sets http proxy server url for testing a remote server.
214214
* `http_proxy_port` - sets http proxy server port
215+
* `ssl_proxy` - sets ssl(https) proxy server url for testing a remote server.
216+
* `ssl_proxy_port` - sets ssl(https) proxy server port
215217
* `debug_log_entries` - how many selenium entries to print with `debugWebDriverLogs` or on fail (0 by default).
216218
* `log_js_errors` - Set to true to include possible JavaScript to HTML report, or set to false (default) to deactivate.
217219

@@ -324,7 +326,7 @@ Returns current WebDriver session for saving
324326
*hidden API method, expected to be used from Helper classes*
325327

326328
Change capabilities of WebDriver. Should be executed before starting a new browser session.
327-
This method expects a function to be passed which returns array or [WebDriver Desired Capabilities](https://github.com/php-webdriver/php-webdriver/blob/community/lib/Remote/DesiredCapabilities.php) object.
329+
This method expects a function to be passed which returns array or [WebDriver Desired Capabilities](https://github.com/php-webdriver/php-webdriver/blob/main/lib/Remote/DesiredCapabilities.php) object.
328330
Additional [Chrome options](https://github.com/php-webdriver/php-webdriver/wiki/ChromeOptions) (like adding extensions) can be passed as well.
329331

330332
{% highlight php %}
@@ -1298,10 +1300,27 @@ See [saveSessionSnapshot](#saveSessionSnapshot)
12981300
* `param` $name
12991301

13001302

1303+
#### makeElementScreenshot
1304+
1305+
Takes a screenshot of an element of the current window and saves it to `tests/_output/debug`.
1306+
1307+
{% highlight php %}
1308+
1309+
<?php
1310+
$I->amOnPage('/user/edit');
1311+
$I->makeElementScreenshot('#dialog', 'edit_page');
1312+
// saved to: tests/_output/debug/edit_page.png
1313+
$I->makeElementScreenshot('#dialog');
1314+
// saved to: tests/_output/debug/2017-05-26_14-24-11_4b3403665fea6.png
1315+
1316+
{% endhighlight %}
1317+
1318+
* `param` $name
1319+
1320+
13011321
#### makeHtmlSnapshot
13021322

1303-
Saves current page's HTML into a temprary file.
1304-
Use this method in debug mode within an interactive pause to get a source code of current page.
1323+
Use this method within an [interactive pause](https://codeception.com/docs/02-GettingStarted#Interactive-Pause) to save the HTML source code of the current page.
13051324

13061325
{% highlight php %}
13071326

0 commit comments

Comments
 (0)