EventAwareInterface
Extends DispatcherAwareInterfaceInterface defining application that can trigger Joomla 3.x style events
| since |
4.0.0 |
|---|---|
| deprecated |
4.3 will be removed in 6.0 This interface will be removed without replacement as the Joomla 3.x compatibility layer will be removed |
| todo |
Move to combat plugin |
| package |
Joomla CMS |
Methods
getDispatcher
Get the event dispatcher.
getDispatcher() : \Joomla\Event\DispatcherInterface
| since |
4.0.0 |
|---|---|
| throws |
|
Response
DispatcherInterface
triggerEvent
Calls all handlers associated with an event group.
triggerEvent( eventName, array|\Joomla\Event\Event args = []) : mixed||string|int
This is a legacy method, implementing old-style (Joomla! 3.x) plugin calls. It's best to go directly through the Dispatcher and handle the returned EventInterface object instead of going through this method. This method is deprecated and will be removed in Joomla! 5.x.
This method will only return the 'result' argument of the event
| since |
4.0.0 |
|---|---|
| throws |
|
| deprecated |
4.0 will be removed in 6.0 Use the Dispatcher method instead Example: Factory::getApplication()->getDispatcher()->dispatch($eventName, $event); |
Arguments
- eventName
stringThe event name.- args
array<string|int, mixed>|EventAn array of arguments or an Event object (optional).
Response
array<string|int, mixed>An array of results from each function call. Note this will be an empty array if no dispatcher is set.