diff options
Diffstat (limited to 'intern.gospeladlershof.de/vendor/pda/pheanstalk/README.md')
| -rw-r--r-- | intern.gospeladlershof.de/vendor/pda/pheanstalk/README.md | 135 |
1 files changed, 135 insertions, 0 deletions
diff --git a/intern.gospeladlershof.de/vendor/pda/pheanstalk/README.md b/intern.gospeladlershof.de/vendor/pda/pheanstalk/README.md new file mode 100644 index 0000000..845ac3c --- /dev/null +++ b/intern.gospeladlershof.de/vendor/pda/pheanstalk/README.md @@ -0,0 +1,135 @@ +Pheanstalk +========== + +[](https://travis-ci.org/pda/pheanstalk) + +Pheanstalk is a pure PHP 5.3+ client for the [beanstalkd workqueue][1]. It has +been actively developed, and used in production by many, since late 2008. + +Created by [Paul Annesley][2], Pheanstalk is rigorously unit tested and written +using encapsulated, maintainable object oriented design. Community feedback, +bug reports and patches has led to a stable 1.0 release in 2010, a 2.0 release +in 2013, and a 3.0 release in 2014. + +Pheanstalk 3.0 introduces PHP namespaces, PSR-1 and PSR-2 coding standards, +and PSR-4 autoloader standard. + +beanstalkd up to the latest version 1.4 is supported. All commands and +responses specified in the [protocol documentation][3] for beanstalkd 1.3 are +implemented. + + [1]: http://xph.us/software/beanstalkd/ + [2]: http://paul.annesley.cc/ + [3]: http://github.com/kr/beanstalkd/tree/v1.3/doc/protocol.txt?raw=true + +Installation with Composer +------------- + +Install pheanstalk as a dependency with composer: + +```bash +composer require pda/pheanstalk +``` + + +Usage Example +------------- + +```php +<?php + +// Hopefully you're using Composer autoloading. + +use Pheanstalk\Pheanstalk; + +$pheanstalk = new Pheanstalk('127.0.0.1'); + +// ---------------------------------------- +// producer (queues jobs) + +$pheanstalk + ->useTube('testtube') + ->put("job payload goes here\n"); + +// ---------------------------------------- +// worker (performs jobs) + +$job = $pheanstalk + ->watch('testtube') + ->ignore('default') + ->reserve(); + +echo $job->getData(); + +$pheanstalk->delete($job); + +// ---------------------------------------- +// check server availability + +$pheanstalk->getConnection()->isServiceListening(); // true or false + +``` + + +Running the tests +----------------- + +There is a section of the test suite which depends on a running beanstalkd +at 127.0.0.1:11300, which was previously opt-in via `--with-server`. +Since porting to PHPUnit, all tests are run at once. Feel free to submit +a pull request to rectify this. + +``` +# ensure you have Composer set up +$ wget http://getcomposer.org/composer.phar +$ php composer.phar install + +# ensure you have PHPUnit +$ composer install --dev + +$ ./vendor/bin/phpunit +PHPUnit 4.0.19 by Sebastian Bergmann. + +Configuration read from /Users/pda/code/pheanstalk/phpunit.xml.dist + +................................................................. 65 / 83 ( 78%) +.................. + +Time: 239 ms, Memory: 6.00Mb + +OK (83 tests, 378 assertions) +``` + + +Contributors +------------ + + * [Paul Annesley](https://github.com/pda) + * [Lachlan Donald](https://github.com/lox) + * [Joakim Bick](https://github.com/minimoe) + * [Vyacheslav](https://github.com/SlNPacifist) + * [leprechaun](https://github.com/leprechaun) + * [Peter McArthur](https://github.com/ptrmcrthr) + * [robbiehudson](https://github.com/robbiehudson) + * [Geoff Catlin](https://github.com/gcatlin) + * [Steven Lewis](https://github.com/srjlewis) + * [Lars Yencken](https://github.com/larsyencken) + * [Josh Butts](https://github.com/jimbojsb) + * [Henry Smith](https://github.com/h2s) + * [Javier Spagnoletti](https://github.com/phansys) + * [Graham Campbell](https://github.com/GrahamCampbell) + * [Thomas Tourlourat](https://github.com/armetiz) + * [Matthieu Napoli](https://github.com/mnapoli) + * [Christoph](https://github.com/xrstf) + * [James Hamilton](https://github.com/mrjameshamilton) + * [Hannes Van De Vreken](https://github.com/hannesvdvreken) + * [Yaniv Davidovitch](https://github.com/YanivD) + * .. [more?](https://github.com/pda/pheanstalk/contributors) Let me know if you're missing. + + +License +------- + +© Paul Annesley + +Released under the [The MIT License](http://www.opensource.org/licenses/mit-license.php) |