[ticket/12620] Creates one di extension per phpBB extension

PHPBB3-12620

4 files changed, 150 insertions, 90 deletions

diff --git a/phpBB/phpbb/di/container_builder.php b/phpBB/phpbb/di/container_builder.php
index 45dbaaf303..5ad9336695 100644
--- a/phpBB/phpbb/di/container_builder.php
+++ b/phpBB/phpbb/di/container_builder.php
@@ -160,7 +160,17 @@ class container_builder
 			if ($this->use_extensions)
 			{
 				$installed_exts = $this->get_installed_extensions();
-				$container_extensions[] = new \phpbb\di\extension\ext($installed_exts);
+				foreach ($installed_exts as $ext_name => $path)
+				{
+					$extension_class = '\\' . str_replace('/', '\\', $ext_name) . '\\di\extension';
+
+					if (!class_exists($extension_class))
+					{
+						$extension_class = '\phpbb\extension\di\extension_base';
+					}
+
+					$container_extensions[] = new $extension_class($ext_name, $path);
+				}
 			}
 
 			if ($this->inject_config)
diff --git a/phpBB/phpbb/di/extension/ext.php b/phpBB/phpbb/di/extension/ext.php
deleted file mode 100644
index 021e862118..0000000000
--- a/phpBB/phpbb/di/extension/ext.php
+++ /dev/null
@@ -1,89 +0,0 @@
-<?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\di\extension;
-
-use Symfony\Component\DependencyInjection\ContainerBuilder;
-use Symfony\Component\HttpKernel\DependencyInjection\Extension;
-use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
-use Symfony\Component\Config\FileLocator;
-
-/**
-* Container ext extension
-*/
-class ext extends Extension
-{
-	protected $paths = array();
-
-	public function __construct($enabled_extensions)
-	{
-		foreach ($enabled_extensions as $ext => $path)
-		{
-			$this->paths[] = $path;
-		}
-	}
-
-	/**
-	* Loads a specific configuration.
-	*
-	* @param array            $config    An array of configuration values
-	* @param ContainerBuilder $container A ContainerBuilder instance
-	*
-	* @throws \InvalidArgumentException When provided tag is not defined in this extension
-	*/
-	public function load(array $config, ContainerBuilder $container)
-	{
-		foreach ($this->paths as $path)
-		{
-			$services_directory = false;
-			$services_file = false;
-
-			if (file_exists($path . 'config/' . PHPBB_ENVIRONMENT . '/container/environment.yml'))
-			{
-				$services_directory = $path . 'config/' . PHPBB_ENVIRONMENT . '/container/';
-				$services_file = 'environment.yml';
-			}
-			else if (!is_dir($path . 'config/' . PHPBB_ENVIRONMENT))
-			{
-				if (file_exists($path . 'config/default/container/environment.yml'))
-				{
-					$services_directory = $path . 'config/default/container/';
-					$services_file = 'environment.yml';
-				}
-				else if (!is_dir($path . 'config/default') && file_exists($path . '/config/services.yml'))
-				{
-					$services_directory = $path . 'config';
-					$services_file = 'services.yml';
-				}
-			}
-
-			if ($services_directory && $services_file)
-			{
-				$loader = new YamlFileLoader($container, new FileLocator(phpbb_realpath($services_directory)));
-				$loader->load($services_file);
-			}
-		}
-	}
-
-	/**
-	* Returns the recommended alias to use in XML.
-	*
-	* This alias is also the mandatory prefix to use when using YAML.
-	*
-	* @return string The alias
-	*/
-	public function getAlias()
-	{
-		return 'ext';
-	}
-}
diff --git a/phpBB/phpbb/extension/di/extension_base.php b/phpBB/phpbb/extension/di/extension_base.php
new file mode 100644
index 0000000000..74026bd53a
--- /dev/null
+++ b/phpBB/phpbb/extension/di/extension_base.php
@@ -0,0 +1,137 @@
+<?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\extension\di;
+
+use Symfony\Component\Config\FileLocator;
+use Symfony\Component\Config\Resource\FileResource;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
+use Symfony\Component\HttpKernel\DependencyInjection\Extension;
+
+/**
+* Container core extension
+*/
+class extension_base extends Extension
+{
+	/**
+	 * Name of the extension (vendor/name)
+	 *
+	 * @var string
+	 */
+	protected $extension_name;
+
+	/**
+	 * Path to the extension.
+	 *
+	 * @var string
+	 */
+	protected $ext_path;
+
+	/**
+	 * Constructor
+	 *
+	 * @param string $extension_name Name of the extension (vendor/name)
+	 * @param string $ext_path       Path to the extension
+	 */
+	public function __construct($extension_name, $ext_path)
+	{
+		$this->extension_name = $extension_name;
+		$this->ext_path = $ext_path;
+	}
+
+	/**
+	 * Loads a specific configuration.
+	 *
+	 * @param array            $configs   An array of configuration values
+	 * @param ContainerBuilder $container A ContainerBuilder instance
+	 *
+	 * @throws \InvalidArgumentException When provided tag is not defined in this extension
+	 */
+	public function load(array $configs, ContainerBuilder $container)
+	{
+		$this->load_services($container);
+	}
+
+	/**
+	 * Loads the services.yml file.
+	 *
+	 * @param ContainerBuilder $container A ContainerBuilder instance
+	 */
+	protected function load_services(ContainerBuilder $container)
+	{
+		$services_directory = false;
+		$services_file = false;
+
+		if (file_exists($this->ext_path . 'config/' . $container->getParameter('core.environment') . '/container/environment.yml'))
+		{
+			$services_directory = $this->ext_path . 'config/' . $container->getParameter('core.environment') . '/container/';
+			$services_file = 'environment.yml';
+		}
+		else if (!is_dir($this->ext_path . 'config/' . $container->getParameter('core.environment')))
+		{
+			if (file_exists($this->ext_path . 'config/default/container/environment.yml'))
+			{
+				$services_directory = $this->ext_path . 'config/default/container/';
+				$services_file = 'environment.yml';
+			}
+			else if (!is_dir($this->ext_path . 'config/default') && file_exists($this->ext_path . '/config/services.yml'))
+			{
+				$services_directory = $this->ext_path . 'config';
+				$services_file = 'services.yml';
+			}
+		}
+
+		if ($services_directory && $services_file)
+		{
+			$loader = new YamlFileLoader($container, new FileLocator(phpbb_realpath($services_directory)));
+			$loader->load($services_file);
+		}
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getConfiguration(array $config, ContainerBuilder $container)
+	{
+		$reflected = new \ReflectionClass($this);
+		$namespace = $reflected->getNamespaceName();
+
+		$class = $namespace . '\\di\configuration';
+		if (class_exists($class))
+		{
+			$r = new \ReflectionClass($class);
+			$container->addResource(new FileResource($r->getFileName()));
+
+			if (!method_exists($class, '__construct'))
+			{
+				$configuration = new $class();
+
+				return $configuration;
+			}
+		}
+
+	}
+
+	/**
+	 * Returns the recommended alias to use in XML.
+	 *
+	 * This alias is also the mandatory prefix to use when using YAML.
+	 *
+	 * @return string The alias
+	 */
+	public function getAlias()
+	{
+		return str_replace('/', '_', $this->extension_name);
+	}
+}
diff --git a/tests/di/fixtures/config/development/config.yml b/tests/di/fixtures/config/development/config.yml
new file mode 100644
index 0000000000..fcfa84f68b
--- /dev/null
+++ b/tests/di/fixtures/config/development/config.yml
@@ -0,0 +1,2 @@
+core:
+    require_dev_dependencies: true