From 6bd86a8e8a7c8e2ccf90d02343132c085978cd44 Mon Sep 17 00:00:00 2001
From: JoshyPHP <s9e.dev@gmail.com>
Date: Sun, 15 Feb 2015 03:08:36 +0100
Subject: [PATCH] [ticket/11768] Updated
 phpbb\textformatter\s9e\factory::regenerate()

Returns an associative array rather than a numerically-indexed array. Feels
cleaner and more extensible.

PHPBB3-11768
---
 phpBB/phpbb/textformatter/s9e/factory.php  | 4 ++--
 phpBB/phpbb/textformatter/s9e/parser.php   | 2 +-
 phpBB/phpbb/textformatter/s9e/renderer.php | 2 +-
 tests/text_formatter/s9e/factory_test.php  | 4 ++--
 tests/text_formatter/s9e/parser_test.php   | 2 +-
 tests/text_formatter/s9e/renderer_test.php | 2 +-
 6 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/phpBB/phpbb/textformatter/s9e/factory.php b/phpBB/phpbb/textformatter/s9e/factory.php
index 77b1a1c916..ed99bba4a1 100644
--- a/phpBB/phpbb/textformatter/s9e/factory.php
+++ b/phpBB/phpbb/textformatter/s9e/factory.php
@@ -294,7 +294,7 @@ class factory implements \phpbb\textformatter\cache
 	/**
 	* Regenerate and cache a new parser and renderer
 	*
-	* @return array Array with two elements: an instance of the parser, an instance of the renderer
+	* @return array Associative array with at least two elements: "parser" and "renderer"
 	*/
 	public function regenerate()
 	{
@@ -315,7 +315,7 @@ class factory implements \phpbb\textformatter\cache
 		);
 		$this->cache->put($this->cache_key_renderer, $renderer_data);
 
-		return array($parser, $renderer);
+		return array('parser' => $parser, 'renderer' => $renderer);
 	}
 
 	/**
diff --git a/phpBB/phpbb/textformatter/s9e/parser.php b/phpBB/phpbb/textformatter/s9e/parser.php
index 3b490131f2..8e78a18d40 100644
--- a/phpBB/phpbb/textformatter/s9e/parser.php
+++ b/phpBB/phpbb/textformatter/s9e/parser.php
@@ -48,7 +48,7 @@ class parser extends \phpbb\textformatter\parser
 		$parser = $cache->get($key);
 		if (!$parser)
 		{
-			list($parser) = $factory->regenerate();
+			extract($factory->regenerate());
 		}
 
 		$this->parser = $parser;
diff --git a/phpBB/phpbb/textformatter/s9e/renderer.php b/phpBB/phpbb/textformatter/s9e/renderer.php
index eea01f82af..943056e6ca 100644
--- a/phpBB/phpbb/textformatter/s9e/renderer.php
+++ b/phpBB/phpbb/textformatter/s9e/renderer.php
@@ -80,7 +80,7 @@ class renderer extends \phpbb\textformatter\renderer
 
 		if (!isset($renderer))
 		{
-			list(, $renderer) = $factory->regenerate();
+			extract($factory->regenerate());
 		}
 
 		$this->renderer = $renderer;
diff --git a/tests/text_formatter/s9e/factory_test.php b/tests/text_formatter/s9e/factory_test.php
index 2ea4b3031b..9542da8d9a 100644
--- a/tests/text_formatter/s9e/factory_test.php
+++ b/tests/text_formatter/s9e/factory_test.php
@@ -84,7 +84,7 @@ class phpbb_textformatter_s9e_factory_test extends phpbb_database_test_case
 
 	public function test_regenerate()
 	{
-		list($parser, $renderer) = $this->get_factory()->regenerate();
+		extract($this->get_factory()->regenerate());
 
 		$this->assertInstanceOf('s9e\\TextFormatter\\Parser', $parser);
 		$this->assertInstanceOf('s9e\\TextFormatter\\Renderer', $renderer);
@@ -113,7 +113,7 @@ class phpbb_textformatter_s9e_factory_test extends phpbb_database_test_case
 		touch($old_file);
 
 		// Create a current renderer
-		list($parser, $renderer) = $factory->regenerate();
+		extract($factory->regenerate());
 		$new_file = $this->get_cache_dir() . get_class($renderer) . '.php';
 
 		// Tidy the cache
diff --git a/tests/text_formatter/s9e/parser_test.php b/tests/text_formatter/s9e/parser_test.php
index aee906e213..f422e5425a 100644
--- a/tests/text_formatter/s9e/parser_test.php
+++ b/tests/text_formatter/s9e/parser_test.php
@@ -82,7 +82,7 @@ class phpbb_textformatter_s9e_parser_test extends phpbb_test_case
 		                ->getMock();
 		$factory->expects($this->once())
 		        ->method('regenerate')
-		        ->will($this->returnValue(array($mock, false)));
+		        ->will($this->returnValue(array('parser' => $mock)));
 
 		$parser = new \phpbb\textformatter\s9e\parser(
 			new phpbb_mock_cache,
diff --git a/tests/text_formatter/s9e/renderer_test.php b/tests/text_formatter/s9e/renderer_test.php
index 977c165177..464bcf8eed 100644
--- a/tests/text_formatter/s9e/renderer_test.php
+++ b/tests/text_formatter/s9e/renderer_test.php
@@ -61,7 +61,7 @@ class phpbb_textformatter_s9e_renderer_test extends phpbb_test_case
 		                ->getMock();
 		$factory->expects($this->once())
 		        ->method('regenerate')
-		        ->will($this->returnValue(array($mock, false)));
+		        ->will($this->returnValue(array('parser' => $mock)));
 
 		$renderer = new \phpbb\textformatter\s9e\renderer(
 			$cache,