Yaffs site version 1.1
[yaffs-website] / vendor / symfony / event-dispatcher / EventSubscriberInterface.php
1 <?php
2
3 /*
4  * This file is part of the Symfony package.
5  *
6  * (c) Fabien Potencier <fabien@symfony.com>
7  *
8  * For the full copyright and license information, please view the LICENSE
9  * file that was distributed with this source code.
10  */
11
12 namespace Symfony\Component\EventDispatcher;
13
14 /**
15  * An EventSubscriber knows himself what events he is interested in.
16  * If an EventSubscriber is added to an EventDispatcherInterface, the manager invokes
17  * {@link getSubscribedEvents} and registers the subscriber as a listener for all
18  * returned events.
19  *
20  * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
21  * @author Jonathan Wage <jonwage@gmail.com>
22  * @author Roman Borschel <roman@code-factory.org>
23  * @author Bernhard Schussek <bschussek@gmail.com>
24  */
25 interface EventSubscriberInterface
26 {
27     /**
28      * Returns an array of event names this subscriber wants to listen to.
29      *
30      * The array keys are event names and the value can be:
31      *
32      *  * The method name to call (priority defaults to 0)
33      *  * An array composed of the method name to call and the priority
34      *  * An array of arrays composed of the method names to call and respective
35      *    priorities, or 0 if unset
36      *
37      * For instance:
38      *
39      *  * array('eventName' => 'methodName')
40      *  * array('eventName' => array('methodName', $priority))
41      *  * array('eventName' => array(array('methodName1', $priority), array('methodName2')))
42      *
43      * @return array The event names to listen to
44      */
45     public static function getSubscribedEvents();
46 }