Class Events

Package: blesta\app\components\events
Copyright: Copyright (c) 2010, Phillips Data, Inc.
License: The Blesta License Agreement
Located at components/events/events.php

Methods summary

`public`	# `register( string $event_name, callable $callback, string $file_name = null )` Register a listener, to be notified when the event is triggered Register a listener, to be notified when the event is triggered Parameters `$event_name` `string` $event_name The name of the event to register $callback under `$callback` `callable` $callback The Class/Method or Object/Method or function to execute when the event is triggered. `$file_name` `string` $file_name The full path to the file that contains the callback, null will default to looking in COMPONENTDIR/events/default/class_name.php (where class_name is the filecase format of the callback class [e.g. ClassName])
`public`	# `unregister( string $event_name, callable $callback )` Unregisters a listener if the event has been registered. Will remove all copies of the registered event in the case that it was registered multiple times. Unregisters a listener if the event has been registered. Will remove all copies of the registered event in the case that it was registered multiple times. Parameters `$event_name` `string` $event_name The name of the event to unregister $callback from `$callback` `callable` $callback The Class/Method or Object/Method or function to unregister for the event
`public EventObject`	# `trigger( EventObject $event )` Notifies all registered listeners of the event (called in the order they were set). Notifies all registered listeners of the event (called in the order they were set). Parameters `$event` `EventObject` $event The event object to pass to the registered listeners Returns `EventObject` The event processed
`public EventObject`	# `triggerUntil( EventObject $event )` Notifies all registered listeners of the event (called in the order they were set), until one returns true, then ceases notifying all remaining listeners. Notifies all registered listeners of the event (called in the order they were set), until one returns true, then ceases notifying all remaining listeners. Parameters `$event` `EventObject` $event The event object to pass to the registered listeners Returns `EventObject` The event processed
`public array`	# `getRegistered( string $event_name )` Returns all registered listeners for the given event name Returns all registered listeners for the given event name Parameters `$event_name` `string` $event_name The name of the event to fetch registered callbacks for Returns `array` An array of registered callbacks

Magic methods summary

Properties summary

`private static array`	`$listeners`	# Holds all registered listeners Holds all registered listeners