diff options
| author | Tristan Darricau <github@nicofuma.fr> | 2014-06-28 13:56:40 +0200 |
|---|---|---|
| committer | Tristan Darricau <github@nicofuma.fr> | 2014-06-28 14:35:40 +0200 |
| commit | 539eadc450c2eb6d901aa470fcbdf59e0b923fec (patch) | |
| tree | 6d817f3c3c6373ac9217cf1f1e2acb6b7442c0e9 | |
| parent | eb13b4ae28223700034ae7482ab27a6d2cdbccd1 (diff) | |
| download | forums-539eadc450c2eb6d901aa470fcbdf59e0b923fec.tar forums-539eadc450c2eb6d901aa470fcbdf59e0b923fec.tar.gz forums-539eadc450c2eb6d901aa470fcbdf59e0b923fec.tar.bz2 forums-539eadc450c2eb6d901aa470fcbdf59e0b923fec.tar.xz forums-539eadc450c2eb6d901aa470fcbdf59e0b923fec.zip | |
[ticket/12782] Add doc block
PHPBB3-12782
| -rw-r--r-- | phpBB/phpbb/event/dispatcher.php | 3 | ||||
| -rw-r--r-- | phpBB/phpbb/event/dispatcher_interface.php | 9 |
2 files changed, 11 insertions, 1 deletions
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 <https://www.phpbb.com> * @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()); } |