cakephp/queue

Queue plugin for CakePHP

2.1.0 2023-12-06 03:58 UTC

Requires

• php: >=8.1
• cakephp/cakephp: ^5.0.0
• enqueue/simple-client: ^0.10
• psr/log: ^3.0

Requires (Dev)

• cakephp/bake: ^3.0.0
• cakephp/cakephp-codesniffer: ^5.0
• enqueue/fs: ^0.10
• phpunit/phpunit: ^10.1.0

Suggests

• cakephp/bake: Required if you want to generate jobs.
• cakephp/migrations: Needed for running the migrations necessary for using Failed Jobs.

MIT

• CakePHP Community

• queue
• cakephp

README

This is a Queue system for CakePHP.

The plugin consists of a CakePHP shell wrapper and Queueing libraries for the php-queue queue library.

Installation

You can install this plugin into your CakePHP application using Composer.

Run the following command

composer require cakephp/queue

Install the transport you wish to use. For a list of available transports, see this page. The example below is for pure-php redis:

composer require enqueue/redis predis/predis:^1

Configuration

You can load the plugin using the shell command:

bin/cake plugin load Cake/Queue

Or you can manually add the loading statement in the src/Application.php file of your application:

public function bootstrap(): void
{
    parent::bootstrap();
    $this->addPlugin('Cake/Queue');
}

Additionally, you will need to configure the default queue configuration in your config/app.php file.

Documentation

Full documentation of the plugin can be found on the CakePHP Cookbook.