<?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;

/**

 * An EventSubscriber knows himself what events he is interested in.

 * If an EventSubscriber is added to an EventDispatcherInterface, the manager invokes

 * {@link getSubscribedEvents} and registers the subscriber as a listener for all

 * returned events.

 *

 * @link    www.doctrine-project.org

 * @since   2.0

 * @author  Guilherme Blanco <guilhermeblanco@hotmail.com>

 * @author  Jonathan Wage <jonwage@gmail.com>

 * @author  Roman Borschel <roman@code-factory.org>

 * @author  Bernhard Schussek <bschussek@gmail.com>

 *

 * @api

 */

interface EventSubscriberInterface

{

    /**

     * Returns an array of event names this subscriber wants to listen to.

     *

     * The array keys are event names and the value can be:

     *

     *  * The method name to call (priority defaults to 0)

     *  * An array composed of the method name to call and the priority

     *

     * For instance:

     *

     *  * array('eventName' => 'methodName')

     *  * array('eventName' => array('methodName', $priority))

     *

     * @return array The event names to listen to

     *

     * @api

     */

    static function getSubscribedEvents();

}