Login   Register  
PHP Classes
elePHPant
Icontem

File: README.md

Recommend this page to a friend!
Stumble It! Stumble It! Bookmark in del.icio.us Bookmark in del.icio.us
  Classes of AlexanderC  >  Events  >  README.md  >  Download  
File: README.md
Role: Auxiliary data
Content type: text/plain
Description: Auxiliary data
Class: Events
Register and dispatch events
Author: By
Last change:
Date: 2012-10-12 16:06
Size: 1,782 bytes
 

Contents

Class file image Download
A simple but efficient way to deal with events.
[?] Why do we need events? 
[!] EDP(http://en.wikipedia.org/wiki/Event-driven_programming)- it's an must be in parralel computations, but also a good way to add callbacks to any system/kernel thing we have to deal with.

The PHP most important changes are already here: closures and traits helps us to make impossible things.

This small event library is intendet to offer an KIS-y and cleany way to handle all your events using advanced PHP 5.4 and higher features

Each event should be first registered, ex.:

    $eventsFactory = new Events\Factory::getInstance();
    $eventsFactory->addEvent('test');
    $eventsFactory->addEvent('test');
    $event = $eventsFactory->getEvent('test');

Now you can add event handlers. Basicaly every event is an object that holds all it's handlers, data and state.
In any time you can stop the event propagnation by calling $event->stopPropagnation(). It's an efficient way to stop propagnation
while PHP works in blocking mode. Observers are stored in an priority queue(used \SplPriorityQueue container).
Observer can be also provided without any priority and it will be called in an logic way by the object fire method.
Store an observer:

    $event->addObserver($callback); // first event registered in this way has priority 0, each after an decremented one[see __getMinDecrementValueBasedOnIniPrecision()]
    // or with priority
    $event->addObserver($callback, PHP_INT_MAX);

The event is fired very simple:

    $event->fire($data);
    // or even so
    $eventsFactory->fire($eventName, $data);

Event object can hold any property while they are generated by the Propertable trait methods(basicaly get|set used).
Initial provided data is stored in $data property of the event object.