PHPackages equip/beanstalkd-consumer - 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. [CLI & Console](/categories/cli) 4. / 5. equip/beanstalkd-consumer AbandonedLibrary[CLI & Console](/categories/cli) equip/beanstalkd-consumer ========================= Small library for writing command line beanstalkd consumers 0.2.1(10y ago)1186MITPHP Since Jan 6Pushed 10y ago9 watchersCompare [ Source](https://github.com/equip/beanstalkd-consumer)[ Packagist](https://packagist.org/packages/equip/beanstalkd-consumer)[ RSS](/packages/equip-beanstalkd-consumer/feed)WikiDiscussions master Synced 3w ago READMEChangelog (3)Dependencies (5)Versions (4)Used By (0) Equip Beanstalkd Consumer ========================= [](#equip-beanstalkd-consumer) [![Latest Stable Version](https://camo.githubusercontent.com/d9953f9611fe0c30d76ff8abeb1250acb303e2a96a2028688313ade806ef3ab0/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f65717569702f6265616e7374616c6b642d636f6e73756d65722e737667)](https://packagist.org/packages/equip/beanstalkd-consumer)[![License](https://camo.githubusercontent.com/5d75dc73c729c38c57d3bc8ff3536f8394d3d382de48121749a5f8c7b71bee7f/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f65717569702f6265616e7374616c6b642d636f6e73756d65722e737667)](https://github.com/equip/beanstalkd-consumer/blob/master/LICENSE)[![Build Status](https://camo.githubusercontent.com/9843128e1745cd0dee135c8cbeb28f08839c56e799a91dc26470abef0f20200c/68747470733a2f2f7472617669732d63692e6f72672f65717569702f6265616e7374616c6b642d636f6e73756d65722e737667)](https://travis-ci.org/equip/beanstalkd-consumer)[![Code Coverage](https://camo.githubusercontent.com/6ee553598a62a9af61069b44441ed866e759aab1aae518642b698b30adb02b60/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f65717569702f6265616e7374616c6b642d636f6e73756d65722f6261646765732f636f7665726167652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/equip/beanstalkd-consumer/?branch=master)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/b87119bbda829c3994a15fe5de38be0a6abb9c5081179c9940d47755d41b44ac/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f65717569702f6265616e7374616c6b642d636f6e73756d65722f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/equip/beanstalkd-consumer/?branch=master) A small library for writing command line [beanstalkd](http://kr.github.io/beanstalkd/) consumers in [Equip](https://github.com/equip/framework) applications. Installation ------------ [](#installation) Use [Composer](https://getcomposer.org/). ``` composer require equip/beanstalkd-consumer ``` Writing Consumers ----------------- [](#writing-consumers) A consumer is a PHP class that implements [`ConsumerInterface`](https://github.com/equip/beanstalkd-consumer/tree/master/src/ConsumerInterface.php) to process jobs received from beanstalkd, each of which is represented by an instance of the [`Job`](https://github.com/equip/beanstalkd-consumer/blob/master/src/Job.php) class. Here's an example of a consumer implementation. ``` namespace Acme; use Equip\BeanstalkConsumer\ConsumerInterface; use Equip\BeanstalkConsumer\Job; class FooConsumer implements ConsumerInterface { public function consume(Job $job) { $id = $job->getId(); $data = $job->getData(); // unserialize and process $data here } } ``` Using Consumers --------------- [](#using-consumers) To use the consumer shown in the last section, be sure its namespace is included in your [Composer autoloader](https://getcomposer.org/doc/01-basic-usage.md#autoloading), then invoke the runner as shown in the examples below. If this library is installed as a project dependency: ``` BEANSTALKD_CONSUMER="Acme\\FooConsumer" ./vendor/bin/beanstalkd-consumer ``` If this library is installed as a repository clone: ``` BEANSTALKD_CONSUMER="Acme\\FooConsumer" ./bin/beanstalkd-consumer ``` Configuration ------------- [](#configuration) These environmental variables may be used to configure the runner. - `BEANSTALKD_CONSUMER` - fully-qualified name of a PHP class implementing [`ConsumerInterface`](https://github.com/equip/beanstalkd-consumer/tree/master/src/ConsumerInterface.php) to consume jobs - `BEANSTALKD_HOST` - hostname of the beanstalkd server, defaults to `'127.0.0.1'` - `BEANSTALKD_PORT` - port on which the beanstalkd server listens, defaults to `11300` - `BEANSTALKD_TUBE` - tube from which the consumer should consume jobs, defaults to `'default'` Consumer Dependencies --------------------- [](#consumer-dependencies) By default, [Auryn](https://github.com/rdlowrey/Auryn) is used internally as a resolver to create consumer instances. As such, with some additional code, it can be used to inject dependencies into consumers as well. In order to apply any additional [configurations](http://equipframework.readthedocs.org/en/latest/#configuration) needed for consumers to the Auryn [`Injector`](https://github.com/rdlowrey/auryn/blob/master/lib/Injector.php) instance in use, a custom runner must be written. It will likely look familiar similar to the [stock runner](https://github.com/equip/beanstalkd-consumer/blob/master/bin/beanstalkd-consumer) except that, in addition to the [`DefaultConfigurationSet`](https://github.com/equip/beanstalkd-consumer/blob/master/src/Configuration/DefaultConfigurationSet.php) class that establishes a basic level of configuration for the runner, it will also apply any configurations that consumers require. This can be done using a subclass of [`ConfigurationSet`](https://github.com/equip/framework/blob/master/src/Configuration/ConfigurationSet.php) as shown in the example below. ``` namespace Acme; use Equip\BeanstalkdConsumer\Configuration\DefaultConfigurationSet; use Equip\Configuration\ConfigurationSet; class Configuration extends ConfigurationSet { public function __construct() { parent::__construct([ DefaultConfigurationSet::class, FooConfiguration::class, BarConfiguration::class, // etc. ]); } } ``` The only needed difference between the stock and custom runners would be that the class shown above is used instead of [`DefaultConfigurationSet`](https://github.com/equip/beanstalkd-consumer/blob/master/src/Configuration/DefaultConfigurationSet.php) when configuring the Auryn [`Injector`](https://github.com/rdlowrey/auryn/blob/master/lib/Injector.php) instance. ### Health Score 27 — LowBetter than 47% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity12 Limited adoption so far Community12 Small or concentrated contributor base Maturity55 Maturing project, gaining track record Bus Factor1 Top contributor holds 73.3% 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 Every ~1 days Total 3 Last Release 3820d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/e47a502e778d0886033c82f584d39f1d06129973a6ed687ac6b016d1eb4e92d9?d=identicon)[dolfelt](/maintainers/dolfelt) --- Top Contributors [![elazar](https://avatars.githubusercontent.com/u/15487?v=4)](https://github.com/elazar "elazar (11 commits)")[![shadowhand](https://avatars.githubusercontent.com/u/38203?v=4)](https://github.com/shadowhand "shadowhand (4 commits)") ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/equip-beanstalkd-consumer/health.svg) ``` [![Health](https://phpackages.com/badges/equip-beanstalkd-consumer/health.svg)](https://phpackages.com/packages/equip-beanstalkd-consumer) ``` ### Alternatives [seld/cli-prompt Allows you to prompt for user input on the command line, and optionally hide the characters they type 24726.4M22](/packages/seld-cli-prompt)[illuminate/console The Illuminate Console package. 13045.3M6.2k](/packages/illuminate-console)[bear/package BEAR.Sunday application framework package 30553.3k25](/packages/bear-package)[mikopbx/core Free PBX system for SMB based on Asterisk 5501.4k](/packages/mikopbx-core)[symfony/beanstalkd-messenger Symfony Beanstalkd Messenger Bridge 19385.0k3](/packages/symfony-beanstalkd-messenger) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)