phasty/events

PHP events library

0.1 2015-11-18 07:45 UTC

Requires

• phasty/log: >=0.1

Requires (Dev)

• phpunit/phpunit: 4.0.*

MIT

• Dmitry Cheremnykh

• php
• events

README

Package supplies support of event handling on different kind of objects. To use this you just inherite your class from Phasty\Events\Eventable or use Phasty\Events\EventableTrait trait within you class:

class SomeCoolClass extends Phasty\Events\Eventable {
} 

$obj = new SomeCoolClass;
$obj->on("hello-event", function($event) {
    echo $event->getData();
});
$obj->trigger("hello-event", "Hello world");

Output:

Hellow world!

And more:

class Button extends Phasty\Events\Eventable {
    public function __construct() {
        $this->on("click", "sayHello");
        $this->on("click", "sayGoodbye");
    }
    protected function sayHello() {
        echo "Hello!\n";
    }
    protected function sayGoodbye() {
        echo "Bye!\n";
    }
    public function click() {
        $this->trigger("before-click");
        $this->trigger("click");
    }
}

$btn = new Button;
$btn->on("before-click", function () {
    echo "Before click handler\n";
});
$btn->click();
$btn->off("click", "sayHello");
$btn->click();

Output:

Before click handler
Hello!
Bye!
Before click handler
Bye!

USAGE

// Listen to some-event
$obj->on("some-event", /* Any PHP callback or method name of $obj class */);
// Listen to any event
$obj->on(null, /* Any PHP callback or method name of $obj class */);
// Forget all events callbacks
$obj->off();
// Forget all callbacks of "some-event" event
$obj->off("some-event");
// Forget exact callback for "some-event"
$obj->off("some-event", /* Any PHP callback or method name of $obj class */);