on()
on(\Pho\Lib\Graph\Event\string $eventName, $callBack, \Pho\Lib\Graph\Event\int $priority = 100) : void
Subscribe to an event.
Parameters
\Pho\Lib\Graph\Event\string | $eventName | |
$callBack | ||
\Pho\Lib\Graph\Event\int | $priority |
Event Emitter Interface
Anything that accepts listeners and emits events should implement this interface.
Please note, this is a slightly modified version of Sabre/Event to fit with Pho-Lib-Graph's needs.
on(\Pho\Lib\Graph\Event\string $eventName, $callBack, \Pho\Lib\Graph\Event\int $priority = 100) : void
Subscribe to an event.
\Pho\Lib\Graph\Event\string | $eventName | |
$callBack | ||
\Pho\Lib\Graph\Event\int | $priority |
emit(\Pho\Lib\Graph\Event\string $eventName, array $arguments = array())
Emits an event.
This method will return true if 0 or more listeners were succesfully handled. false is returned if one of the events broke the event chain.
If the continueCallBack is specified, this callback will be called every time before the next event handler is called.
If the continueCallback returns false, event propagation stops. This allows you to use the eventEmitter as a means for listeners to implement functionality in your application, and break the event loop as soon as some condition is fulfilled.
Note that returning false from an event subscriber breaks propagation and returns false, but if the continue-callback stops propagation, this is still considered a 'successful' operation and returns true.
Lastly, if there are 5 event handlers for an event. The continueCallback will be called at most 4 times.
\Pho\Lib\Graph\Event\string | $eventName | |
array | $arguments |
listeners(\Pho\Lib\Graph\Event\string $eventName, \Pho\Lib\Graph\Event\bool $flat = false) : array<mixed,callable>
Returns the list of listeners for an event.
The list is returned as an array, and the list of events are sorted by their priority.
\Pho\Lib\Graph\Event\string | $eventName | |
\Pho\Lib\Graph\Event\bool | $flat |
removeAllListeners(\Pho\Lib\Graph\Event\string $eventName = null) : void
Removes all listeners.
If the eventName argument is specified, all listeners for that event are removed. If it is not specified, every listener for every event is removed.
\Pho\Lib\Graph\Event\string | $eventName |