EventDispatcherInterface
in
Event Dispatcher Interface
Table of Contents
Methods
- dispatch() : array<string|int, mixed>
- Fire event, dispatch event data to all subscribers
- registerEvent() : bool
- Add event to events db table.
- registerSubscriber() : bool
- Register event subscriber.
- subscribeCallback() : void
- Subscribe callback
Methods
dispatch()
Fire event, dispatch event data to all subscribers
public
dispatch(string $eventName[, array<string|int, mixed>|EventInterface $event = [] ][, bool $callbackOnly = false ][, string|null $extension = null ]) : array<string|int, mixed>
Parameters
- $eventName : string
- $event : array<string|int, mixed>|EventInterface = []
- $callbackOnly : bool = false
- $extension : string|null = null
Return values
array<string|int, mixed>registerEvent()
Add event to events db table.
public
registerEvent(string $name, string $title[, string|null $extension = null ][, string|null $description = null ]) : bool
Parameters
- $name : string
- $title : string
- $extension : string|null = null
- $description : string|null = null
Return values
boolregisterSubscriber()
Register event subscriber.
public
registerSubscriber(object|string $subscriber, string|null $extension) : bool
Parameters
- $subscriber : object|string
-
Subscriber class or object ref
- $extension : string|null
Return values
boolsubscribeCallback()
Subscribe callback
public
subscribeCallback(string $eventName, Closure $callback[, bool $single = false ]) : void
Parameters
- $eventName : string
- $callback : Closure
- $single : bool = false