Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mrkmg/phpevents

Adding events to PHP (5.4+)
https://github.com/mrkmg/phpevents

Last synced: 16 days ago
JSON representation

Adding events to PHP (5.4+)

Awesome Lists containing this project

README 

        
phpevents

=========

***phpevents is a simple trait and class to add events into PHP (5.4+).***



Concept

-------



Each class that you wish to enable events on "uses" the EventTemplate trait. That trait includes all the methods needed to set event types, bind functions the events, and fire those events.

A class defines its own events. When an event is fired, the function(s) tied to that event are ran and passed an Event Object. The Event Object contains 3 public properties: $type (Name of

the type of event), $object (the object that the event was fired on), $microtime (A float representation of the microtime the event occured), $backtrace (A snapshop of the backtrace that

caused that event to be fired). The Event Object also has one method, print_backtrace() which prints an html version of the backtrace which is very easy to understand



Usage

-----



Using phpevents is quite simple.



1. Include events.php

2. Put "use EventTemplate;" in each class you wish to enable events on

3. Define event types via one or both of the following

    - Set Event Types via the property _event_default_types, which should be an array of strings for each event type. You can set the class type as well, see the "extendedEventClass" Example

    - Somewhere in the class methods (usually __construct()), set the available event types with the private method _event_set_type(). The same as above, see the "extendedEventClass" Example

4. Bind functions to events via one or both of following

    - Bind functions to the objects event via the public method bind(), can be used in the __construct() method.

    - If you used _event_default_types, you can use _event_default_binds. _event_default_binds automatically binds events to internal methods of the class. The structure of the property is array('event_name'=>array('method1','method2'))

5. Use the public method fire() to fire an event, causing all bound functions to be ran.



Examples

--------



There are currently 4 examples/tests. They are are in the tests folder. Here is a simple breakdown of what each on is.



[defineInConstruct](https://github.com/mrkmg/phpevents/blob/master/tests/defineInConstruct/index.php)



This example/test shows how to define the event types and bind internal methods of that class to those events.



[simple](https://github.com/mrkmg/phpevents/blob/master/tests/simple/index.php)



This example/test shows how to bind both a global function and an anonymous function to an objects events.



[useOtherPrivate](https://github.com/mrkmg/phpevents/blob/master/tests/useOtherPrivate/index.php)



This example/test shows how to bind one objects events to another objects private methods



[logging](https://github.com/mrkmg/phpevents/blob/master/tests/logging/index.php)



This is a practical example of how these events could be used. This is a **very** simple example of how logging could be tied to a model object. Has been updated to make use of backtrace.



[usingDefaultTypesAndBinds](https://github.com/mrkmg/phpevents/blob/master/tests/usingDefaultTypesAndBinds/index.php)



This example outlines how to use the default types and default binds without using __construct()



[combineConstructDefaults](https://github.com/mrkmg/phpevents/blob/master/tests/combineConstructDefaults/index.php)



This example outlines how to use the default types and default binds and __construct()



[extendedEventClass](https://github.com/mrkmg/phpevents/blob/master/tests/extendedEventClass/index.php)



This example shows how to define your own event class and set it to be used for an event type.



Future

------



Everything conceptual right now, and anything and everything could be changed.



These are some planned features

- ~~Backtrace of event~~ Implemented

- ~~Custom information for each event (for example on a user model, including which database was used to retreive the information)~~ This can be done via extending the Event Class



Fixed

-----



- Fix _ _construct() issue where if using _event_default_type or _event_default_binds and _ _construct() in a class, the defaults are not populated.