aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/includes/event/subscriber_interface.php
blob: 081d4f02104ac6fdc3c57f207cbc8890289ab261 (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
<?php
/**
*
* @package phpBB3
* @copyright (c) Fabien Potencier <fabien@symfony.com>
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
*
*/

/**
* @ignore
*/
if (!defined('IN_PHPBB'))
{
	exit;
}

/**
 * This file has been taken from Symfony2 and adjusted for
 * phpBB's coding standards.
 */

/**
 * An EventSubscriber knows himself what events he is interested in.
 * If an EventSubscriber is added to an EventDispatcherInterface, the manager invokes
 * {@link get_subscribed_events} and registers the subscriber as a listener for all
 * returned events.
 *
 * @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 phpbb_event_subscriber_interface
{
	/**
	 * 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
	 *  * An array of arrays composed of the method names to call and respective
	 *    priorities, or 0 if unset
	 *
	 * For instance:
	 *
	 *  * array('event_name' => 'method_name')
	 *  * array('event_name' => array('method_name', $priority))
	 *  * array('event_name' => array(array('method_name1', $priority), array('method_name2'))
	 *
	 * @return array The event names to listen to
	 */
	static function get_subscribed_events();
}