JDispatcher
Extends \JObjectClass to handle dispatching of events.
This is the Observable part of the Observer design pattern for the event architecture.
| package |
Joomla.Platform |
|---|---|
| subpackage |
Event |
| link |
Plugin tutorials |
| see | \JPlugin |
| since |
11.1 |
Methods
__construct
Class constructor, overridden in descendant classes.
__construct(mixed $properties = null)
| since |
11.1 |
|---|
Arguments
- $properties
mixedEither and associative array or another object to set the initial properties of the object.
__toString
Magic method to convert the object to a string gracefully.
__toString() : string
| since |
11.1 |
|---|---|
| deprecated |
12.3 Classes should provide their own __toString() implementation. |
Response
stringThe classname.
attach
Attach an observer object
attach(object $observer) : void
| since |
11.3 |
|---|
Arguments
- $observer
objectAn observer object to attach
def
Sets a default value if not alreay assigned
def(string $property, mixed $default = null) : mixed
| since |
11.1 |
|---|
Arguments
- $property
stringThe name of the property.- $default
mixedThe default value.
Response
mixed
detach
Detach an observer object
detach(object $observer) : boolean
| since |
11.3 |
|---|
Arguments
- $observer
objectAn observer object to detach.
Response
booleanTrue if the observer object was detached.
get
Returns a property of the object or the default value if the property is not set.
get(string $property, mixed $default = null) : mixed
| since |
11.1 |
|---|---|
| see | \JObject::getProperties() |
Arguments
- $property
stringThe name of the property.- $default
mixedThe default value.
Response
mixedThe value of the property.
getError
Get the most recent error message.
getError(integer $i = null, boolean $toString = true) : string
| since |
11.1 |
|---|---|
| see | \JError |
| deprecated |
12.3 JError has been deprecated |
Arguments
- $i
integerOption error index.- $toString
booleanIndicates if JError objects should return their error message.
Response
stringError message
getErrors
Return all errors, if any.
getErrors() : array
| since |
11.1 |
|---|---|
| see | \JError |
| deprecated |
12.3 JError has been deprecated |
Response
arrayArray of error messages or JErrors.
getInstance
Returns the global Event Dispatcher object, only creating it if it doesn't already exist.
getInstance() : \JDispatcher
getProperties
Returns an associative array of object properties.
getProperties(boolean $public = true) : array
| since |
11.1 |
|---|---|
| see | \JObject::get() |
Arguments
- $public
booleanIf true, returns only the public properties.
Response
array
getState
Get the state of the JDispatcher object
getState() : mixed
| since |
11.3 |
|---|
Response
mixedThe state of the object.
register
Registers an event handler to the event dispatcher
register(string $event, string $handler) : void
| since |
11.1 |
|---|
Arguments
- $event
stringName of the event to register handler for- $handler
stringName of the event handler
set
Modifies a property of the object, creating it if it does not already exist.
set(string $property, mixed $value = null) : mixed
| since |
11.1 |
|---|
Arguments
- $property
stringThe name of the property.- $value
mixedThe value of the property to set.
Response
mixedPrevious value of the property.
setError
Add an error message.
setError(string $error) : void
| since |
11.1 |
|---|---|
| see | \JError |
| deprecated |
12.3 JError has been deprecated |
Arguments
- $error
stringError message.
setProperties
Set the object properties based on a named array/hash.
setProperties(mixed $properties) : boolean
| since |
11.1 |
|---|---|
| see | \JObject::set() |
Arguments
- $properties
mixedEither an associative array or another object.
Response
boolean
toString
Converts the object to a string (the class name).
toString() : string
trigger
Triggers an event by dispatching arguments to all observers that handle the event and returning their return values.
trigger(string $event, array $args = array()) : array
| since |
11.1 |
|---|
Arguments
- $event
stringThe event to trigger.- $args
arrayAn array of arguments.
Response
arrayAn array of results from each function call.
Properties
_observers
An array of Observer objects to notify
| since |
11.3 |
|---|
Type(s)
array
_state
The state of the observable object
| since |
11.3 |
|---|
Type(s)
mixed
_methods
A multi dimensional array of [function][] = key for observers
| since |
11.3 |
|---|
Type(s)
array
_errors
An array of error messages or Exception objects.