Merge pull request #282 from php-enqueue/yii-doc

[doc] yii2-queue amqp driver

Author: makasim

README.md

@@ -65,21 +65,22 @@ Features:
 [![Build Status](https://travis-ci.org/php-enqueue/null.png?branch=master)](https://travis-ci.org/php-enqueue/null)
 [![Total Downloads](https://poser.pugx.org/enqueue/null/d/total.png)](https://packagist.org/packages/enqueue/null)
 [![Latest Stable Version](https://poser.pugx.org/enqueue/null/version.png)](https://packagist.org/packages/enqueue/null)
-* [Symfony bundle](https://github.com/php-enqueue/enqueue-dev/blob/master/docs/bundle/quick_tour.md)
-* [Magento1 extension](https://github.com/php-enqueue/enqueue-dev/blob/master/docs/magento/quick_tour.md)
-* [Laravel extension](https://github.com/php-enqueue/enqueue-dev/blob/master/docs/laravel/quick_tour.md)
-* [Message bus](http://www.enterpriseintegrationpatterns.com/patterns/messaging/MessageBus.html) support.
-* [RPC over MQ](https://www.rabbitmq.com/tutorials/tutorial-one-php.html) support.
+* [Symfony bundle](docs/bundle/quick_tour.md)
+* [Magento1 extension](docs/magento/quick_tour.md)
+* [Laravel extension](docs/laravel/quick_tour.md)
+* [Yii2. Amqp driver](docs/yii/amqp_driver.md)
+* [Message bus](docs/quick_tour.md#client) support.
+* [RPC over MQ](docs/quick_tour.md#remote-procedure-call-rpc) support.
 * Temporary queues support.
 * Well designed, decoupled and reusable components.
 * Carefully tested (unit & functional).
 * For more visit [quick tour](docs/quick_tour.md).
 
 ## Resources
 
-* [Quick tour](https://github.com/php-enqueue/enqueue-dev/blob/master/docs/quick_tour.md)
-* [Documentation](https://github.com/php-enqueue/enqueue-dev/blob/master/docs/index.md)
-* [Blog](https://github.com/php-enqueue/enqueue-dev/blob/master/docs/index.md#blogs)
+* [Quick tour](docs/quick_tour.md)
+* [Documentation](docs/index.md)
+* [Blog](docs/index.md#blogs)
 * [Questions](https://gitter.im/php-enqueue/Lobby)
 * [Issue Tracker](https://github.com/php-enqueue/enqueue-dev/issues)
 

docs/index.md

@@ -44,6 +44,8 @@
 * [Magento](#magento)
     - [Quick tour](magento/quick_tour.md)
     - [Cli commands](magento/cli_commands.md)
+* [Yii](#yii)
+    - [AMQP Interop driver](yii/amqp_driver.md)
 * [Use cases](#use-cases)
     - [FOSElasticaBundle. Populate command optimizations](elastica-bundle/populate-command-optimization.md)
     - [Symfony. Async event dispatcher](async_event_dispatcher/quick_tour.md)

docs/yii/amqp_driver.md

@@ -0,0 +1,71 @@
+# Yii2Queue. AMQP Interop driver
+
+_**Note: ** This a copy of [AMQP Interop doc](https://github.com/yiisoft/yii2-queue/blob/master/docs/guide/driver-amqp-interop.md) from the yiisoft/yii2-queue [repository](https://github.com/yiisoft/yii2-queue)._
+
+
+The driver works with RabbitMQ queues.
+
+In order for it to work you should add any [amqp interop](https://github.com/queue-interop/queue-interop#amqp-interop) compatible transport to your project, for example `enqueue/amqp-lib` package.
+
+Advantages:
+
+* It would work with any amqp interop compatible transports, such as 
+
+    * [enqueue/amqp-ext](https://github.com/php-enqueue/amqp-ext) based on [PHP amqp extension](https://github.com/pdezwart/php-amqp)
+    * [enqueue/amqp-lib](https://github.com/php-enqueue/amqp-lib) based on [php-amqplib/php-amqplib](https://github.com/php-amqplib/php-amqplib)
+    * [enqueue/amqp-bunny](https://github.com/php-enqueue/amqp-bunny) based on [bunny](https://github.com/jakubkulhan/bunny)
+    
+* Supports priorities
+* Supports delays
+* Supports ttr
+* Supports attempts
+* Contains new options like: vhost, connection_timeout, qos_prefetch_count and so on.
+* Supports Secure (SSL) AMQP connections.
+* An ability to set DSN like: amqp:, amqps: or amqp://user:pass@localhost:1000/vhost
+
+Configuration example:
+
+```php
+return [
+    'bootstrap' => [
+        'queue', // The component registers own console commands
+    ],
+    'components' => [
+        'queue' => [
+            'class' => \yii\queue\amqp_interop\Queue::class,
+            'port' => 5672,
+            'user' => 'guest',
+            'password' => 'guest',
+            'queueName' => 'queue',
+            'driver' => yii\queue\amqp_interop\Queue::ENQUEUE_AMQP_LIB,
+            
+            // or
+            'dsn' => 'amqp://guest:guest@localhost:5672/%2F',
+            
+            // or, same as above
+            'dsn' => 'amqp:',
+        ],
+    ],
+];
+```
+
+Console
+-------
+
+Console is used to listen and process queued tasks.
+
+```sh
+yii queue/listen
+```
+
+`listen` command launches a daemon which infinitely queries the queue. If there are new tasks
+they're immediately obtained and executed. This method is most efficient when command is properly
+daemonized via supervisor.
+
+`listen` command has options:
+
+- `--verbose`, `-v`: print executing statuses into console.
+- `--isolate`: verbose mode of a job execute. If enabled, execute result of each job will be printed.
+- `--color`: highlighting for verbose mode.
+
+[back to index](../index.md)