auto updated documentation

DavertMik · DavertMik · commit 972b87e41811 · 2016-02-10T00:20:03.000+02:00
diff --git a/changelog.markdown b/changelog.markdown
@@ -7,6 +7,30 @@ title: Codeception Changelog
 
 # Changelog
 
+#### 2.1.6
+
+* Starting from 2.1.6 you can **download PHP 5.4 compatible phar build** at http://codeception.com/php54/codecept.phar by <strong><a href="https://github.com/Naktibalda">@Naktibalda</a></strong>. See [installation guide](http://codeception.com/install).
+* <strong>[WebDriver]</strong> Fixed uploading files with **PhantomJS** <a href="https://github.com/Codeception/Codeception/issues/1823">#1823</a> by <strong><a href="https://github.com/DavertMik">@DavertMik</a></strong> and <strong><a href="https://github.com/Naktibalda">@Naktibalda</a></strong>. Please specify your browser name as `phantom` in WebDriver config in order to use PhantomJS-specific hooks.
+* Fixed parsing PHP files with spaces in name on PHP<7 by <strong><a href="https://github.com/acuthbert">@acuthbert</a></strong>. Fixes <a href="https://github.com/Codeception/Codeception/issues/2647">#2647</a>
+* <strong>[WebDriver]</strong> Fixed proxy error when using with Chrome <a href="https://github.com/Codeception/Codeception/issues/2651">#2651</a> by <strong><a href="https://github.com/vaikla">@vaikla</a></strong>
+* <strong>[Laravel5]</strong> Allow Laravel5 application URL to be set through config. By <strong><a href="https://github.com/gmhenderson">@gmhenderson</a></strong>. See <a href="https://github.com/Codeception/Codeception/issues/2676">#2676</a>
+* <strong>[Laravel5]</strong> Mocked events should also return an array. Fix by <strong><a href="https://github.com/devinfd">@devinfd</a></strong>
+* Fixed using codecoverage with environments <a href="https://github.com/Codeception/Codeception/issues/2634">#2634</a>
+* Various HHVM improvements by <strong><a href="https://github.com/Naktibalda">@Naktibalda</a></strong>, for instance, Asserts module issues has been fixed.
+* <strong>[REST]</strong> Fixes <a href="https://github.com/Codeception/Codeception/issues/2775">#2775</a> `seeResponseJsonMatchesXpath` when JSON contains ampersand. By <strong><a href="https://github.com/Naktibalda">@Naktibalda</a></strong>.
+* <strong>[Filesystem]</strong> Added `seeNumberNewLines` method to check the number of new lines in opened file. By <strong><a href="https://github.com/sergeyklay">@sergeyklay</a></strong>
+* <strong>[Symfony2]</strong> Added `seeCurrentRouteMatches` action by <strong><a href="https://github.com/laszlo">@laszlo</a></strong>-karpati See <a href="https://github.com/Codeception/Codeception/issues/2665">#2665</a>
+* <strong>[Sequence]</strong> Added `sqs` function to generate unique sequences per suite. <a href="https://github.com/Codeception/Codeception/issues/2766">#2766</a> by <strong><a href="https://github.com/johnatannvmd">@johnatannvmd</a></strong>
+* <strong>[FTP]</strong> Fixed various bugs by <strong><a href="https://github.com/k">@k</a></strong>-serenade. See <a href="https://github.com/Codeception/Codeception/issues/2755">#2755</a>
+* <strong>[Frameworks]</strong><strong>[PhpBrowser]</strong> Fixed <a href="https://github.com/Codeception/Codeception/issues/2733">#2733</a>: `seeOptionIsSelected` sees first option as selected if none is selected by <strong><a href="https://github.com/Naktibalda">@Naktibalda</a></strong>
+* <strong>[Symfony2]</strong> Removed 'localhost' from getInternalDomains by <strong><a href="https://github.com/Naktibalda">@Naktibalda</a></strong>. Fixed <a href="https://github.com/Codeception/Codeception/issues/2717">#2717</a>
+* Bugfix for using groups by directory on Windows by <strong><a href="https://github.com/tortuetorche">@tortuetorche</a></strong> See <a href="https://github.com/Codeception/Codeception/issues/2550">#2550</a> and <a href="https://github.com/Codeception/Codeception/issues/2551">#2551</a>
+* <strong>[REST]</strong> Fixed failed message for `seeHttpHeader` and `dontSeeHttpHeader` from null to expected value <a href="https://github.com/Codeception/Codeception/issues/2697">#2697</a> by <strong><a href="https://github.com/zondor">@zondor</a></strong>
+* <strong>[REST]</strong> Added methods to control redirect: `stopFollowingRedirects` and `startFollowingRedirects` by <strong><a href="https://github.com/brutuscat">@brutuscat</a></strong>
+* [Recorder Extension] Added `animate_slides` config to disable left-right sliding animation between screenshots by <strong><a href="https://github.com/vml">@vml</a></strong>-rmott
+
+
+
 #### 2.1.5
 
 * **PHP7 support**
diff --git a/docs/modules/Asserts.md b/docs/modules/Asserts.md
@@ -12,8 +12,6 @@ title: Asserts - Codeception - Documentation
 
 Special module for using asserts in your tests.
 
-<div class="alert alert-warning">Warning: does not work on <a href="https://github.com/facebook/hhvm/issues/5786">HHVM</a></div>
-
 
 #### assertContains
  
@@ -41,7 +39,6 @@ Checks that two variables are equal.
  * `param string` $message
 
 
-
 #### assertFalse
  
 Checks that condition is negative.
@@ -53,15 +50,15 @@ Checks that condition is negative.
 #### assertFileExists
  
 Checks if file exists
- 
+
  * `param string` $filename
  * `param string` $message
 
 
 #### assertFileNotExists
  
 Checks if file doesn't exist
- 
+
  * `param string` $filename
  * `param string` $message
 
@@ -190,7 +187,6 @@ Checks that two variables are same
  * `param string` $message
 
 
-
 #### assertTrue
  
 Checks that condition is positive.
diff --git a/docs/modules/FTP.md b/docs/modules/FTP.md
@@ -434,6 +434,24 @@ $I->seeInThisFile('codeception/codeception');
  * `param` $text
 
 
+#### seeNumberNewLines
+ 
+Checks If opened file has the `number` of new lines.
+
+Usage:
+
+{% highlight php %}
+
+<?php
+$I->openFile('composer.json');
+$I->seeNumberNewLines(5);
+?>
+
+{% endhighlight %}
+
+ * `param int` $number New lines
+
+
 #### writeToFile
  
 Saves contents to tmp file and uploads the FTP/SFTP system.
diff --git a/docs/modules/Filesystem.md b/docs/modules/Filesystem.md
@@ -192,6 +192,24 @@ $I->seeInThisFile('codeception/codeception');
  * `param` $text
 
 
+#### seeNumberNewLines
+ 
+Checks If opened file has the `number` of new lines.
+
+Usage:
+
+{% highlight php %}
+
+<?php
+$I->openFile('composer.json');
+$I->seeNumberNewLines(5);
+?>
+
+{% endhighlight %}
+
+ * `param int` $number New lines
+
+
 #### writeToFile
  
 Saves contents to file
diff --git a/docs/modules/Laravel4.md b/docs/modules/Laravel4.md
@@ -1452,7 +1452,8 @@ $I->setCookie('PHPSESSID', 'el4ukv0kqbvoirg7nkp4dncpk3');
 #### submitForm
  
 Submits the given form on the page, optionally with the given form
-values.  Give the form fields values as an array.
+values.  Pass the form field's values as an array in the second
+parameter.
 
 Although this function can be used as a short-hand version of 
 `fillField()`, `selectOption()`, `click()` etc. it has some important 
diff --git a/docs/modules/Laravel5.md b/docs/modules/Laravel5.md
@@ -39,6 +39,7 @@ See the Acceptance tests section below for more details.
 * packages: `string`, default `workbench` - Root path of application packages (if any).
 * disable_middleware: `boolean`, default `false` - disable all middleware.
 * disable_events: `boolean`, default `false` - disable all events.
+* url: `string`, default `` - The application URL.
 
 ### API
 
@@ -212,14 +213,14 @@ an array of credentials.
 $I->amLoggedAs(['username' => 'jane * `example.com',`  'password' => 'password']);
 
 // provide User object
-$I->amLoggesAs( new User );
+$I->amLoggedAs( new User );
 
 // can be verified with $I->seeAuthentication();
 ?>
 
 {% endhighlight %}
  * `param`  \Illuminate\Contracts\Auth\User|array $user
- * `param`  string|null $driver 'eloquent', 'database', or custom driver
+ * `param`  string|null $driver The authentication driver for Laravel <= 5.1.*, guard name for Laravel >= 5.2
  * `return` void
 
 
@@ -1536,7 +1537,8 @@ $I->setCookie('PHPSESSID', 'el4ukv0kqbvoirg7nkp4dncpk3');
 #### submitForm
  
 Submits the given form on the page, optionally with the given form
-values.  Give the form fields values as an array.
+values.  Pass the form field's values as an array in the second
+parameter.
 
 Although this function can be used as a short-hand version of 
 `fillField()`, `selectOption()`, `click()` etc. it has some important 
diff --git a/docs/modules/Lumen.md b/docs/modules/Lumen.md
@@ -1241,7 +1241,8 @@ $I->setCookie('PHPSESSID', 'el4ukv0kqbvoirg7nkp4dncpk3');
 #### submitForm
  
 Submits the given form on the page, optionally with the given form
-values.  Give the form fields values as an array.
+values.  Pass the form field's values as an array in the second
+parameter.
 
 Although this function can be used as a short-hand version of 
 `fillField()`, `selectOption()`, `click()` etc. it has some important 
diff --git a/docs/modules/Phalcon1.md b/docs/modules/Phalcon1.md
@@ -1295,7 +1295,8 @@ $I->setCookie('PHPSESSID', 'el4ukv0kqbvoirg7nkp4dncpk3');
 #### submitForm
  
 Submits the given form on the page, optionally with the given form
-values.  Give the form fields values as an array.
+values.  Pass the form field's values as an array in the second
+parameter.
 
 Although this function can be used as a short-hand version of 
 `fillField()`, `selectOption()`, `click()` etc. it has some important 
diff --git a/docs/modules/Phalcon2.md b/docs/modules/Phalcon2.md
@@ -1296,7 +1296,8 @@ $I->setCookie('PHPSESSID', 'el4ukv0kqbvoirg7nkp4dncpk3');
 #### submitForm
  
 Submits the given form on the page, optionally with the given form
-values.  Give the form fields values as an array.
+values.  Pass the form field's values as an array in the second
+parameter.
 
 Although this function can be used as a short-hand version of 
 `fillField()`, `selectOption()`, `click()` etc. it has some important 
diff --git a/docs/modules/PhpBrowser.md b/docs/modules/PhpBrowser.md
@@ -46,6 +46,18 @@ If test fails stores last shown page in 'output' dir.
                auth: ['admin', '123345']
                curl:
                    CURLOPT_RETURNTRANSFER: true
+               cookies:
+                   cookie-1:
+                       Name: userName
+                       Value: john.doe
+                   cookie-2:
+                       Name: authToken
+                       Value: 1abcd2345
+                       Domain: subdomain.domain.com
+                       Path: /admin/
+                       Expires: 1292177455
+                       Secure: true
+                       HttpOnly: false
 
 
 All SSL certification checks are disabled by default.
@@ -1214,7 +1226,8 @@ $I->amOnPage('test-headers.php');
 #### submitForm
  
 Submits the given form on the page, optionally with the given form
-values.  Give the form fields values as an array.
+values.  Pass the form field's values as an array in the second
+parameter.
 
 Although this function can be used as a short-hand version of 
 `fillField()`, `selectOption()`, `click()` etc. it has some important 
diff --git a/docs/modules/REST.md b/docs/modules/REST.md
@@ -583,6 +583,7 @@ $I->seeXmlResponseIncludes("<result>1</result>");
 {% endhighlight %}
 
  * `param` $xml
+ * `[Part]` xml
 
 
 #### seeXmlResponseMatchesXpath
@@ -700,4 +701,14 @@ Sends UNLINK request to given uri.
  * `[Part]` json
  * `[Part]` xml
 
+
+#### startFollowingRedirects
+ 
+Enables automatic redirects to be followed by the client
+
+
+#### stopFollowingRedirects
+ 
+Prevents automatic redirects to be followed by the client
+
 <p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/2.1/src/Codeception/Module/REST.php">Help us to improve documentation. Edit module reference</a></div>
diff --git a/docs/modules/Sequence.md b/docs/modules/Sequence.md
@@ -15,7 +15,8 @@ Instead cleaning up the database between tests,
 you can use generated unique names, that should not conflict.
 When you create article on a site, for instance, you can assign it a unique name and then check it.
 
-This module has no actions, but introduces a function `sq` for generating unique sequences.
+This module has no actions, but introduces a function `sq` for generating unique sequences within test and
+`sqs` for generating unique sequences across suite.
 
 #### Usage
 
@@ -60,6 +61,31 @@ for ($i = 0; $i<10; $i++) {
 
 {% endhighlight %}
 
+Cest Suite tests:
+
+{% highlight php %}
+
+<?php
+class UserTest
+{
+    public function createUser(AcceptanceTester $I)
+    {
+        $I->createUser('email' . sqs('user') . '@mailserver.com', sqs('login'), sqs('pwd'));
+    }
+
+    public function checkEmail(AcceptanceTester $I)
+    {
+        $I->seeInEmailTo('email' . sqs('user') . '@mailserver.com', sqs('login'));
+    }
+
+    public function removeUser(AcceptanceTester $I)
+    {
+        $I->removeUser('email' . sqs('user') . '@mailserver.com');
+    }
+}
+?>
+
+{% endhighlight %}
 
 
 <p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/2.1/src/Codeception/Module/Sequence.php">Help us to improve documentation. Edit module reference</a></div>
diff --git a/docs/modules/Silex.md b/docs/modules/Silex.md
@@ -1127,7 +1127,8 @@ $I->setCookie('PHPSESSID', 'el4ukv0kqbvoirg7nkp4dncpk3');
 #### submitForm
  
 Submits the given form on the page, optionally with the given form
-values.  Give the form fields values as an array.
+values.  Pass the form field's values as an array in the second
+parameter.
 
 Although this function can be used as a short-hand version of 
 `fillField()`, `selectOption()`, `click()` etc. it has some important 
diff --git a/docs/modules/Symfony2.md b/docs/modules/Symfony2.md
@@ -887,6 +887,22 @@ Checks if any email were sent by last request
  * `throws`  \LogicException
 
 
+#### seeInCurrentRoute
+ 
+Checks that current url matches route.
+Unlike seeCurrentRouteIs, this can matches without exact route parameters
+
+{% highlight php %}
+
+<?php
+$I->seeCurrentRouteMatches('my_blog_pages');
+?>
+
+{% endhighlight %}
+
+ * `param` $routeName
+
+
 #### seeInCurrentUrl
  
 Checks that current URI contains the given string.
@@ -1202,7 +1218,8 @@ $I->setCookie('PHPSESSID', 'el4ukv0kqbvoirg7nkp4dncpk3');
 #### submitForm
  
 Submits the given form on the page, optionally with the given form
-values.  Give the form fields values as an array.
+values.  Pass the form field's values as an array in the second
+parameter.
 
 Although this function can be used as a short-hand version of 
 `fillField()`, `selectOption()`, `click()` etc. it has some important 
diff --git a/docs/modules/WebDriver.md b/docs/modules/WebDriver.md
@@ -26,6 +26,8 @@ It allows you to run Selenium tests on a server without a GUI installed.
 1. Download [PhantomJS](http://phantomjs.org/download.html)
 2. Run PhantomJS in WebDriver mode: `phantomjs --webdriver=4444`
 
+You will need to set a browser name to `phantom` in configuration.
+
 
 ### Status
 
@@ -60,12 +62,19 @@ It allows you to run Selenium tests on a server without a GUI installed.
              url: 'http://localhost/'
              browser: firefox
              window_size: 1024x768
-             wait: 10
              capabilities:
                  unexpectedAlertBehaviour: 'accept'
                  firefox_profile: '/Users/paul/Library/Application Support/Firefox/Profiles/codeception-profile.zip.b64'
 
 
+#### PhantomJS Example (`acceptance.suite.yml`)
+
+    modules:
+       enabled:
+          - WebDriver:
+             url: 'http://localhost/'
+             browser: phantomjs
+
 
 ### SauceLabs.com Integration
 
@@ -650,7 +659,7 @@ If Codeception commands are not enough, this allows you to use Selenium WebDrive
 
 {% highlight php %}
 
-$I->executeInSelenium(function(\Facebook\WebDriver\RemoteWebDriver $webdriver) {
+$I->executeInSelenium(function(\Facebook\WebDriver\Remote\RemoteWebDriver $webdriver) {
   $webdriver->get('http://google.com');
 });
 
@@ -1570,7 +1579,7 @@ If the window has no name, the only way to access it is via the `executeInSeleni
 {% highlight php %}
 
 <?php
-$I->executeInSelenium(function (\Facebook\WebDriver\RemoteWebDriver $webdriver) {
+$I->executeInSelenium(function (\Facebook\WebDriver\Remote\RemoteWebDriver $webdriver) {
      $handles=$webdriver->getWindowHandles();
      $last_window = end($handles);
      $webdriver->switchTo()->window($last_window);
diff --git a/docs/modules/Yii1.md b/docs/modules/Yii1.md
@@ -1132,7 +1132,8 @@ $I->setCookie('PHPSESSID', 'el4ukv0kqbvoirg7nkp4dncpk3');
 #### submitForm
  
 Submits the given form on the page, optionally with the given form
-values.  Give the form fields values as an array.
+values.  Pass the form field's values as an array in the second
+parameter.
 
 Although this function can be used as a short-hand version of 
 `fillField()`, `selectOption()`, `click()` etc. it has some important 
diff --git a/docs/modules/Yii2.md b/docs/modules/Yii2.md
diff --git a/docs/modules/ZF1.md b/docs/modules/ZF1.md
diff --git a/docs/modules/ZF2.md b/docs/modules/ZF2.md
diff --git a/docs/modules/ZendExpressive.md b/docs/modules/ZendExpressive.md
