[ticket/11768] Added core.text_formatter_s9e_renderer_setup event

PHPBB3-11768

phpBB/config/default/container/services_text_formatter.yml

@@ -52,6 +52,7 @@ services:
             - %text_formatter.cache.dir%
             - %text_formatter.cache.renderer.key%
             - @text_formatter.s9e.factory
+            - @dispatcher
         calls:
             - [configure_smilies_path, [@config, @path_helper]]
             - [configure_user, [@user, @config, @auth]]

phpBB/phpbb/textformatter/s9e/renderer.php

@@ -23,6 +23,11 @@ class renderer implements \phpbb\textformatter\renderer_interface
 	*/
 	protected $censor;
 
+	/**
+	* @var \phpbb\event\dispatcher_interface
+	*/
+	protected $dispatcher;
+
 	/**
 	* @var \s9e\TextFormatter\Renderer
 	*/
@@ -55,8 +60,9 @@ class renderer implements \phpbb\textformatter\renderer_interface
 	* @param string $cache_dir Path to the cache dir
 	* @param string $key Cache key
 	* @param factory $factory
+	* @param \phpbb\event\dispatcher_interface $dispatcher
 	*/
-	public function __construct(\phpbb\cache\driver\driver_interface $cache, $cache_dir, $key, factory $factory)
+	public function __construct(\phpbb\cache\driver\driver_interface $cache, $cache_dir, $key, factory $factory, \phpbb\event\dispatcher_interface $dispatcher)
 	{
 		$renderer_data = $cache->get($key);
 		if ($renderer_data)
@@ -81,18 +87,29 @@ class renderer implements \phpbb\textformatter\renderer_interface
 				$censor = $renderer_data['censor'];
 			}
 		}
-
 		if (!isset($renderer))
 		{
 			$objects  = $factory->regenerate();
 			$renderer = $objects['renderer'];
 		}
+		$self = $this;
+
+		/**
+		* Configure the renderer service
+		*
+		* @event core.text_formatter_s9e_renderer_setup
+		* @var \s9e\TextFormatter\Renderer renderer s9e\TextFormatter renderer instance
+		* @var \phpbb\textformatter\s9e\renderer self This renderer service
+		* @since 3.2.0-a1
+		*/
+		$vars = array('renderer', 'self');
+		extract($dispatcher->trigger_event('core.text_formatter_s9e_renderer_setup', compact($vars)));
 
 		if (isset($censor))
 		{
 			$this->censor = $censor;
 		}
-
+		$this->dispatcher = $dispatcher;
 		$this->renderer = $renderer;
 	}
 

tests/test_framework/phpbb_test_case_helpers.php

@@ -426,6 +426,7 @@ class phpbb_test_case_helpers
 		$cache_key_parser = $prefix . '_parser';
 		$cache_key_renderer = $prefix . '_renderer';
 		$container->set('cache.driver', $cache);
+		$container->setParameter('cache.dir', $cache_dir);
 
 		// Create a path_helper
 		if (!$container->has('path_helper'))
@@ -500,7 +501,8 @@ class phpbb_test_case_helpers
 			$cache,
 			$cache_dir,
 			$cache_key_renderer,
-			$factory
+			$factory,
+			$dispatcher
 		);
 
 		$config = ($container->has('config'))

tests/text_formatter/s9e/renderer_test.php

@@ -43,7 +43,8 @@ class phpbb_textformatter_s9e_renderer_test extends phpbb_test_case
 			$cache,
 			$this->get_cache_dir(),
 			'_foo_renderer',
-			$factory
+			$factory,
+			new phpbb_mock_event_dispatcher
 		);
 	}
 
@@ -68,7 +69,8 @@ class phpbb_textformatter_s9e_renderer_test extends phpbb_test_case
 			$cache,
 			$this->get_cache_dir(),
 			'_foo_renderer',
-			$factory
+			$factory,
+			new phpbb_mock_event_dispatcher
 		);
 	}
 
@@ -354,4 +356,37 @@ class phpbb_textformatter_s9e_renderer_test extends phpbb_test_case
 			);
 		}
 	}
+
+	/**
+	* @testdox The constructor triggers a core.text_formatter_s9e_renderer_setup event
+	*/
+	public function test_setup_event()
+	{
+		$container = $this->get_test_case_helpers()->set_s9e_services();
+		$dispatcher = $this->getMock('phpbb\\event\\dispatcher_interface');
+		$dispatcher
+			->expects($this->once())
+			->method('trigger_event')
+			->with(
+				'core.text_formatter_s9e_renderer_setup',
+				$this->callback(array($this, 'setup_event_callback'))
+			)
+			->will($this->returnArgument(1));
+
+		new \phpbb\textformatter\s9e\renderer(
+			$container->get('cache.driver'),
+			$container->getParameter('cache.dir'),
+			'_foo_renderer',
+			$container->get('text_formatter.s9e.factory'),
+			$dispatcher
+		);
+	}
+
+	public function setup_event_callback($vars)
+	{
+		return isset($vars['renderer'])
+			&& $vars['renderer'] instanceof \s9e\TextFormatter\Renderer
+			&& isset($vars['self'])
+			&& $vars['self'] instanceof \phpbb\textformatter\s9e\renderer;
+	}
 }