EVENTS | The foundation of everything.

About Events

Events allow you to see everything that is happening in your application.

Events do this by allowing you to create synchronous, event-driven functional callback-response graphs in any application, by calling just two simple methods:

$events->pub($event_name) and $events->sub($event_name, $callback)

Colorful logging allows you to see what is going on in your application through your choice of standard out, text file logs, and in the near future, in-memory and sql/no-sql data stores.

Simple:

An EVENT is just an all-caps text string, with an optional colon separating the :LEVEL which can be any of the following strings, ['VERBOSE', 'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'], and an arbitrary array ['of' => $data].

Events are published through the $events->pub('EVENT:LEVEL', ['arbitrary' => $data]); function, and subscribed to with $events->sub('EVENT', function($event, $data) {...});

Testable:

You can see whether or not an event happened simply by calling $events->didOccur(['SOME', 'EVENTS'], $within_the_last_n_events); This method will return true if all of your events really did happen $within_the_last_n_events, or false otherwise.

Easy:

Every event can have unlimited callbacks bound to fire every time it is trigged. The only requirement is that the callback must take two arguments: the event name (a required string) and the event data (an optional array). Event subscriber callback return values are captured and pushed onto an array, and returned from the pub function in an array that preserves the order in which they were returned.

Fun:

Colorful logs make running your application fun to watch in standard out, log files per instance, or combined into a single master log file, or both (database event logging coming soon!).

Usage

// create an instance of events
$this->events = new Events('main', Events::DEBUG);

// subscribe to an event and trigger a callback that takes the $event and an array of optional $data
$this->events->sub('EVERYTHING_BEGINS', function(string $event, array $data = []) {
   return "$event really did happen";
});

// trigger the event, and all of it's callbacks fired in their subscribe order by publishing the event
$now = $this->events->pub('EVERYTHING_BEGINS', ['with' => 'a bang']);

// see the value of everything by publishing an event to a log level of your choice with 'EVENT:LEVEL'
$this->events->pub('RETURNED_VALUES:DEBUG', $now);

// ensure that an event really did happen within the last $n events
$did_occur = $this->events->didOccur(['RETURNED_VALUES'], 2);

Testing

composer install
phpunit