Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | n/a |
0 / 0 |
n/a |
0 / 0 |
CRAP | n/a |
0 / 0 |
|||
| 1 | <?php |
| 2 | /** |
| 3 | * |
| 4 | * This file is part of the phpBB Forum Software package. |
| 5 | * |
| 6 | * @copyright (c) phpBB Limited <https://www.phpbb.com> |
| 7 | * @license GNU General Public License, version 2 (GPL-2.0) |
| 8 | * |
| 9 | * For full copyright and license information, please see |
| 10 | * the docs/CREDITS.txt file. |
| 11 | * |
| 12 | */ |
| 13 | |
| 14 | namespace phpbb\event; |
| 15 | |
| 16 | /** |
| 17 | * Extension of the Symfony2 EventDispatcher |
| 18 | * |
| 19 | * It provides an additional `trigger_event` method, which |
| 20 | * gives some syntactic sugar for dispatching events. Instead |
| 21 | * of creating the event object, the method will do that for |
| 22 | * you. |
| 23 | * |
| 24 | * Example: |
| 25 | * |
| 26 | * $vars = array('page_title'); |
| 27 | * extract($phpbb_dispatcher->trigger_event('core.index', compact($vars))); |
| 28 | * |
| 29 | */ |
| 30 | interface dispatcher_interface extends \Symfony\Component\EventDispatcher\EventDispatcherInterface |
| 31 | { |
| 32 | /** |
| 33 | * Construct and dispatch an event |
| 34 | * |
| 35 | * @param string $eventName The event name |
| 36 | * @param array $data An array containing the variables sending with the event |
| 37 | * @return mixed |
| 38 | */ |
| 39 | public function trigger_event($eventName, $data = array()); |
| 40 | |
| 41 | /** |
| 42 | * Disable the event dispatcher. |
| 43 | */ |
| 44 | public function disable(); |
| 45 | |
| 46 | /** |
| 47 | * Enable the event dispatcher. |
| 48 | */ |
| 49 | public function enable(); |
| 50 | } |