gdecris/event-ivey

Simple event and queue system with extensibility through adapters

v1.0.2 2017-10-15 12:58 UTC

Requires

• php: ^5.5.9 || ^7.0
• aws/aws-sdk-php: ^3.19
• illuminate/container: ^5.1
• predis/predis: ^1.1

Requires (Dev)

• phpunit/phpunit: ^5.5
• vlucas/phpdotenv: ^2.4

MIT

• Giovanni DeCristofaro

README

PHP Event System with queue driver support

Setup using illuminate/container

  // Register the appropriate queue
  $container->singleton(QueueContract::class, MemoryQueue::class);
  // Bind the dispatcher as a singleton
  $container->singleton(EventDispatcher::class);

Basic Usage

Listen to events

  $container->make(EventDispatcher::class)->listen('event.name', function($payload) {
    // Listener receives the payload
  });

Fire events

  $container->make(EventDispatcher::class)->fire('event.name', ['some' => 'payload data']);

Queued Listener

Registering the Listener

  $container->make(EventDispatcher::class)->listen('event.name', MyListener::class);

Listener class

  use Ivey\Events\EventListener;

  class MyListener extends EventListener 
  {
      proteceted static $should_queue = true;

      public function fire($payload)
      {
          // TODO: Implement fire() method.
      }
  }

Worker

Running the worker

  $worker = $container->make(Worker::class);
  
  
  // Sleep for 5 seconds retry a max of 3 times before failing
  $worker->setSleep(5)
      ->setTries(3)
      ->runDaemon();

Failed jobs

  // Add a listener for catching the failed jobs so you can handle them accordingly
  $container->make(EventDispatcher::class)->listen('failed.job', function ($payload) {
  
  });