mirror of
https://github.com/phpbb/phpbb.git
synced 2025-07-31 14:00:31 +02:00
[ticket/12775] Renamed to \phpbb\di\container_builder
PHPBB3-12775
This commit is contained in:
Tristan Darricau
396
phpBB/phpbb/di/container_builder.php
Normal file
396
phpBB/phpbb/di/container_builder.php
Normal file
@@ -0,0 +1,396 @@
|
||||
<?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;
|
||||
|
||||
use Symfony\Component\DependencyInjection\ContainerBuilder;
|
||||
use Symfony\Component\DependencyInjection\Dumper\PhpDumper;
|
||||
|
||||
class container_factory
|
||||
{
|
||||
/** @var string phpBB Root Path */
|
||||
protected $phpbb_root_path;
|
||||
|
||||
/** @var string php file extension */
|
||||
protected $php_ext;
|
||||
|
||||
/**
|
||||
* The container under construction
|
||||
*
|
||||
* @var ContainerBuilder
|
||||
*/
|
||||
protected $container;
|
||||
|
||||
/**
|
||||
* @var \phpbb\db\driver\driver_interface
|
||||
*/
|
||||
protected $dbal_connection = null;
|
||||
|
||||
/**
|
||||
* @var array the installed extensions
|
||||
*/
|
||||
protected $installed_exts = null;
|
||||
|
||||
/**
|
||||
* Indicates if the php config file should be injecting into the container (default to true).
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
protected $inject_config = true;
|
||||
|
||||
/**
|
||||
* Indicates if the extensions should be used (default to true).
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
protected $use_extensions = true;
|
||||
|
||||
/**
|
||||
* Defines a custom path to find the configuration of the container.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $config_path = null;
|
||||
|
||||
/**
|
||||
* Indicates if the phpBB compile pass have to be used (default to true).
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
protected $use_custom_pass = true;
|
||||
|
||||
/**
|
||||
* Indicates if the kernel compile pass have to be used (default to true).
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
protected $use_kernel_pass = true;
|
||||
|
||||
/**
|
||||
* Indicates if a dump container should be used (default to true).
|
||||
*
|
||||
* If DEBUG_CONTAINER is set this option is ignored and a new container is build.
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
protected $dump_container = true;
|
||||
|
||||
/**
|
||||
* Indicates if the container should be compiled automatically (default to true).
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
protected $compile_container = true;
|
||||
|
||||
/**
|
||||
* Custom parameters to inject into the container.
|
||||
*
|
||||
* Default to true:
|
||||
* array(
|
||||
* 'core.root_path', $this->phpbb_root_path,
|
||||
* 'core.php_ext', $this->php_ext,
|
||||
* );
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $custom_parameters = null;
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param \phpbb\config_php $config_php_handler
|
||||
* @param string $phpbb_root_path Path to the phpbb includes directory.
|
||||
* @param string $php_ext php file extension
|
||||
*/
|
||||
function __construct(\phpbb\config_php $config_php_handler, $phpbb_root_path, $php_ext)
|
||||
{
|
||||
$this->config_php_handler = $config_php_handler;
|
||||
$this->phpbb_root_path = $phpbb_root_path;
|
||||
$this->php_ext = $php_ext;
|
||||
}
|
||||
|
||||
/**
|
||||
* Build and return a new Container respecting the current configuration
|
||||
*
|
||||
* @return \phpbb_cache_container|ContainerBuilder
|
||||
*/
|
||||
public function get_container()
|
||||
{
|
||||
$container_filename = $this->get_container_filename();
|
||||
if (!defined('DEBUG_CONTAINER') && $this->dump_container && file_exists($container_filename))
|
||||
{
|
||||
require($container_filename);
|
||||
$this->container = new \phpbb_cache_container();
|
||||
}
|
||||
else
|
||||
{
|
||||
if ($this->config_path === null)
|
||||
{
|
||||
$this->config_path = $this->phpbb_root_path . 'config';
|
||||
}
|
||||
$container_extensions = array(new \phpbb\di\extension\core($this->config_path));
|
||||
|
||||
if ($this->use_extensions)
|
||||
{
|
||||
$installed_exts = $this->get_installed_extensions();
|
||||
$container_extensions[] = new \phpbb\di\extension\ext($installed_exts);
|
||||
}
|
||||
|
||||
if ($this->inject_config)
|
||||
{
|
||||
$container_extensions[] = new \phpbb\di\extension\config($this->config_php_handler);
|
||||
}
|
||||
|
||||
$this->container = $this->create_container($container_extensions);
|
||||
|
||||
if ($this->use_custom_pass)
|
||||
{
|
||||
$this->container->addCompilerPass(new \phpbb\di\pass\collection_pass());
|
||||
|
||||
if ($this->use_kernel_pass)
|
||||
{
|
||||
$this->container->addCompilerPass(new \phpbb\di\pass\kernel_pass());
|
||||
}
|
||||
}
|
||||
|
||||
$this->inject_custom_parameters();
|
||||
|
||||
if ($this->compile_container)
|
||||
{
|
||||
$this->container->compile();
|
||||
}
|
||||
|
||||
if ($this->dump_container && !defined('DEBUG'))
|
||||
{
|
||||
$this->dump_container($container_filename);
|
||||
}
|
||||
}
|
||||
|
||||
$this->container->set('config.php', $this->config_php_handler);
|
||||
|
||||
// Frozen container, we can't modify either the services or the parameters
|
||||
//$this->inject_dbal();
|
||||
|
||||
return $this->container;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set if the extensions should be used.
|
||||
*
|
||||
* @param bool $use_extensions
|
||||
*/
|
||||
public function set_use_extensions($use_extensions)
|
||||
{
|
||||
$this->use_extensions = $use_extensions;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set if the phpBB compile pass have to be used.
|
||||
*
|
||||
* @param bool $use_custom_pass
|
||||
*/
|
||||
public function set_use_custom_pass($use_custom_pass)
|
||||
{
|
||||
$this->use_custom_pass = $use_custom_pass;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set if the kernel compile pass have to be used.
|
||||
*
|
||||
* @param bool $use_kernel_pass
|
||||
*/
|
||||
public function set_use_kernel_pass($use_kernel_pass)
|
||||
{
|
||||
$this->use_kernel_pass = $use_kernel_pass;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set if the php config file should be injecting into the container.
|
||||
*
|
||||
* @param bool $inject_config
|
||||
*/
|
||||
public function set_inject_config($inject_config)
|
||||
{
|
||||
$this->inject_config = $inject_config;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set if a dump container should be used.
|
||||
*
|
||||
* If DEBUG_CONTAINER is set this option is ignored and a new container is build.
|
||||
*
|
||||
* @var bool $dump_container
|
||||
*/
|
||||
public function set_dump_container($dump_container)
|
||||
{
|
||||
$this->dump_container = $dump_container;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set if the container should be compiled automatically (default to true).
|
||||
*
|
||||
* @var bool $dump_container
|
||||
*/
|
||||
public function set_compile_container($compile_container)
|
||||
{
|
||||
$this->compile_container = $compile_container;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set a custom path to find the configuration of the container
|
||||
*
|
||||
* @param string $config_path
|
||||
*/
|
||||
public function set_config_path($config_path)
|
||||
{
|
||||
$this->config_path = $config_path;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set custom parameters to inject into the container.
|
||||
*
|
||||
* @param array $custom_parameters
|
||||
*/
|
||||
public function set_custom_parameters($custom_parameters)
|
||||
{
|
||||
$this->custom_parameters = $custom_parameters;
|
||||
}
|
||||
|
||||
/**
|
||||
* Dump the container to the disk.
|
||||
*
|
||||
* @param string $container_filename The name of the file.
|
||||
*/
|
||||
protected function dump_container($container_filename)
|
||||
{
|
||||
// Lastly, we create our cached container class
|
||||
$dumper = new PhpDumper($this->container);
|
||||
$cached_container_dump = $dumper->dump(array(
|
||||
'class' => 'phpbb_cache_container',
|
||||
'base_class' => 'Symfony\\Component\\DependencyInjection\\ContainerBuilder',
|
||||
));
|
||||
|
||||
file_put_contents($container_filename, $cached_container_dump);
|
||||
}
|
||||
|
||||
/**
|
||||
* Inject the connection into the container if one was opened.
|
||||
*/
|
||||
protected function inject_dbal()
|
||||
{
|
||||
if ($this->dbal_connection !== null)
|
||||
{
|
||||
$this->container->set('dbal.conn', $this->dbal_connection);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get DB connection.
|
||||
*
|
||||
* @return \phpbb\db\driver\driver_interface
|
||||
*/
|
||||
protected function get_dbal_connection()
|
||||
{
|
||||
if ($this->dbal_connection === null)
|
||||
{
|
||||
$dbal_driver_class = phpbb_convert_30_dbms_to_31($this->config_php_handler->get('dbms'));
|
||||
$this->dbal_connection = new $dbal_driver_class();
|
||||
$this->dbal_connection->sql_connect(
|
||||
$this->config_php_handler->get('dbhost'),
|
||||
$this->config_php_handler->get('dbuser'),
|
||||
$this->config_php_handler->get('dbpasswd'),
|
||||
$this->config_php_handler->get('dbname'),
|
||||
$this->config_php_handler->get('dbport'),
|
||||
defined('PHPBB_DB_NEW_LINK') && PHPBB_DB_NEW_LINK
|
||||
);
|
||||
}
|
||||
|
||||
return $this->dbal_connection;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get enabled extensions.
|
||||
*
|
||||
* @return array enabled extensions
|
||||
*/
|
||||
protected function get_installed_extensions()
|
||||
{
|
||||
$db = $this->get_dbal_connection();
|
||||
$extension_table = $this->config_php_handler->get('table_prefix') . 'ext';
|
||||
|
||||
$sql = 'SELECT *
|
||||
FROM ' . $extension_table . '
|
||||
WHERE ext_active = 1';
|
||||
|
||||
$result = $db->sql_query($sql);
|
||||
$rows = $db->sql_fetchrowset($result);
|
||||
$db->sql_freeresult($result);
|
||||
|
||||
$exts = array();
|
||||
foreach ($rows as $row)
|
||||
{
|
||||
$exts[$row['ext_name']] = $this->phpbb_root_path . 'ext/' . $row['ext_name'] . '/';
|
||||
}
|
||||
|
||||
return $exts;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create the ContainerBuilder object
|
||||
*
|
||||
* @param array $extensions Array of Container extension objects
|
||||
* @return ContainerBuilder object
|
||||
*/
|
||||
protected function create_container(array $extensions)
|
||||
{
|
||||
$container = new ContainerBuilder();
|
||||
|
||||
foreach ($extensions as $extension)
|
||||
{
|
||||
$container->registerExtension($extension);
|
||||
$container->loadFromExtension($extension->getAlias());
|
||||
}
|
||||
|
||||
return $container;
|
||||
}
|
||||
|
||||
/**
|
||||
* Inject the customs parameters into the container
|
||||
*/
|
||||
protected function inject_custom_parameters()
|
||||
{
|
||||
if ($this->custom_parameters === null)
|
||||
{
|
||||
$this->custom_parameters = array(
|
||||
'core.root_path' => $this->phpbb_root_path,
|
||||
'core.php_ext' => $this->php_ext,
|
||||
);
|
||||
}
|
||||
|
||||
foreach ($this->custom_parameters as $key => $value)
|
||||
{
|
||||
$this->container->setParameter($key, $value);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the filename under which the dumped container will be stored.
|
||||
*
|
||||
* @return string Path for dumped container
|
||||
*/
|
||||
protected function get_container_filename()
|
||||
{
|
||||
$filename = str_replace(array('/', '.'), array('slash', 'dot'), $this->phpbb_root_path);
|
||||
return $this->phpbb_root_path . 'cache/container_' . $filename . '.' . $this->php_ext;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user