Class FOFUtilsObservableDispatcher

Class to handle dispatching of events.

This is the Observable part of the Observer design pattern for the event architecture.

This class is based on JEventDispatcher as found in Joomla! 3.2.0

FOFUtilsObservableDispatcher

Direct known subclasses

FOFModelDispatcherBehavior, FOFTableDispatcherBehavior

Package: FrameworkOnFramework\utils
Copyright: Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba Ltd. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Located at fof/utils/observable/dispatcher.php

Methods summary

`public static FOFUtilsObservableDispatcher`	# `getInstance( )` Returns the global Event Dispatcher object, only creating it if it doesn't already exist. Returns the global Event Dispatcher object, only creating it if it doesn't already exist. Returns `FOFUtilsObservableDispatcher` - The EventDispatcher object.
`public mixed`	# `getState( )` Get the state of the FOFUtilsObservableDispatcher object Get the state of the FOFUtilsObservableDispatcher object Returns `mixed` - The state of the object.
`public`	# `register( string $event, string $handler )` Registers an event handler to the event dispatcher Registers an event handler to the event dispatcher Parameters `$event` `string` - $event Name of the event to register handler for `$handler` `string` - $handler Name of the event handler Throws `InvalidArgumentException`
`public array`	# `trigger( string $event, array $args = array() )` Triggers an event by dispatching arguments to all observers that handle the event and returning their return values. Triggers an event by dispatching arguments to all observers that handle the event and returning their return values. Parameters `$event` `string` - $event The event to trigger. `$args` `array` - $args An array of arguments. Returns `array` - An array of results from each function call.
`public`	# `attach( object $observer )` Attach an observer object Attach an observer object Parameters `$observer` `object` - $observer An observer object to attach
`public boolean`	# `detach( object $observer )` Detach an observer object Detach an observer object Parameters `$observer` `object` - $observer An observer object to detach. Returns `boolean` - True if the observer object was detached.

Methods inherited from FOFUtilsObject

__construct(), __toString(), def(), get(), getError(), getErrors(), getProperties(), set(), setError(), setProperties()

Magic methods summary

Properties summary

`protected array`	`$_observers`	# An array of Observer objects to notify An array of Observer objects to notify
`protected mixed`	`$_state`	# The state of the observable object The state of the observable object
`protected array`	`$_methods`	# A multi dimensional array of [function][] = key for observers A multi dimensional array of [function][] = key for observers
`protected static FOFUtilsObservableDispatcher`	`$instance`	# Stores the singleton instance of the dispatcher. Stores the singleton instance of the dispatcher.

Properties inherited from FOFUtilsObject

$_errors

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFUtilsObservableDispatcher

Direct known subclasses

Methods summary

Returns

Returns

Parameters

Throws

Parameters

Returns

Parameters

Parameters

Returns

Methods inherited from FOFUtilsObject

Magic methods summary

Properties summary

Properties inherited from FOFUtilsObject