blob: 0a4881b3ba9502a15e131df834df29bf94d9a7d4 (
plain)
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
95
96
|
<?php
/**
*
* @package phpBB3
* @copyright (c) 2011 phpBB Group
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
*
*/
/**
* @ignore
*/
if (!defined('IN_PHPBB'))
{
exit;
}
/**
* 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 phpbb_event_dispatcher_interface
{
/**
* Dispatches an event to all registered listeners.
*
* @param string $event_name 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.
*
* @api
*/
function dispatch($event_name, phpbb_event $event = null);
/**
* Adds an event listener that listens on the specified events.
*
* @param string $event_name The event to listen on
* @param callable $listener The listener
* @param integer $priority The higher this value, the earlier an event
* listener will be triggered in the chain (defaults to 0)
*
* @api
*/
function add_listener($event_name, $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.
*
* @param EventSubscriberInterface $subscriber The subscriber.
*
* @api
*/
function add_subscriber(phpbb_event_subscriber_interface $subscriber);
/**
* Removes an event listener from the specified events.
*
* @param string|array $event_name The event(s) to remove a listener from.
* @param object $listener The listener object to remove.
*/
function remove_listener($event_name, $listener);
/**
* Removes an event subscriber.
*
* @param EventSubscriberInterface $subscriber The subscriber.
*/
function remove_subscriber(phpbb_event_subscriber_interface $subscriber);
/**
* Gets the listeners of a specific event or all listeners.
*
* @param string $event_name The name of the event.
*
* @return array The event listeners for the specified event, or all event
* listeners by event name.
*/
function get_listeners($event_name = null);
/**
* Checks whether an event has any registered listeners.
*
* @param string $event_name The name of the event.
*
* @return Boolean TRUE if the specified event has any listeners, FALSE
* otherwise.
*/
function has_listeners($event_name = null);
}
|
