Download the PHP package rickcy/yii2-rabbitmq without Composer

On this page you can find all versions of the php package rickcy/yii2-rabbitmq. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package yii2-rabbitmq

RabbitMQ Extension for Yii2

Wrapper based on php-amqplib library to incorporate messaging in your Yii2 application via RabbitMQ

This documentation is relevant for the version 2.*, which require PHP version >=7.0

Installation

The preferred way to install this extension is through composer.

Either run

or add

to the require section of your composer.json file.

Configuration

This extension facilitates the creation of RabbitMQ producers and consumers to meet your specific needs. This is an example basic config:

To use this extension you should be familiar with the basic concepts of RabbitMQ. If you are not confident in your knowledge I suggest reading this article.

The 'callback' parameter can be a class name or a service name from dependency injection container. Starting from Yii version 2.0.11 you can configure your container like this:

If you need several consumers you can list respective entries in the configuration, but that would require a separate worker(daemon process) for each of that consumers. While it can be absolutely fine in some cases if you are dealing with small queues which consuming messages really fast you may want to group them into one worker. So just list your callbacks in consumer config and one worker will perform your business logic on multiple queues.

Be sure that all queues and exchanges are defined in corresponding bindings, it's up to you to set up correct message routing.

Lifecycle events

There are also some lifecycle events implemented: before_consume, after_consume, before_publish, after_publish. You can use them for any additional work you need to do before or after message been consumed/published. For example, make sure that Yii knows the database connection has been closed by a timeout as a consumer is a long-running process:

Logger

Last but not least is logger configuration which is also optional:

Logger disabled by default. When enabled it will log messages into main application log or to your own log target if you specify corresponding category name. Option 'print_console' gives you additional information while debugging a consumer in you console.

Example

Simple setup of Yii2 basic template with the RabbitMQ extension is available here. Feel free to experiment with it and debug your existing configuration in an isolated manner.

Console commands

Extension provides several console commands:

To start a consumer:

In this case, you can use process control system, like Supervisor, to restart consumer process and this way keep your worker run continuously.

Message limit

As PHP daemon especially based upon a framework may be prone to memory leaks, it may be reasonable to limit the number of messages to consume and stop:

Auto-declare

By default extension configured in auto-declare mode, which means that on every message published exchanges, queues and bindings will be checked and created if missing. If performance means much to your application you should disable that feature in configuration and use console commands to declare and delete routing schema by yourself.

Usage

As the consumer worker will read messages from the queue, execute a callback method and pass a message to it.

Consume

In order a class to become a callback it should implement ConsumerInterface:

You can publish any data type(object, int, array etc), despite the fact that RabbitMQ will transfer payload as a string here in consumer $msg->body your data will be of the same type it was sent.

Return codes

As for the return codes there is a bunch of them in order for you to control following processing of the message by the broker:

Routing key as third parameter is optional, which can be the case for fanout exchanges.

By default connection to broker only get established upon publishing a message, it would not try to connect on each HTTP request if there is no need to.

Options

All configuration options:

Exchange

For example, to declare an exchange you should provide name and type for it.

parameter required type default comments
name yes string The exchange name consists of a non-empty sequence of these characters: letters, digits, hyphen, underscore, period, or colon.
type yes string Type of the exchange, possible values are direct, fanout, topic and headers.
passive no boolean false If set to true, the server will reply with Declare-Ok if the exchange already exists with the same name, and raise an error if not. The client can use this to check whether an exchange exists without modifying the server state. When set, all other method fields except name and no-wait are ignored. A declare with both passive and no-wait has no effect.
durable no boolean false Durable exchanges remain active when a server restarts. Non-durable exchanges (transient exchanges) are purged if/when a server restarts.
auto_delete no boolean true If set to true, the exchange would be deleted when no queues are bound to it anymore.
internal no boolean false Internal exchange may not be used directly by publishers, but only when bound to other exchanges.
nowait no boolean false Client may send next request immediately after sending the first one, no waiting for the reply is required
arguments no array null A set of arguments for the declaration.
ticket no integer null Access ticket

Good use-case of the arguments parameter usage can be a creation of a dead-letter-exchange.

Queue

As for the queue declaration, all parameters are optional. Even if you do not provide a name for your queue server will generate a unique name for you:

parameter required type default comments
name no string '' The queue name can be empty, or a sequence of these characters: letters, digits, hyphen, underscore, period, or colon.
passive no boolean false If set to true, the server will reply with Declare-Ok if the queue already exists with the same name, and raise an error if not.
durable no boolean false Durable queues remain active when a server restarts. Non-durable queues (transient queues) are purged if/when a server restarts.
auto_delete no boolean true If set to true, the queue is deleted when all consumers have finished using it.
exclusive no boolean false Exclusive queues may only be accessed by the current connection, and are deleted when that connection closes. Passive declaration of an exclusive queue by other connections are not allowed.
nowait no boolean false Client may send next request immediately after sending the first one, no waiting for the reply is required
arguments false array null A set of arguments for the declaration.
ticket no integer null Access ticket

A complete explanation about options, their defaults, and valuable details can be found in AMQP 0-9-1 Reference Guide.

Beware that not all these options are allowed to be changed 'on-the-fly', in other words after queue or exchange had already been created. Otherwise, you will receive an error.

Breaking Changes

Since version 1.* this extension was completely rewritten internally and can be considered brand new. However, the following key differences can be distinguished:


All versions of yii2-rabbitmq with dependencies

PHP Build Version
Package Version
Requires php Version ^7.1
yiisoft/yii2 Version ^2.0.32
php-amqplib/php-amqplib Version ^2
ext-json Version *
ext-pcntl Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package rickcy/yii2-rabbitmq contains the following files

Loading the files please wait ....