aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/phpbb/extension/di/extension_base.php
blob: ba74615e70218f1bea70529a2dcb0eb4450fc1e4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
<?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)
		{
			$filesystem = new \phpbb\filesystem\filesystem();
			$loader = new YamlFileLoader($container, new FileLocator($filesystem->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);
	}
}