ed-smartass/yii2-queue-worker

Adding ability to start and manage yii2-queue workers

1.0.8 2022-09-15 05:34 UTC

Requires

• yiisoft/yii2: ~2.0.14
• yiisoft/yii2-queue: ^2.0

MIT

• ed-smartass

• queue
• worker
• yii2
• queue worker

README

Adding ability to start and manage yii2-queue workers

Installation

The preferred way to install this extension is through composer.

1. Run

composer require ed-smartass/yii2-queue-worker

1. Apply migrations

php yii migrate --migrationPath=@vendor/ed-smartass/yii2-queue-worker/migrations

or add to console config and run migration

return [
    // ...
    'controllerMap' => [
        // ...
        'migrate' => [
            'class' => 'yii\console\controllers\MigrateController',
            'migrationPath' => [
                '@console/migrations', // Default migration folder
                '@vendor/ed-smartass/yii2-queue-worker/migrations'
            ]
        ]
        // ...
    ]
    // ...
];

1. Add behavior to queue config

return [
    // ...
    'components' => [
        // ...
        'queue' => [
            'class' => 'yii\queue\db\Queue',
            'mutex' => 'yii\mutex\MysqlMutex',
            // ...
            'as worker' => 'Smartass\Yii2QueueWorker\QueueWorkerBehavior'
        ]
        // ...
    ]
    // ...
];

1. Add module to your application (optional)

return [
    // ...
    'modules' => [
        // ...
        'queue-worker' => [
            'class' => 'Smartass\Yii2QueueWorker\module\Module',
            // If you want change view files just copy it from `vendor/ed-smartass/yii2-queue-worker/module/views`
            // to `@app/views/queue-worke` and set:
            // 'viewPath' => '@app/views/queue-worker'
        ]
        // ...
    ]
    // ...
];

Usage

All started workers you cant find at queue_worker table.

Manage workers (if you config module): https:://your-site.com/queue-workers.

To start worker

Yii::$app->queue->start($timeout = 3, $yiiPath = '@app/../yii', $params = '--verbose --color');

or

QueueWorkerBehavior::startComponent($component = 'queue', $timeout = 3, $yiiPath = '@app/../yii', $params = '--verbose --color');

To stop worker

Yii::$app->queue->stop($worker_id = null);

or

QueueWorkerBehavior::stopComponent($component = null, $worker_id = null, $db = 'db', $table = '{{%queue_worker}}');

If worker_id is null all workers will stop.