romeoz/rock-events

A simple implementation of Pub/Sub for PHP

Implementation of Publisher-Subscriber for PHP

, _(*1)

Features

• Handler can be a closure, instance, and static class
• Standalone module/component for Rock Framework

Installation

From the Command Line:, _(*2)

composer require romeoz/rock-events

In your composer.json:, _(*3)

{
    "require": {
        "romeoz/rock-events": "*"
    }
}

Quick Start

use rock\events\Event;

class Foo 
{
    public $str = 'Rock!';
}

$object = new Foo();
$eventName = 'onAfter';
$handler = function (Event $event) {
    echo "Hello {$event->owner->str}"; 
};

Event::on($object, $eventName, $handler);

Event::trigger($object,  'onAfter'); // output: Hello Rock!

Documentation

on(string|object $class, string $name, callable $handler)

To subscribe to the event., _(*4)

Set a handler can be as follows:, _(*5)

$handler = function (Event $event) { 
    echo "Hello Rock!"; 
};
Event::on(new Foo, 'onAfter', $handler);

Options:, _(*6)

• function (Event $event) { ... }
• [new Foo, 'method']
• ['Foo', 'static_method']

trigger(string|object $class, string $name, Event $event = null)

To publish event., _(*7)

Event::trigger(new Foo,  'onEvent'); 

// or

Event::trigger('test\Foo',  'onEvent');

off(string|object $class, string $name, callable $handler = null)

Detach event., _(*8)

$handler = 
    function (Event $event) {
        echo 'Hello Rock!'
    };
$instance =  new Foo;
Event::on($instance, 'onAfter', $handler);

Event::off($instance, 'onAfter');

Requirements

• PHP 5.4+

License

The Rock Events is open-sourced software licensed under the MIT license., _(*9)