PHPackages                             equip/redis-queue - 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. equip/redis-queue

AbandonedLibrary

equip/redis-queue
=================

Small library for using Redis as a job queue

0.1.0(10y ago)3181[1 PRs](https://github.com/equip/redis-queue/pulls)MITPHP

Since Jan 8Pushed 9y ago9 watchersCompare

[ Source](https://github.com/equip/redis-queue)[ Packagist](https://packagist.org/packages/equip/redis-queue)[ RSS](/packages/equip-redis-queue/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (1)Dependencies (6)Versions (3)Used By (0)

Equip Redis Queue
=================

[](#equip-redis-queue)

[![Latest Stable Version](https://camo.githubusercontent.com/1c79db673369f4bc12a86a09d344bcc50ffefc9d5d55d8160593300ada0963b6/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f65717569702f72656469732d71756575652e737667)](https://packagist.org/packages/equip/redis-queue)[![License](https://camo.githubusercontent.com/da746dc505ede215fcc249467e1585faa0ee64751bc32bbdfe191076893505f9/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f65717569702f72656469732d71756575652e737667)](https://github.com/equip/redis-queue/blob/master/LICENSE)[![Build Status](https://camo.githubusercontent.com/c375976f1a5742edcb9f4b342d10cfd03018dfea5d31ff0d4cffebe4b918e8c6/68747470733a2f2f7472617669732d63692e6f72672f65717569702f72656469732d71756575652e737667)](https://travis-ci.org/equip/redis-queue)[![Code Coverage](https://camo.githubusercontent.com/4aaf4a0ba373481ad2cc61776851248ded8bb4be72c74bcb03e8c0052b7bb516/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f65717569702f72656469732d71756575652f6261646765732f636f7665726167652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/equip/redis-queue/?branch=master)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/e68374627472c3d1105e33f1497d15e9c035edbca739d6b022b8c7d655954606/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f65717569702f72656469732d71756575652f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/equip/redis-queue/?branch=master)

A small library for using [Redis](http://redis.io) as a job queue in [Equip](http://equipframework.readthedocs.org) applications.

Installation
------------

[](#installation)

Use [Composer](https://getcomposer.org/).

```
composer require equip/redis-queue

```

[Add](http://equipframework.readthedocs.org/en/latest/#configuration) the [`DefaultConfigurationSet`](https://github.com/equip/redis-queue/blob/master/src/Configuration/DefaultConfigurationSet.php) configuration to your project.

Consuming
---------

[](#consuming)

Consumers are written as commands using [equip/command](https://github.com/equip/command). See [its documentation](http://equipframework.readthedocs.org/en/latest/commands/) for more information.

To run consumers, use a runner like the [example](https://github.com/equip/redis-queue/blob/master/bin/redis-consumer) included in this repository. This runner uses two environmental variables, `REDIS_HOST` and `REDIS_PORT`, to point to the Redis server to use; they default to `'127.0.0.1'` and `6379`, respectively. The runner takes a single required parameter: the Redis key representing the queue from which the consumer is to retrieve jobs.

```
REDIS_HOST=example.com REDIS_PORT=12345 ./bin/consume queue_name

```

Note that your runner will need to [configure](http://equipframework.readthedocs.org/en/latest/#configuration) your Auryn `Injector` instance appropriately for it to be able to create instances of your consumer command classes and their dependencies.

Publishing
----------

[](#publishing)

Jobs are published using an instance of the [`Publisher`](https://github.com/equip/redis-queue/blob/master/src/Publisher.php) class. Configuration included in [`DefaultConfigurationSet`](https://github.com/equip/redis-queue/blob/master/src/Configuration/DefaultConfigurationSet.php) should be sufficient to have Auryn generate an instance of it.

Here's an example of publishing a job from a [domain class](http://equipframework.readthedocs.org/en/latest/#domains), where `Acme\Command\FooCommand` is a command class intended to function as a consumer.

```
namespace Acme;

use Acme\Command\FooCommand;
use Equip\Adr\DomainInterface;
use Equip\RedisQueue\Publisher;

class FooDomain implements DomainInterface
{
	private $publisher;

    public function __construct(Publisher $publisher)
    {
        $this->publisher = $publisher;
    }

    public function __invoke(array $input)
    {
        // ...

        $command_options = ['foo' => 'bar'];
        $this->publisher->publish(
            'queue_name',
            FooCommand::class,
            $command_options
        );
    }
}
```

To publish a job, the `publish()` method of the `Publisher` instance is invoked with these arguments:

- The first argument is a string containing the name of the queue, which must be a valid [Redis key](http://redis.io/topics/data-types-intro#redis-keys)
- The second argument is a string containing the fully-qualified name of a command class containing the logic for the job to execute
- The third argument is an associative array of options to be used by an instance of the command class

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity14

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity54

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 77.8% 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.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

3779d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/e47a502e778d0886033c82f584d39f1d06129973a6ed687ac6b016d1eb4e92d9?d=identicon)[dolfelt](/maintainers/dolfelt)

![](https://www.gravatar.com/avatar/e195387ae46f8e34639081ffa3f077cfe7b99a1c778cd4877dfa40701f303231?d=identicon)[ameech](/maintainers/ameech)

---

Top Contributors

[![elazar](https://avatars.githubusercontent.com/u/15487?v=4)](https://github.com/elazar "elazar (7 commits)")[![shadowhand](https://avatars.githubusercontent.com/u/38203?v=4)](https://github.com/shadowhand "shadowhand (2 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/equip-redis-queue/health.svg)

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

###  Alternatives

[bagisto/bagisto

Bagisto Laravel E-Commerce

26.2k161.6k7](/packages/bagisto-bagisto)[grumpydictator/firefly-iii

Firefly III: a personal finances manager.

22.8k69.3k](/packages/grumpydictator-firefly-iii)[teamtnt/tntsearch

A fully featured full text search engine written in PHP

3.2k3.0M28](/packages/teamtnt-tntsearch)[unopim/unopim

UnoPim Laravel PIM

9.4k1.8k](/packages/unopim-unopim)[bear/package

BEAR.Sunday application framework package

30527.9k23](/packages/bear-package)[pdffiller/qless-php

PHP Bindings for qless

29113.2k1](/packages/pdffiller-qless-php)

PHPackages © 2026

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