93 lines
2.6 KiB
PHP
93 lines
2.6 KiB
PHP
<?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;
|
|
|
|
/**
|
|
* EventDispatcherInterface describes an event dispatcher class.
|
|
*
|
|
* @see http://developer.apple.com/documentation/Cocoa/Conceptual/Notifications/index.html Apple's Cocoa framework
|
|
*
|
|
* @author Fabien Potencier <fabien@symfony.com>
|
|
*/
|
|
interface EventDispatcherInterface
|
|
{
|
|
/**
|
|
* Connects a listener to a given event name.
|
|
*
|
|
* Listeners with a higher priority are executed first.
|
|
*
|
|
* @param string $name An event name
|
|
* @param mixed $listener A PHP callable
|
|
* @param integer $priority The priority (between -10 and 10 -- defaults to 0)
|
|
*/
|
|
function connect($name, $listener, $priority = 0);
|
|
|
|
/**
|
|
* Disconnects one, or all listeners for the given event name.
|
|
*
|
|
* @param string $name An event name
|
|
* @param mixed|null $listener The listener to remove, or null to remove all
|
|
*
|
|
* @return void
|
|
*/
|
|
function disconnect($name, $listener = null);
|
|
|
|
/**
|
|
* Notifies all listeners of a given event.
|
|
*
|
|
* @param EventInterface $event An EventInterface instance
|
|
*/
|
|
function notify(EventInterface $event);
|
|
|
|
/**
|
|
* Notifies all listeners of a given event until one processes the event.
|
|
*
|
|
* A listener tells the dispatcher that it has processed the event
|
|
* by calling the setProcessed() method on it.
|
|
*
|
|
* It can then return a value that will be forwarded to the caller.
|
|
*
|
|
* @param EventInterface $event An EventInterface instance
|
|
*
|
|
* @return mixed The returned value of the listener that processed the event
|
|
*/
|
|
function notifyUntil(EventInterface $event);
|
|
|
|
/**
|
|
* Filters a value by calling all listeners of a given event.
|
|
*
|
|
* @param EventInterface $event An EventInterface instance
|
|
* @param mixed $value The value to be filtered
|
|
*
|
|
* @return mixed The filtered value
|
|
*/
|
|
function filter(EventInterface $event, $value);
|
|
|
|
/**
|
|
* Returns true if the given event name has some listeners.
|
|
*
|
|
* @param string $name The event name
|
|
*
|
|
* @return Boolean true if some listeners are connected, false otherwise
|
|
*/
|
|
function hasListeners($name);
|
|
|
|
/**
|
|
* Returns all listeners associated with a given event name.
|
|
*
|
|
* @param string $name The event name
|
|
*
|
|
* @return array An array of listeners
|
|
*/
|
|
function getListeners($name);
|
|
}
|