From 539eadc450c2eb6d901aa470fcbdf59e0b923fec Mon Sep 17 00:00:00 2001 From: Tristan Darricau Date: Sat, 28 Jun 2014 13:56:40 +0200 Subject: [PATCH] [ticket/12782] Add doc block PHPBB3-12782 --- phpBB/phpbb/event/dispatcher.php | 3 +++ phpBB/phpbb/event/dispatcher_interface.php | 9 ++++++++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/phpBB/phpbb/event/dispatcher.php b/phpBB/phpbb/event/dispatcher.php index 20fb32da11..9a786022c2 100644 --- a/phpBB/phpbb/event/dispatcher.php +++ b/phpBB/phpbb/event/dispatcher.php @@ -31,6 +31,9 @@ use Symfony\Component\EventDispatcher\ContainerAwareEventDispatcher; */ class dispatcher extends ContainerAwareEventDispatcher implements dispatcher_interface { + /** + * {@inheritdoc} + */ public function trigger_event($eventName, $data = array()) { $event = new \phpbb\event\data($data); diff --git a/phpBB/phpbb/event/dispatcher_interface.php b/phpBB/phpbb/event/dispatcher_interface.php index f85047735c..50a3ef9101 100644 --- a/phpBB/phpbb/event/dispatcher_interface.php +++ b/phpBB/phpbb/event/dispatcher_interface.php @@ -3,7 +3,7 @@ * * This file is part of the phpBB Forum Software package. * -* @copyright (c) phpBB Limited +* @copyright (c) phpBB Limited * @license GNU General Public License, version 2 (GPL-2.0) * * For full copyright and license information, please see @@ -29,5 +29,12 @@ namespace phpbb\event; */ interface dispatcher_interface extends \Symfony\Component\EventDispatcher\EventDispatcherInterface { + /** + * Construct and dispatch an event + * + * @param string $eventName The event name + * @param array $data An array containing the variables sending with the event + * @return mixed + */ public function trigger_event($eventName, $data = array()); }