PHPackages                             kue/kue - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Queues & Workers](/categories/queues)
4. /
5. kue/kue

ActiveLibrary[Queues & Workers](/categories/queues)

kue/kue
=======

Kue is a priority job queue backed by redis

233.1k4[5 issues](https://github.com/hfcorriez/php-kue/issues)[2 PRs](https://github.com/hfcorriez/php-kue/pulls)PHP

Since Aug 30Pushed 6y ago1 watchersCompare

[ Source](https://github.com/hfcorriez/php-kue)[ Packagist](https://packagist.org/packages/kue/kue)[ RSS](/packages/kue-kue/feed)WikiDiscussions master Synced 4w ago

READMEChangelogDependenciesVersions (1)Used By (0)

Intro
=====

[](#intro)

PHP port of [Kue](https://github.com/LearnBoost/kue/) (Node.js)

Note: `It's under develop now!`

The goal is: `Supply a simple and strong way to process the background jobs using PHP`

Install
=======

[](#install)

Add `"kue/kue": "*"` to your [composer.json](http://getcomposer.org), then:

```
composer install

```

Overview
========

[](#overview)

- [Create Queue](#create-queue)
    - [Create with config](#create-with-redis-config)
- [Node Compatible mode](#node-compatible-mode)
- [Create job](#create-job)
    - [Create priority job](#create-job-with-priority)
    - [Create timing job](#create-job-with-timing)
    - [Create delayed job](#create-job-with-delay-time)
    - [Create attempts job](#create-job-with-attempts)
- [Process job](#process-job)
    - [Process with type](#process-given-type)
    - [Process all](#process-all-types)

Usage
=====

[](#usage)

Create Queue
------------

[](#create-queue)

```
// Connect to redis "localhost:6379"
$kue = Kue::createQueue();
```

### Create with redis config

[](#create-with-redis-config)

```
// Connect "redis_server:6379" and select db to "1"
$kue = Kue::createQueue(array('host' => 'redis_server', 'db' => 1));
```

Node Compatible mode
--------------------

[](#node-compatible-mode)

In this mode, you can create job using `PHP`, and process job with `Node.js`

```
$kue = Kue::createQueue();

$kue->originalMode(true);
```

> The original mode will create job structure same as `Node.js`, The default mode change a little structure because of some reasons for simply using in PHP.

Create Job
----------

[](#create-job)

```
$kue = Kue::createQueue();

$kue->create('email', array(
    'to' => 'hfcorriez@gmail.com',
    'subject' => 'Reset your password!',
    'body' => 'Your can reset your password in 5 minutes. Url: http://xxx/reset'
))->save();
```

### Create job with priority

[](#create-job-with-priority)

Priority will decide your job process order:

```
$kue = Kue::createQueue();

$kue->create('email', array(
    'to' => 'hfcorriez@gmail.com',
    'subject' => 'Reset your password!',
    'body' => 'Your can reset your password in 5 minutes. Url: http://xxx/reset'
))->priority('high')->save();
```

\### Create job with timing

Timing will trigger job at given time, see follow examples:

```
$kue = Kue::createQueue();

$kue->create('email', array(
    'to' => 'hfcorriez@gmail.com',
    'subject' => 'Reset your password!',
    'body' => 'Your can reset your password in 5 minutes. Url: http://xxx/reset'
))->timing('tomorrow')->save();
```

Timing format is process as [PHP date and time formats](http://php.net/manual/en/datetime.formats.php), You can use:

- `Next Monday`
- `+1 days`
- `last day of next month`
- `2013-09-13 00:00:00`
- and so on..

### Create Job with delay time

[](#create-job-with-delay-time)

The follow example will delay job in 3600 seconds:

```
$kue = Kue::createQueue();

$kue->create('email', array(
    'to' => 'hfcorriez@gmail.com',
    'subject' => 'Reset your password!',
    'body' => 'Your can reset your password in 5 minutes. Url: http://xxx/reset'
))->delay(3600)->save();
```

\### Create job with attempts

When the job failed, the next example will show how to attempts:

```
$kue = Kue::createQueue();

$kue->create('email', array(
    'to' => 'hfcorriez@gmail.com',
    'subject' => 'Reset your password!',
    'body' => 'Your can reset your password in 5 minutes. Url: http://xxx/reset'
))->attempts(5)->save();
```

Process job
-----------

[](#process-job)

`Note: $kue->process is blocking`

To process the jobs, you must write a script and run as daemon:

```
$kue = Kue::createQueue();

// Process the `email` type job
$kue->on('process:email', function($job){
    // Process logic
    $data = $job->data
    mail($data['to'], $data['subject'], $data['body']);
});

// Will blocking process to subscribe the queue
$kue->process();
```

> I'll supply the daemon script and service in future.

### Process given type

[](#process-given-type)

If your want to write a script to process the given type.

```
$kue = Kue::createQueue();

// Process the `email` type job
$kue->on('process:email', function($job){
    // Process logic
    $data = $job->data
    mail($data['to'], $data['subject'], $data['body']);
});

// Process `email` type only
$kue->process('email');
```

or using `Node.js` style

```
$kue = Kue::createQueue();

// Process `email` type only
$kue->process('email', function($job){
   // Process logic
   $data = $job->data
   mail($data['to'], $data['subject'], $data['body']);
});
```

### Process all types

[](#process-all-types)

```
$kue = Kue::createQueue();

// Process all types
$kue->process(function($job){
   // Process logic
   log($job->type . ' processed');
});
```

License
=======

[](#license)

(The MIT License)

Copyright (c) 2012 hfcorriez <>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

###  Health Score

27

—

LowBetter than 47% of packages

Maintenance16

Infrequent updates — may be unmaintained

Popularity30

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/052da9fcd2d35025de486c255a8b4d38a67b2626b6ca626f6681bbc00187e62b?d=identicon)[hfcorriez](/maintainers/hfcorriez)

---

Top Contributors

[![hfcorriez](https://avatars.githubusercontent.com/u/119550?v=4)](https://github.com/hfcorriez "hfcorriez (24 commits)")

### Embed Badge

![Health badge](/badges/kue-kue/health.svg)

```
[![Health](https://phpackages.com/badges/kue-kue/health.svg)](https://phpackages.com/packages/kue-kue)
```

###  Alternatives

[league/geotools

Geo-related tools PHP 7.3+ library

1.4k5.5M30](/packages/league-geotools)[illuminate/bus

The Illuminate Bus package.

6045.5M513](/packages/illuminate-bus)[uecode/qpush-bundle

Asynchronous processing for Symfony using Push Queues

1672.5M2](/packages/uecode-qpush-bundle)[mayconbordin/l5-stomp-queue

Stomp Queue Driver for Laravel 5

121.1k](/packages/mayconbordin-l5-stomp-queue)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)