2011-03-13 18:03:18 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
/*
|
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
*
|
|
|
|
* This software consists of voluntary contributions made by many individuals
|
|
|
|
* and is licensed under the LGPL. For more information, see
|
|
|
|
* <http://www.doctrine-project.org>.
|
|
|
|
*/
|
|
|
|
|
|
|
|
namespace Symfony\Component\EventDispatcher;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* An EventSubscriber knows himself what events he is interested in.
|
2011-03-13 18:16:56 +00:00
|
|
|
* If an EventSubscriber is added to an EventDispatcherInterface, the manager invokes
|
2011-03-13 18:03:18 +00:00
|
|
|
* {@link getSubscribedEvents} and registers the subscriber as a listener for all
|
|
|
|
* returned events.
|
|
|
|
*
|
|
|
|
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
|
|
|
|
* @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>
|
|
|
|
*/
|
|
|
|
interface EventSubscriberInterface
|
|
|
|
{
|
|
|
|
/**
|
2011-04-06 08:31:06 +01:00
|
|
|
* Returns an array of event names this subscriber wants to listen to.
|
2011-03-13 18:03:18 +00:00
|
|
|
*
|
2011-06-14 13:40:27 +01:00
|
|
|
* 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))
|
|
|
|
*
|
2011-04-06 08:31:06 +01:00
|
|
|
* @return array The event names to listen to
|
2011-03-13 18:03:18 +00:00
|
|
|
*/
|
2011-03-17 15:08:25 +00:00
|
|
|
static function getSubscribedEvents();
|
2011-03-13 18:03:18 +00:00
|
|
|
}
|