Merge pull request #2672 from Nicofuma/ticket/12782

[ticket/12782] Use an interface for the phpbb event_dispatcher

* Nicofuma/ticket/12782:
  [ticket/12782] Add doc block
  [ticket/12782] Use an interface for the phpbb event_dispatcher

phpBB/phpbb/event/dispatcher.php

@@ -29,8 +29,11 @@
 *     extract($phpbb_dispatcher->trigger_event('core.index', compact($vars)));
 *
 */
-class dispatcher extends ContainerAwareEventDispatcher
+class dispatcher extends ContainerAwareEventDispatcher implements dispatcher_interface
 {
+	/**
+	* {@inheritdoc}
+	*/
 	public function trigger_event($eventName, $data = array())
 	{
 		$event = new \phpbb\event\data($data);

phpBB/phpbb/event/dispatcher_interface.php

@@ -0,0 +1,40 @@
+<?php
+/**
+*
+* This file is part of the phpBB Forum Software package.
+*
+* @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
+* the docs/CREDITS.txt file.
+*
+*/
+
+namespace phpbb\event;
+
+/**
+* Extension of the Symfony2 EventDispatcher
+*
+* It provides an additional `trigger_event` method, which
+* gives some syntactic sugar for dispatching events. Instead
+* of creating the event object, the method will do that for
+* you.
+*
+* Example:
+*
+* $vars = array('page_title');
+* extract($phpbb_dispatcher->trigger_event('core.index', compact($vars)));
+*
+*/
+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());
+}

phpBB/phpbb/log/log.php

@@ -70,7 +70,7 @@ class log implements \phpbb\log\log_interface
 
 	/**
 	* Event dispatcher object
-	* @var \phpbb\event\dispatcher
+	* @var \phpbb\event\dispatcher_interface
 	*/
 	protected $dispatcher;
 
@@ -98,7 +98,7 @@ class log implements \phpbb\log\log_interface
 	* @param	\phpbb\db\driver\driver_interface	$db		Database object
 	* @param	\phpbb\user		$user	User object
 	* @param	\phpbb\auth\auth		$auth	Auth object
-	* @param	\phpbb\event\dispatcher	$phpbb_dispatcher	Event dispatcher
+	* @param	\phpbb\event\dispatcher_interface	$phpbb_dispatcher	Event dispatcher
 	* @param	string		$phpbb_root_path		Root path
 	* @param	string		$relative_admin_path	Relative admin root path
 	* @param	string		$php_ext			PHP Extension

phpBB/phpbb/permissions.php

@@ -17,7 +17,7 @@ class permissions
 {
 	/**
 	* Event dispatcher object
-	* @var \phpbb\event\dispatcher
+	* @var \phpbb\event\dispatcher_interface
 	*/
 	protected $dispatcher;
 
@@ -30,10 +30,10 @@ class permissions
 	/**
 	* Constructor
 	*
-	* @param	\phpbb\event\dispatcher	$phpbb_dispatcher	Event dispatcher
+	* @param	\phpbb\event\dispatcher_interface	$phpbb_dispatcher	Event dispatcher
 	* @param	\phpbb\user				$user				User Object
 	*/
-	public function __construct(\phpbb\event\dispatcher $phpbb_dispatcher, \phpbb\user $user)
+	public function __construct(\phpbb\event\dispatcher_interface $phpbb_dispatcher, \phpbb\user $user)
 	{
 		$this->dispatcher = $phpbb_dispatcher;
 		$this->user = $user;

phpBB/phpbb/profilefields/manager.php

@@ -32,7 +32,7 @@ class manager
 
 	/**
 	* Event dispatcher object
-	* @var \phpbb\event\dispatcher
+	* @var \phpbb\event\dispatcher_interface
 	*/
 	protected $dispatcher;
 
@@ -73,7 +73,7 @@ class manager
 	*
 	* @param	\phpbb\auth\auth			$auth		Auth object
 	* @param	\phpbb\db\driver\driver_interface	$db			Database object
-	* @param	\phpbb\event\dispatcher		$dispatcher	Event dispatcher object
+	* @param	\phpbb\event\dispatcher_interface		$dispatcher	Event dispatcher object
 	* @param	\phpbb\request\request		$request	Request object
 	* @param	\phpbb\template\template	$template	Template object
 	* @param	\phpbb\di\service_collection $type_collection
@@ -82,7 +82,7 @@ class manager
 	* @param	string				$fields_language_table
 	* @param	string				$fields_data_table
 	*/
-	public function __construct(\phpbb\auth\auth $auth, \phpbb\db\driver\driver_interface $db, \phpbb\event\dispatcher $dispatcher, \phpbb\request\request $request, \phpbb\template\template $template, \phpbb\di\service_collection $type_collection, \phpbb\user $user, $fields_table, $fields_language_table, $fields_data_table)
+	public function __construct(\phpbb\auth\auth $auth, \phpbb\db\driver\driver_interface $db, \phpbb\event\dispatcher_interface $dispatcher, \phpbb\request\request $request, \phpbb\template\template $template, \phpbb\di\service_collection $type_collection, \phpbb\user $user, $fields_table, $fields_language_table, $fields_data_table)
 	{
 		$this->auth = $auth;
 		$this->db = $db;