|
@@ -28,8 +28,8 @@ interface EventDispatcherInterface
|
|
|
* @param string $eventName The name of the event to dispatch. The name of
|
|
|
* the event is the name of the method that is
|
|
|
* invoked on listeners.
|
|
|
- * @param Event $event The event to pass to the event handlers/listeners.
|
|
|
- * If not supplied, an empty Event instance is created.
|
|
|
+ * @param Event $event The event to pass to the event handlers/listeners.
|
|
|
+ * If not supplied, an empty Event instance is created.
|
|
|
*
|
|
|
* @api
|
|
|
*/
|
|
@@ -48,7 +48,9 @@ interface EventDispatcherInterface
|
|
|
function addListener($eventName, $listener, $priority = 0);
|
|
|
|
|
|
/**
|
|
|
- * Adds an event subscriber. The subscriber is asked for all the events he is
|
|
|
+ * Adds an event subscriber.
|
|
|
+ *
|
|
|
+ * The subscriber is asked for all the events he is
|
|
|
* interested in and added as a listener for these events.
|
|
|
*
|
|
|
* @param EventSubscriberInterface $subscriber The subscriber.
|
|
@@ -60,35 +62,33 @@ interface EventDispatcherInterface
|
|
|
/**
|
|
|
* Removes an event listener from the specified events.
|
|
|
*
|
|
|
- * @param string|array $eventName The event(s) to remove a listener from.
|
|
|
- * @param object $listener The listener object to remove.
|
|
|
+ * @param string|array $eventName The event(s) to remove a listener from
|
|
|
+ * @param callable $listener The listener to remove
|
|
|
*/
|
|
|
function removeListener($eventName, $listener);
|
|
|
|
|
|
/**
|
|
|
* Removes an event subscriber.
|
|
|
*
|
|
|
- * @param EventSubscriberInterface $subscriber The subscriber.
|
|
|
+ * @param EventSubscriberInterface $subscriber The subscriber
|
|
|
*/
|
|
|
function removeSubscriber(EventSubscriberInterface $subscriber);
|
|
|
|
|
|
/**
|
|
|
* Gets the listeners of a specific event or all listeners.
|
|
|
*
|
|
|
- * @param string $eventName The name of the event.
|
|
|
+ * @param string $eventName The name of the event
|
|
|
*
|
|
|
- * @return array The event listeners for the specified event, or all event
|
|
|
- * listeners by event name.
|
|
|
+ * @return array The event listeners for the specified event, or all event listeners by event name
|
|
|
*/
|
|
|
function getListeners($eventName = null);
|
|
|
|
|
|
/**
|
|
|
* Checks whether an event has any registered listeners.
|
|
|
*
|
|
|
- * @param string $eventName The name of the event.
|
|
|
+ * @param string $eventName The name of the event
|
|
|
*
|
|
|
- * @return Boolean TRUE if the specified event has any listeners, FALSE
|
|
|
- * otherwise.
|
|
|
+ * @return Boolean true if the specified event has any listeners, false otherwise
|
|
|
*/
|
|
|
function hasListeners($eventName = null);
|
|
|
}
|