https://github.com/cakephp/queue

A queue-interop compatible Queueing library
https://github.com/cakephp/queue

cakephp cakephp-plugin queue queue-interop queueing

Last synced: 5 months ago
JSON representation

A queue-interop compatible Queueing library

• Host: GitHub
• URL: https://github.com/cakephp/queue
• Owner: cakephp
• License: mit
• Created: 2019-12-01T01:34:26.000Z (over 5 years ago)
• Default Branch: 1.x
• Last Pushed: 2024-10-07T02:45:52.000Z (6 months ago)
• Last Synced: 2024-10-14T07:53:38.548Z (6 months ago)
• Topics: cakephp, cakephp-plugin, queue, queue-interop, queueing
• Language: PHP
• Homepage:
• Size: 375 KB
• Stars: 37
• Watchers: 21
• Forks: 19
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-cakephp - Queue plugin - CakePHP core queue system for the [php-queue](https://php-enqueue.github.io) queue library. (Queue)

README

        
# Queue plugin for CakePHP

![Build Status](https://github.com/cakephp/queue/actions/workflows/ci.yml/badge.svg?branch=master)

[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.txt)

[![Coverage Status](https://img.shields.io/codecov/c/github/cakephp/queue/master.svg?style=flat-square)](https://codecov.io/github/cakephp/queue?branch=master)

[![Total Downloads](https://img.shields.io/packagist/dt/cakephp/queue.svg?style=flat-square)](https://packagist.org/packages/cakephp/queue)

This is a Queue system for CakePHP.

The plugin consists of a CakePHP shell wrapper and Queueing libraries for the [php-queue](https://php-enqueue.github.io) queue library.

## Installation

You can install this plugin into your CakePHP application using [Composer](https://getcomposer.org).

Run the following command

```sh

composer require cakephp/queue

 ```

Install the transport you wish to use. For a list of available transports, see [this page](https://php-enqueue.github.io/transport). The example below is for pure-php redis:

```shell

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:

```php

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](https://book.cakephp.org/queue/1/).