joshuakevin/yii2-queue

Yii2 Queue Extension which supported DB, Redis, RabbitMQ, Beanstalk and Gearman

, _(*1)

Yii2 Queue Extension

An extension for running tasks asyncronously via queues., _(*2)

It supported queues based on DB, Redis, RabbitMQ, Beanstalk and Gearman., _(*3)

Documentation is at docs/guide/README.md., _(*4)

, _(*5)

Installation

The preferred way to install this extension is through composer., _(*6)

Either run, _(*7)

php composer.phar require --prefer-dist yiisoft/yii2-queue

or add, _(*8)

"yiisoft/yii2-queue": "~2.0.0"

to the require section of your composer.json file., _(*9)

Basic Usage

Each task which is sent to queue should be defined as a separate class. For example, if you need to download and save a file the class may look like the following:, _(*10)

class DownloadJob extends BaseObject implements \yii\queue\JobInterface
{
    public $url;
    public $file;

    public function execute($queue)
    {
        file_put_contents($this->file, file_get_contents($this->url));
    }
}

Here's how to send a task into queue:, _(*11)

Yii::$app->queue->push(new DownloadJob([
    'url' => 'http://example.com/image.jpg',
    'file' => '/tmp/image.jpg',
]));

Pushes job into queue that run after 5 min:, _(*12)

Yii::$app->queue->delay(5 * 60)->push(new DownloadJob([
    'url' => 'http://example.com/image.jpg',
    'file' => '/tmp/image.jpg',
]));

The exact way task is executed depends on the driver used. The most part of drivers can be run using console commands, which the component registers in your application., _(*13)

Command that obtains and executes tasks in a loop until queue is empty:, _(*14)

yii queue/run

Command launches a daemon which infinitely queries the queue:, _(*15)

yii queue/listen

See documentation for more details about driver console commands and their options., _(*16)

The component has ability to track status of a job which was pushed into queue., _(*17)

// Push a job into queue and get message ID.
$id = Yii::$app->queue->push(new SomeJob());

// The job is waiting for execute.
Yii::$app->queue->isWaiting($id);

// Worker gets the job from queue, and executing it.
Yii::$app->queue->isReserved($id);

// Worker has executed the job.
Yii::$app->queue->isDone($id);

For more details see the guide., _(*18)