Classes List

Symfony\Component\EventDispatcher\EventDispatcherInterface

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
<?php

/* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


namespace Symfony\Component\EventDispatcher;

/** * The EventDispatcherInterface is the central point of Symfony's event listener system. * Listeners are registered on the manager and events are dispatched through the * manager. * * @author Bernhard Schussek <bschussek@gmail.com> */
interface EventDispatcherInterface
{
    /** * Dispatches an event to all registered listeners. * * @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 * * @return Event */
    public function dispatch($eventNameEvent $event = null);

    /** * Adds an event listener that listens on the specified events. * * @param string $eventName The event to listen on * @param callable $listener The listener * @param int $priority The higher this value, the earlier an event * listener will be triggered in the chain (defaults to 0) */
    public function addListener($eventName$listener$priority = 0);

    /** * Adds an event subscriber. * * The subscriber is asked for all the events he is * interested in and added as a listener for these events. */
    public function addSubscriber(EventSubscriberInterface $subscriber);

    /** * Removes an event listener from the specified events. * * @param string $eventName The event to remove a listener from * @param callable $listener The listener to remove */
    public function removeListener($eventName$listener);

    public function removeSubscriber(EventSubscriberInterface $subscriber);

    /** * Gets the listeners of a specific event or all listeners sorted by descending priority. * * @param string $eventName The name of the event * * @return array The event listeners for the specified event, or all event listeners by event name */
    public function getListeners($eventName = null);

    /** * Gets the listener priority for a specific event. * * Returns null if the event or the listener does not exist. * * @param string $eventName The name of the event * @param callable $listener The listener * * @return int|null The event listener priority */
    public function getListenerPriority($eventName$listener);

    /** * Checks whether an event has any registered listeners. * * @param string $eventName The name of the event * * @return bool true if the specified event has any listeners, false otherwise */
    public function hasListeners($eventName = null);
}