auto updated documentation

DavertMik · DavertMik · commit a844c9eb7c88 · 2016-08-14T15:17:33.000+03:00
diff --git a/changelog.markdown b/changelog.markdown
@@ -7,6 +7,24 @@ title: Codeception Changelog
 
 # Changelog
 
+#### 2.2.4
+
+* Improved using complex params, nested params can be set using dot (`.`). See [#3339](https://github.com/Codeception/Codeception/issues/3339)
+* **[Yii2]** Mailer mock is now configured with options that make sense for it. Fixes [#3382](https://github.com/Codeception/Codeception/issues/3382)
+* **[Yii2]** Fixed creating `@webroot` directory on running functional tests. See [#3387](https://github.com/Codeception/Codeception/issues/3387)
+* **[Yii2]** Fixed regression in Yii 2 connector not allowing to work with output of error pages in functional tests. Fixes [#3332](https://github.com/Codeception/Codeception/issues/3332)
+* **[REST]** `seeResponseIsJson` fails when response is empty. See [#3401](https://github.com/Codeception/Codeception/issues/3401), closes [#3400](https://github.com/Codeception/Codeception/issues/3400)
+* **[AMQP]** Added `purgeQueue` and `purgeAllQueues` actions. By **[niclopez](https://github.com/niclopez)**
+* **[DataFactory]** `haveMultiple` fixed; corrected the order of arguments in `FactoryMuffin->seed`. See [#3413](https://github.com/Codeception/Codeception/issues/3413) by **[buffcode](https://github.com/buffcode)**
+* **[SOAP]** Improved error reporting by **[eXorus](https://github.com/eXorus)** See [#3426](https://github.com/Codeception/Codeception/issues/3426) [#3422](https://github.com/Codeception/Codeception/issues/3422)
+* **[SOAP]** Added `SOAPAction` config param to unset `SOAPAction` header in SOAP >= 1.2. See [#3396](https://github.com/Codeception/Codeception/issues/3396)
+* **[REST]** fixed digest authentication. See [#3416](https://github.com/Codeception/Codeception/issues/3416)
+* **[Laravel5]** Fixed an issue with error handling for Laravel 5.3. See [#3420](https://github.com/Codeception/Codeception/issues/3420). By **[bonsi](https://github.com/bonsi)**.
+* **[Laravel5]** Fixed an issue with uploaded files. See [#3417](https://github.com/Codeception/Codeception/issues/3417). By **[torkiljohnsen](https://github.com/torkiljohnsen)**.
+* **[ZF2]** Support for zend-mvc 3.0
+* **[Db]** Error is thrown if SQLite memory is used. [#3319](https://github.com/Codeception/Codeception/issues/3319)
+* **[Frameworks]** `REQUEST_TIME` server variable to be set on request. By **[gimler](https://github.com/gimler)**. Fixes [#3374](https://github.com/Codeception/Codeception/issues/3374)
+
 #### 2.2.3
 
 * **[Yii2]** Improvements:
@@ -20,6 +38,7 @@ title: Codeception Changelog
     * added `seeEmailIsSent`, `grabLastSentEmail`, etc and email part.
     * assetManager disabled for unit/functional tests.
 * Fixed `@example` to `@group` defined in group files. By **[eXorus](https://github.com/eXorus)**. Fixes [#3278](https://github.com/Codeception/Codeception/issues/3278)
+* Added `ReqiuiresPackage` interface to set external dependencies for modules.
 * Fixed timing values in output. Closes [#3331](https://github.com/Codeception/Codeception/issues/3331)
 * Fixed merging module configs. Closes [#3292](https://github.com/Codeception/Codeception/issues/3292)
 * [Recorder Extension] Fixes saving of files on windows and with using examples.
diff --git a/docs/modules/AMQP.md b/docs/modules/AMQP.md
@@ -68,6 +68,32 @@ $message = $I->grabMessageFromQueue('queue.emails');
  * `return` AMQPMessage
 
 
+#### purgeAllQueues
+ 
+Purge all queues defined in config.
+
+{% highlight php %}
+
+<?php
+$I->purgeAllQueues();
+?>
+
+{% endhighlight %}
+
+
+#### purgeQueue
+ 
+Purge a specific queue defined in config.
+
+{% highlight php %}
+
+<?php
+$I->purgeQueue('queue.emails');
+?>
+
+{% endhighlight %}
+
+
 #### pushToExchange
  
 Sends message to exchange by sending exchange name, message
diff --git a/docs/modules/MongoDb.md b/docs/modules/MongoDb.md
@@ -17,6 +17,13 @@ To have your database properly cleaned you should configure it to access the dat
 
 In order to have your database populated with data you need a valid js file with data (of the same style which can be fed up to mongo binary)
 File can be generated by RockMongo export command
+You can also use directoy, generated by {% highlight yaml %}
+mongodump
+{% endhighlight %} tool or it's {% highlight yaml %}
+.tar.gz
+{% endhighlight %} archive (not available for Windows systems), generated by {% highlight yaml %}
+tar -czf <archve_file_name>.tar.gz <path_to dump directory>
+{% endhighlight %}.
 Just put it in {% highlight yaml %}
 tests/_data 
 {% endhighlight %} dir (by default) and specify path to it in config.
@@ -41,6 +48,9 @@ Check out the driver if you get problems loading dumps and cleaning databases.
 * dsn *required* - MongoDb DSN with the db name specified at the end of the host after slash
 * user *required* - user to access database
 * password *required* - password
+* dump_type *required* - type of dump.
+  One of 'js' (MongoDb::DUMP_TYPE_JS), 'mongodump' (MongoDb::DUMP_TYPE_MONGODUMP) or 'mongodump-tar-gz' (MongoDb::DUMP_TYPE_MONGODUMP_TAR_GZ).
+  default: MongoDb::DUMP_TYPE_JS).
 * dump - path to database dump
 * populate: true - should the dump be loaded before test suite is started.
 * cleanup: true - should the dump be reloaded after each test
diff --git a/docs/modules/Redis.md b/docs/modules/Redis.md
@@ -21,13 +21,27 @@ to interact with a Redis server.
 
 * **`host`** (`string`, default `'127.0.0.1'`) - The Redis host
 * **`port`** (`int`, default `6379`) - The Redis port
-* **`database`** (`int`, no default) - The Redis database. Needs to be explicitely specified.
+* **`database`** (`int`, no default) - The Redis database. Needs to be explicitly specified.
 * **`cleanupBefore`**: (`string`, default `'suite'`) - Whether/when to flush the database:
     * `suite`: at the beginning of every suite
     * `test`: at the beginning of every test
     * Any other value: never
 
+#### Example (`unit.suite.yml`)
+
+{% highlight yaml %}
+
+   modules:
+       - Redis:
+           host: '127.0.0.1'
+           port: 6379
+           database: 0
+           cleanupBefore: 'test'
+
+{% endhighlight %}
+
 ### Public Properties
+
 * **driver** - Contains the Predis client/driver
 
 @author Marc Verney <marc@marcverney.net>
@@ -50,19 +64,25 @@ provided $value
 Examples:
 
 {% highlight php %}
-?start_inline=1
+
+<?php
 // With only one argument, only checks the key does not exist
 $I->dontSeeInRedis('example:string');
+
 // Checks a String does not exist or its value is not the one provided
 $I->dontSeeInRedis('example:string', 'life');
+
 // Checks a List does not exist or its value is not the one provided (order of elements is compared).
-$I->dontSeeInRedis('example:list', ['riri', 'fifi', 'loulou'])
+$I->dontSeeInRedis('example:list', ['riri', 'fifi', 'loulou']);
+
 // Checks a Set does not exist or its value is not the one provided (order of members is ignored).
-$I->dontSeeInRedis('example:set', ['riri', 'fifi', 'loulou'])
+$I->dontSeeInRedis('example:set', ['riri', 'fifi', 'loulou']);
+
 // Checks a ZSet does not exist or its value is not the one provided (scores are required, order of members is compared)
-$I->dontSeeInRedis('example:zset', ['riri' => 1, 'fifi' => 2, 'loulou' => 3])
+$I->dontSeeInRedis('example:zset', ['riri' => 1, 'fifi' => 2, 'loulou' => 3]);
+
 // Checks a Hash does not exist or its value is not the one provided (order of members is ignored).
-$I->dontSeeInRedis('example:hash', ['riri' => true, 'fifi' => 'Dewey', 'loulou' => 2])
+$I->dontSeeInRedis('example:hash', ['riri' => true, 'fifi' => 'Dewey', 'loulou' => 2]);
 
 {% endhighlight %}
 
@@ -78,21 +98,28 @@ Asserts that a given key does not contain a given item
 Examples:
 
 {% highlight php %}
-?start_inline=1
+
+<?php
 // Strings: performs a substring search
-$I->dontSeeRedisKeyContains('example:string', 'bar') // true for foobar
+$I->dontSeeRedisKeyContains('string', 'bar');
+
 // Lists
-$I->dontSeeRedisKeyContains('example:list', 'poney')
+$I->dontSeeRedisKeyContains('example:list', 'poney');
+
 // Sets
-$I->dontSeeRedisKeyContains('example:set', 'cat')
+$I->dontSeeRedisKeyContains('example:set', 'cat');
+
 // ZSets: check whether the zset has this member
-$I->dontSeeRedisKeyContains('example:zset', 'jordan')
+$I->dontSeeRedisKeyContains('example:zset', 'jordan');
+
 // ZSets: check whether the zset has this member with this score
-$I->dontSeeRedisKeyContains('example:zset', 'jordan', 23)
+$I->dontSeeRedisKeyContains('example:zset', 'jordan', 23);
+
 // Hashes: check whether the hash has this field
-$I->dontSeeRedisKeyContains('example:hash', 'magic')
+$I->dontSeeRedisKeyContains('example:hash', 'magic');
+
 // Hashes: check whether the hash has this field with this value
-$I->dontSeeRedisKeyContains('example:hash', 'magic', 32)
+$I->dontSeeRedisKeyContains('example:hash', 'magic', 32);
 
 {% endhighlight %}
 
@@ -111,25 +138,34 @@ Returns the value of a given key
 Examples:
 
 {% highlight php %}
-?start_inline=1
+
+<?php
 // Strings
-$I->grabFromRedis('example:string')
+$I->grabFromRedis('string');
+
 // Lists: get all members
-$I->grabFromRedis('example:list')
+$I->grabFromRedis('example:list');
+
 // Lists: get a specific member
-$I->grabFromRedis('example:list', 2)
+$I->grabFromRedis('example:list', 2);
+
 // Lists: get a range of elements
-$I->grabFromRedis('example:list', 2, 4)
+$I->grabFromRedis('example:list', 2, 4);
+
 // Sets: get all members
-$I->grabFromRedis('example:set')
+$I->grabFromRedis('example:set');
+
 // ZSets: get all members
-$I->grabFromRedis('example:zset')
+$I->grabFromRedis('example:zset');
+
 // ZSets: get a range of members
-$I->grabFromRedis('example:zset', 3, 12)
+$I->grabFromRedis('example:zset', 3, 12);
+
 // Hashes: get all fields of a key
-$I->grabFromRedis('example:hash')
+$I->grabFromRedis('example:hash');
+
 // Hashes: get a specific field of a key
-$I->grabFromRedis('example:hash', 'foo')
+$I->grabFromRedis('example:hash', 'foo');
 
 {% endhighlight %}
 
@@ -151,17 +187,22 @@ If $key already exists:
 Examples:
 
 {% highlight php %}
-?start_inline=1
+
+<?php
 // Strings: $value must be a scalar
-$I->haveInRedis('example:string', 'Obladi Oblada')
+$I->haveInRedis('string', 'Obladi Oblada');
+
 // Lists: $value can be a scalar or an array
-$I->haveInRedis('example:list', ['riri', 'fifi', 'loulou'])
+$I->haveInRedis('list', ['riri', 'fifi', 'loulou']);
+
 // Sets: $value can be a scalar or an array
-$I->haveInRedis('example:set', ['riri', 'fifi', 'loulou'])
+$I->haveInRedis('set', ['riri', 'fifi', 'loulou']);
+
 // ZSets: $value must be an associative array with scores
-$I->haveInRedis('example:set', ['riri' => 1, 'fifi' => 2, 'loulou' => 3])
+$I->haveInRedis('set', ['riri' => 1, 'fifi' => 2, 'loulou' => 3]);
+
 // Hashes: $value must be an associative array
-$I->haveInRedis('example:hash', ['obladi' => 'oblada'])
+$I->haveInRedis('hash', ['obladi' => 'oblada']);
 
 {% endhighlight %}
 
@@ -174,24 +215,30 @@ $I->haveInRedis('example:hash', ['obladi' => 'oblada'])
 
 #### seeInRedis
  
-Asserts that a key exists, and optionaly that it has the provided $value
+Asserts that a key exists, and optionally that it has the provided $value
 
 Examples:
 
 {% highlight php %}
-?start_inline=1
+
+<?php
 // With only one argument, only checks the key exists
 $I->seeInRedis('example:string');
+
 // Checks a String exists and has the value "life"
 $I->seeInRedis('example:string', 'life');
+
 // Checks the value of a List. Order of elements is compared.
-$I->seeInRedis('example:list', ['riri', 'fifi', 'loulou'])
+$I->seeInRedis('example:list', ['riri', 'fifi', 'loulou']);
+
 // Checks the value of a Set. Order of members is ignored.
-$I->seeInRedis('example:set', ['riri', 'fifi', 'loulou'])
+$I->seeInRedis('example:set', ['riri', 'fifi', 'loulou']);
+
 // Checks the value of a ZSet. Scores are required. Order of members is compared.
-$I->seeInRedis('example:zset', ['riri' => 1, 'fifi' => 2, 'loulou' => 3])
+$I->seeInRedis('example:zset', ['riri' => 1, 'fifi' => 2, 'loulou' => 3]);
+
 // Checks the value of a Hash. Order of members is ignored.
-$I->seeInRedis('example:hash', ['riri' => true, 'fifi' => 'Dewey', 'loulou' => 2])
+$I->seeInRedis('example:hash', ['riri' => true, 'fifi' => 'Dewey', 'loulou' => 2]);
 
 {% endhighlight %}
 
@@ -207,21 +254,28 @@ Asserts that a given key contains a given item
 Examples:
 
 {% highlight php %}
-?start_inline=1
+
+<?php
 // Strings: performs a substring search
-$I->seeRedisKeyContains('example:string', 'bar') // true for foobar
+$I->seeRedisKeyContains('example:string', 'bar');
+
 // Lists
-$I->seeRedisKeyContains('example:list', 'poney')
+$I->seeRedisKeyContains('example:list', 'poney');
+
 // Sets
-$I->seeRedisKeyContains('example:set', 'cat')
+$I->seeRedisKeyContains('example:set', 'cat');
+
 // ZSets: check whether the zset has this member
-$I->seeRedisKeyContains('example:zset', 'jordan')
+$I->seeRedisKeyContains('example:zset', 'jordan');
+
 // ZSets: check whether the zset has this member with this score
-$I->seeRedisKeyContains('example:zset', 'jordan', 23)
+$I->seeRedisKeyContains('example:zset', 'jordan', 23);
+
 // Hashes: check whether the hash has this field
-$I->seeRedisKeyContains('example:hash', 'magic')
+$I->seeRedisKeyContains('example:hash', 'magic');
+
 // Hashes: check whether the hash has this field with this value
-$I->seeRedisKeyContains('example:hash', 'magic', 32)
+$I->seeRedisKeyContains('example:hash', 'magic', 32);
 
 {% endhighlight %}
 
@@ -242,7 +296,8 @@ Every argument that follows the $command name will be passed to it.
 Examples:
 
 {% highlight php %}
-?start_inline=1
+
+<?php
 $I->sendCommandToRedis('incr', 'example:string');
 $I->sendCommandToRedis('strLen', 'example:string');
 $I->sendCommandToRedis('lPop', 'example:list');
diff --git a/docs/modules/SOAP.md b/docs/modules/SOAP.md
@@ -32,6 +32,7 @@ If you use PHP SoapServer with framework, try to block call to this method in te
 ### Configuration
 
 * endpoint *required* - soap wsdl endpoint
+* SOAPAction - replace SOAPAction HTTP header (Set to '' to SOAP 1.2)
 
 ### Public Properties
 
diff --git a/docs/modules/ZF2.md b/docs/modules/ZF2.md
@@ -15,11 +15,12 @@ This module allows you to run tests inside Zend Framework 2.
 File `init_autoloader` in project's root is required.
 Uses `tests/application.config.php` config file by default.
 
+Note: services part and Doctrine integration is not compatible with ZF3 yet
+
 ### Status
 
-* Maintainer: **bladeofsteel**
-* Stability: **alpha**
-* Contact: https://github.com/bladeofsteel
+* Maintainer: **Naktibalda**
+* Stability: **stable**
 
 ### Config
 
@@ -33,7 +34,7 @@ Uses `tests/application.config.php` config file by default.
 
 ### Parts
 
-* services - allows to use grabServiceFromContainer with WebDriver or PhpBrowser modules.
+* services - allows to use grabServiceFromContainer and addServiceToContainer with WebDriver or PhpBrowser modules.
 
 Usage example:
 
diff --git a/docs/reference/Configuration.md b/docs/reference/Configuration.md
diff --git a/docs/reference/Locator.md b/docs/reference/Locator.md
