Universal PHP Event System: Manage events with the Observer/Publisher patterns

Recommend this page to a friend!

Download

Info

Example

Files

Install with Composer

Download

Reputation

Support forum

Blog

Links

Ratings				Unique User Downloads		Download Rankings
Not enough user ratings				Total: 279		All time: 7,628 This week: 49

Version		License		PHP version		Categories
`falcraft-event` 1.0		MIT/X Consortium ...		5.3		PHP 5, Language, Design Patterns

Description

Author

Asher Wolfstein

This package can manage events with the Observer and Publisher design patterns.

It provides generic base classes that should be extended to create objects that observe and process events of interest, as well objects that define events to be processed by the observer classes.

Events can be processed by multiple observers and observers can listed to different types of events.

Asher Wolfstein

Performance

Level

Level 4

Innovation award

Nominee: 5x

Example


<?php



require_once( __DIR__ . '/../../Event/Actor.php' );

require_once( __DIR__ . '/../../Event/Filter.php' );

require_once( __DIR__ . '/../../Event/Handler.php' );

require_once( __DIR__ . '/../../Event/GenericEvent.php' );

require_once( __DIR__ . '/../../Patterns/Publisher.php' );



use Falcraft\Event;

use Falcraft\Patterns;



echo "Falcraft\\Event\\Actor.php Test\n";

echo "-----------------------------\n\n";



echo "Basic Instantiation -- \n\n";



$success = true;



$handler = $filter = $event1 = $event2 = $publisher = $actor = null;



try {

    echo "    Instantiate Handler With Closure -> ";

    $handler = new Event\Handler(

        null,

        function($e){echo "Inside Closure";},

        null,

        Event\Handler::DEFAULT_PRIORITY,

        array('strict' => true)

    );

    

    echo $handler ? "Success!\n" : "Failure...\n";

    

    echo "    Instantiate Filter (filter => tag1) -> ";

    $filter = new Event\Filter();

    $filter->setState(array('tags' => array('tag1',),));

    

    echo $filter ? "Success!\n" : "Failure...\n";

    

    echo "    Instantiate Generic Events (Event1 => tag1) -> ";

    $event1 = new Event\GenericEvent(

        null,

        null,

        null,

        null,

        null,

        array('tag1')

    );

    

    $event2 = new Event\GenericEvent(null, null, null, null);

    

    echo ($event1 && $event2) ? "Success!\n" : "Failure...\n";

    

    echo "    Instantiate Publisher -> ";

    $publisher = new Patterns\Publisher();

    

    echo $publisher ? "Success!\n" : "Failure...\n";

    

    echo "    Instantiate Actor ( filter, handler, publisher ) -> ";

    $actor = new Event\Actor($filter, $handler, $publisher);

    

    echo $actor ? "Success!\n" : "Failure...\n";

    

} catch (\Exception $e) {

    $success = false;

}



if (!$success) {

    echo "EXCEPTION RAISED\n";

}



echo "\nBasic Operations -- \n\n";



$success = true;



try {

    echo "    Fire Event1 -> ";

    $publisher->setState($event1);

} catch (\Exception $e) {

    $success = false;

}



if (!$success) {

    echo "EXCEPTION RAISED\n";

}



$success = true;



try {

    echo "\n    Fire Event2 -> ";

    $publisher->setState($event2);

} catch (\Exception $e) {

    $success = false;

}



if (!$success) {

    echo "EXCEPTION RAISED\n";

}



echo "\n";

Files (28)

File	Role	Description
`Falcraft` (1 file, 3 directories)

File	Role	Description
`Event` (8 files, 2 directories)
`examples` (1 directory)
`Patterns` (2 files, 1 directory)
`falcraftLoad.php`	Aux.	Script Loader

File	Role	Description
`Exception` (2 files)
`Resource` (4 files)
`Actor.php`	Class	Bind event to execution
`Aggregator.php`	Class	Aggregate Publishers (Observers)
`Conduit.php`	Class	Multiple Publishers and Observers
`Filter.php`	Class	An event predicate (filter)
`GenericEvent.php`	Class	Generic (Suggested) Event Object
`Handler.php`	Class	Event Handler
`HandlerPriorityQueue.php`	Class	A Priority Queue of Observers
`Tracker.php`	Class	Event Manager Class

File	Role	Description
`ExceptionInterface.php`	Class	Local Exception Interface
`InvalidArgumentException.php`	Class	Local Invalid Argument Exception

File	Role	Description
`AbstractEvent.php`	Class	Basic generic suggested event
`AwareInterface.php`	Class	Interface for event aware objects
`FilterInterface.php`	Class	An event filter (predicate)
`TrackerInterface.php`	Class	The interface for an event manager

File	Role	Description
`Event` (8 files)

File	Role	Description
`Actor.php`	Example	Event Actor (Binder) Example
`Aggregator.php`	Example	Event Aggregator Example
`Conduit.php`	Example	Event Conduit Example
`Filter.php`	Example	Event Filter Example
`GenericEvent.php`	Example	Generic Event Example
`Handler.php`	Example	Handler Example
`HandlerPriorityQueue.php`	Example	Handler Priority Queue Example
`Tracker.php`	Example	Tracker Example

File	Role	Description
`Resource` (3 files)
`Observer.php`	Class	Observer Pattern Class
`Publisher.php`	Class	Publisher Pattern Class

File	Role	Description
`ObserverInterface.php`	Class	Observer Pattern Interface
`PublisherInterface.php`	Class	Publisher Interface
`StateInterface.php`	Class	Object State Representation

The PHP Classes site has supported package installation using the Composer tool since 2013, as you may verify by reading this instructions page.

Install with Composer

	falcraft-event-2015-10-19.zip 44KB
	falcraft-event-2015-10-19.tar.gz 25KB
	Install with Composer

Needed packages

Class	Download	Why it is needed	Dependency
PHP Configuration Trait	.zip .tar.gz	For configuring the objects	Required
Abstract Data Types	.zip .tar.gz	Makes up part of objects (like Map)	Required