Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/php-bundles/queue-bundle
Symfony Queue Bundle
https://github.com/php-bundles/queue-bundle
php queue redis symfony symfony-bundle
Last synced: 7 days ago
JSON representation
Symfony Queue Bundle
- Host: GitHub
- URL: https://github.com/php-bundles/queue-bundle
- Owner: php-bundles
- License: mit
- Created: 2016-05-21T19:28:25.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-10-18T01:13:46.000Z (about 7 years ago)
- Last Synced: 2024-08-08T02:17:43.971Z (3 months ago)
- Topics: php, queue, redis, symfony, symfony-bundle
- Language: PHP
- Homepage:
- Size: 39.1 KB
- Stars: 31
- Watchers: 8
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
SymfonyBundlesQueueBundle
=========================
[![SensioLabsInsight][sensiolabs-insight-image]][sensiolabs-insight-link]
[![Build Status][testing-image]][testing-link]
[![Scrutinizer Code Quality][scrutinizer-code-quality-image]][scrutinizer-code-quality-link]
[![Code Coverage][code-coverage-image]][code-coverage-link]
[![Total Downloads][downloads-image]][package-link]
[![Latest Stable Version][stable-image]][package-link]
[![License][license-image]][license-link]
Installation
------------
* Require the bundle with composer:
``` bash
composer require symfony-bundles/queue-bundle
```
* Enable the bundle in the kernel:
``` php
public function registerBundles()
{
$bundles = [
// ...
new SymfonyBundles\QueueBundle\SymfonyBundlesQueueBundle(),
// ...
];
...
}
```
* Configure the queue bundle in your config.yml.
Defaults configuration:
``` yml
sb_queue:
service:
alias: 'queue' # alias for service `sb_queue` (e.g. $this->get('queue'))
class: 'SymfonyBundles\QueueBundle\Service\Queue'
storage: 'redis' # storage key from `queue.storages` section
settings:
queue_default_name: 'queue:default' # default name for queue
storages:
redis:
class: 'SymfonyBundles\QueueBundle\Service\Storage\RedisStorage'
client: 'sb_redis.client.default' # storage client service id
```
* Configure the redis client in your config.yml. Read more about [RedisBundle configuration][redis-bundle-link].
How to use
----------
A simple example of the use of the queue:
``` php
$queue = $this->get('sb_queue'); // get the service
// or use: $this->get('queue'); the `queue` service use as alias,
// which setting in config.yml in parameter `sb_queue.service.alias`
// adding some data to queue
$queue->push('User "demo" registered');
$queue->push(1234567890);
$queue->push(new \stdClass);
// get count of items from queue
$queue->count(); // returns integer: 3
```
``` php
// now, we can get the data at any time in the queue order
// get data from queue
$queue->pop(); // returns string: User "demo" registered
$queue->count(); // returns integer: 2
$queue->pop(); // returns integer: 1234567890
$queue->count(); // returns integer: 1
$queue->pop(); // returns object: object(stdClass)
$queue->count(); // returns integer: 0
```
If you want to change the queue:
```
// adding data to queue `notifications`
$queue->setName('application:notifications');
$queue->push('You have a new message from Jessica');
// adding data to queue `settings`
$queue->setName('account:settings');
$queue->push('User with ID 123 changed password');
// adding data to default queue
$queue->setName('queue:default');
$queue->push('To be or not to be');
```
[package-link]: https://packagist.org/packages/symfony-bundles/queue-bundle
[license-link]: https://github.com/symfony-bundles/queue-bundle/blob/master/LICENSE
[license-image]: https://poser.pugx.org/symfony-bundles/queue-bundle/license
[testing-link]: https://travis-ci.org/symfony-bundles/queue-bundle
[testing-image]: https://travis-ci.org/symfony-bundles/queue-bundle.svg?branch=master
[stable-image]: https://poser.pugx.org/symfony-bundles/queue-bundle/v/stable
[downloads-image]: https://poser.pugx.org/symfony-bundles/queue-bundle/downloads
[sensiolabs-insight-link]: https://insight.sensiolabs.com/projects/e288c87f-ddf0-4a1c-81c5-5a7f86ab3351
[sensiolabs-insight-image]: https://insight.sensiolabs.com/projects/e288c87f-ddf0-4a1c-81c5-5a7f86ab3351/big.png
[code-coverage-link]: https://scrutinizer-ci.com/g/symfony-bundles/queue-bundle/?branch=master
[code-coverage-image]: https://scrutinizer-ci.com/g/symfony-bundles/queue-bundle/badges/coverage.png?b=master
[scrutinizer-code-quality-link]: https://scrutinizer-ci.com/g/symfony-bundles/queue-bundle/?branch=master
[scrutinizer-code-quality-image]: https://scrutinizer-ci.com/g/symfony-bundles/queue-bundle/badges/quality-score.png?b=master
[redis-bundle-link]: https://github.com/symfony-bundles/redis-bundle#installation