ea-liwei/cake-queue

There is no license information available for the latest version (dev-master) of this package.

CakeQueue plugin for CakePHP

dev-master 2017-04-05 09:50 UTC

Requires

• php: >=5.5.9
• cakephp/cakephp: >=3.3.2 <4.0.0

Suggests

• pda/pheanstalk: Required to use the Beanstalk queue driver (~3.0).

Unknown License

README

安装

composer require ea-liwei/cake-queue

./bin/cake plugin load -b CakeQueue

# 使用database时执行
./bin/cake queue table

# 失败job保存数据表
./bin/cake queue failed_table

./bin/cake migrations migrate

配置

// config/queue.php
<?php
return [
    'Queue' => [
        'default' => env('QUEUE_ENGINE', 'database'),
        'failed' => [
            'enable' => true,
            'connectionName' => 'default',
            'table' => 'failed_jobs',
            'model' => null
        ],
        'connections' => [
            'database' => [
                'className' => 'CakeQueue.Database',
                'retryAfter' => 60,
                'connectionName' => 'default',
                'table' => 'jobs',
                'model' => null
            ],
            'beanstalkd' => [
                'className' => 'CakeQueue.Beanstalkd',
                'host' => '127.0.0.1',
                'port' => 11300,
                'timeout' => 3,
                'persistent' => false
            ]
        ]
    ]
];

Sample

// src/Jobs/SendMailJob.php
<?php
namespace App\Jobs;

use CakeQueue\Queue\Job;

class SendMailJob extends Job
{
    /**
     * [handle description]
     * @return void
     */
    public function handle()
    {
        $user = $this->data();
        // Mail::to($user['email'])
    }
}

// src/Controller/QueueController.php
<?php
namespace App\Controller;

use App\Jobs\SendMailJob;
use CakeQueue\Queue\Queue;

class QueueController extends AppController
{
    /**
     * [index description]
     * @return void
     */
    public function index()
    {
        $job = new SendMailJob();
        // 延迟3秒 失败最大重试3次
        $job->data(['email' => '[e-mail]'])->delay(3)->maxTries(3);
        pr(Queue::push($job));
    }
}

# 启动worker
./bin/cake queue worker

# 显示所有失败队列
./bin/cake queue list_failed

# 清空失败队列
./bin/cake queue flush_failed

# 重试失败队列
./bin/cake queue retry [ID]