Class JEventDispatcher

Class to handle dispatching of events.

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

JObject

JEventDispatcher

Direct known subclasses

JDispatcher

Package: Joomla\Platform\Event
Deprecated: 4.0 The CMS' Event classes will be replaced with the joomla/event package
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 12.1
See: JPlugin
Located at joomla/event/dispatcher.php

Methods summary

`public static JEventDispatcher`	# `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 `JEventDispatcher` - The EventDispatcher object. Since 11.1
`public mixed`	# `getState( )` Get the state of the JEventDispatcher object Get the state of the JEventDispatcher object Returns `mixed` - The state of the object. Since 11.3
`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` Since 11.1
`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. Since 11.1
`public`	# `attach( object $observer )` Attach an observer object Attach an observer object Parameters `$observer` `object` - $observer An observer object to attach Since 11.3
`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. Since 11.3

Methods inherited from JObject

__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 Since 11.3
`protected mixed`	`$_state`	# The state of the observable object The state of the observable object Since 11.3
`protected array`	`$_methods`	# A multi dimensional array of [function][] = key for observers A multi dimensional array of [function][] = key for observers Since 11.3
`protected static JEventDispatcher`	`$instance`	# Stores the singleton instance of the dispatcher. Stores the singleton instance of the dispatcher. Since 11.3

Properties inherited from JObject

$_errors

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JEventDispatcher

Direct known subclasses

Methods summary

Returns

Since

Returns

Since

Parameters

Throws

Since

Parameters

Returns

Since

Parameters

Since

Parameters

Returns

Since

Methods inherited from JObject

Magic methods summary

Properties summary

Since

Since

Since

Since

Properties inherited from JObject