README

PHPResqueBundle is an derivation of php-resque project https://github.com/chrisboulton/php-resque/.

This bundle supports all features from php-resque project. It's includes: workers, enqueues, fork workers, events, namespaces, etc.

Install

This project uses the composer project to install dependencies. https://github.com/composer/composer Look in the composer.json file to install the dependencies required.

How it works

Worker

To start a worker you need:

    $ php app/console resque:worker

This will start a worker for 'default' queue at 'resque' namespace with normal log output with interval of 5 seconds between interations. But, of course you can change this with optional arguments:

    --log (verbose|normal|none)
    --interval 1..n
    --forkCount 0..n (this will require a PECL module <http://pecl.php.net/package/proctitle>)
    [queue_name] separated by commas if you want to work with more than one queue.

So, if you want to work with 'mailer' and 'news_subscriptions' queues with 10 seconds of interval between interactions in a verbose output:

    $ php app/console resque:worker --log verbose --interval 10 mailer,news_subscriptions

NAMESPACE Support:

If you have the following namespaces: php, resque For 'php' namespace you have: mailer queue. For 'resque' namespace you have: news, parser, ftp queues.

To run only php namespace you should do:

    $ php app/console resque:worker "php:*"

To run only 'ftp' and 'parser' queues on "resque" namespace:

    $ php app/console resque:worker resque:ftp,parser

For more information you can run:

    $ php app/console resque:worker --help

Queue

Attach a Job at default queue

    $ php app/console resque:queue Namespace\\Of\\Class\\SomeJob

You can define which queue with optional argument [queue_name]. To put 'SomeJob' into 'mailer' queue:

    $ php app/console resque:queue Namespace\\Of\\Class\SomeJob mailer

If you use namespaces:

    $ php app/console resque:queue Namespace\\Of\\Class\SomeJob your_namespace:mailer

Attach a Job using Queue class (PHPResqueBundle\Resque namespace):

    <?php
    namespace Your\ProjectBundle\SubprojectBundle;
    use PHPResqueBundle\Resque\Queue;
    
    class MyJob {
    
        public function attach() {
            Queue::add(__CLASS__, 'default');
        }
        
        public function attachWithNamespace() {
            Queue:add(__CLASS__, 'your_namespace:news');
        }
        
        public function perform() {
            echo 'Perform !';
        }
    }

When you run MyJob->attach() method the job will be saved at 'default' queue.

Status

php-resque enable us to check a job status. In PHPResqueBundle this can be done by:

    $ php app/console resque:status 50b0568a3057c4d80641dcee6de7cca9

If you use namespaces:

    $ php app/console resque:status 50b0568a3057c4d80641dcee6de7cca9 --namespace your_namespace

NOTE: if you DO NOT provide --namespace only default namespace will be searched for job status id.

Hash status was provided when you enqueue a job.

Updating a job status

If you need to update a job status, this can be done by:

    $ php app/console resque:update [job_hash] [new_status]
    $ php app/console resque:update [job_hash] [new_status] --namespace your_namespace

Status can be checked at original php-resque project at https://github.com/chrisboulton/php-resque/

Events

With events you can perform other activities into your Job class. Actually, php-resque project has those events:

beforeFirstFork, beforeFork, afterFork, beforePerform, afterPerform, onFailure, afterEnqueue. Please, refer to php-resque project for documentation about these events.

PHPResqueBundle has an interface that enables you to use them into your classes. So, if you want to add a beforePerform event into your MyJob class:

<?php
namespace Your\ProjectBundle\SubprojectBundle;

use PHPResqueBundle\Resque\Event;

class MyJob {

    public function __construct() {
        Event::beforePerform(__CLASS__, 'doitbetter');
    }

    public static function doitbetter() {
        echo "An event was thrown !";
    }

    public function perform() {
        fwrite(STDOUT, 'My_Job Resque running on Symfony 2');
    }        
}

All the events are available in the Event class (PHPResqueBundle\Resque\Event), mapped by existing methods at runtime, which will be named as the event you wish. The arguments of these methods are always: classname (use __CLASS whenever possible) and a callback. Callbacks are anything that can be triggered by the call_user_func_array function. For more information on what may become a callback you should get on the project php-resque.

Stop an event

PHP-Resque provides a way to stop an event. In PHPResqueBundle this can be done by [event]Stop reflection method:

 <?php
 namespace Your\ProjectBundle\SubprojectBundle;

 use PHPResqueBundle\Resque\Event;

 class MyJob {

     public function __construct() {
         Event::beforePerformStop(__CLASS__, 'doNotItbetter');
     }

     public static function doNotItbetter() {
         echo "An event has gone away !";
     }

     public function perform() {
         fwrite(STDOUT, 'My_Job Resque running on Symfony 2');
     }        
 }

Suggestions are welcome. If you have trouble with PHPResqueBundle, please, open a ticket at Github Project Issue Tracker. Issues or Contributions about php-resque should be open at php-resque project https://github.com/chrisboulton/php-resque. If you'd like to contribute with code, please, send a pull request !

catch-of-the-day / php-resque-bundle

Maintainers

Details