cakephp-enqueue/docs/index.md at master · CakeDC/cakephp-enqueue

Home

The CakePHP Enqueue plugin provides message queue integration for CakePHP applications and uses database as a message broker.

Quick Start

  1. Install the plugin:
   composer require cakedc/cakephp-enqueue
  1. Load the plugin in your Application.php:
   $this->addPlugin('CakephpEnqueue');
  1. Configure your queue in config/app.php:
   'Queue' => [
       'default' => [
           'url' => 'cakephp://default?table_name=queue'
       ]
   ]
  1. Create a job:
    use App\Job\ExampleJob;
    use Cake\Queue\QueueManager;

    $data = ['id' => 7, 'is_premium' => true];
    $options = ['config' => 'default'];

    QueueManager::push(ExampleJob::class, $data, $options);
  1. Process jobs:

DSN Configuration

The plugin supports standard DSN format:

  • cakephp://connection_name?table_name=queue&polling_interval=1000