DIContainer/d3DicHandler.php

191 regels
5.2 KiB
PHP

2022-12-28 13:31:44 +01:00
<?php
/**
* This Software is the property of Data Development and is protected
* by copyright law - it is NOT Freeware.
* Any unauthorized use of this software without a valid license
* is a violation of the license agreement and will be prosecuted by
* civil and criminal law.
* https://www.d3data.de
*
* @copyright (C) D3 Data Development (Inh. Thomas Dartsch)
* @author D3 Data Development - Daniel Seifert <support@shopmodule.com>
* @link http://www.oxidmodule.com
*/
namespace D3\DIContainerHandler;
use d3DIContainerCache;
2022-12-28 13:31:44 +01:00
use Exception;
use OxidEsales\Eshop\Core\Registry;
use OxidEsales\Facts\Config\ConfigFile;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Dumper\PhpDumper;
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
class d3DicHandler implements d3DicHandlerInterface
{
/**
* instance
* @var array
*/
protected static $_instance;
public static $circularReferenceMethodNames = array(
'getViewConfig'
);
/**
* get instance
* @return ContainerBuilder
*/
public static function getInstance()
{
$trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
$caller = $trace[1];
$functionName = $caller['function'];
if (in_array(strtolower($functionName), array_map('strtolower', self::$circularReferenceMethodNames)))
{
throw oxNew(Exception::class, 'method '.$functionName." can't use DIC due the danger of circular reference");
}
if (null == self::$_instance) {
$oDicHandler = oxNew(d3DicHandler::class);
self::$_instance = $oDicHandler->buildContainer();
}
return self::$_instance;
}
/**
* get instance
* @return ContainerBuilder
*/
public static function getUncompiledInstance()
{
$trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
$caller = $trace[1];
$functionName = $caller['function'];
if (in_array(strtolower($functionName), array_map('strtolower', self::$circularReferenceMethodNames)))
{
throw oxNew(Exception::class, 'method '.$functionName." can't use DIC due the danger of circular reference");
}
$oDicHandler = oxNew(d3DicHandler::class);
self::$_instance = $oDicHandler->buildContainer(false);
return self::$_instance;
}
public static function removeInstance()
{
self::$_instance = null;
}
/**
* @return mixed
*/
public function d3GetConfig()
{
return Registry::getConfig();
}
public function d3GetCacheFilePath()
{
return $this->d3GetConfig()->getConfigParam('sCompileDir').'/d3DicContainer_'.Registry::getConfig()->getShopId().'.php';
}
/**
* @return d3DIContainerCache|object
2022-12-28 13:31:44 +01:00
*/
public function d3GetCacheContainer()
{
require_once $this->d3GetCacheFilePath();
return oxNew(d3DIContainerCache::class);
2022-12-28 13:31:44 +01:00
}
/**
* @param $container
* @return YamlFileLoader
*/
public function d3GetFileLoader($container)
{
/** @var YamlFileLoader $fileLoader */
$fileLoader = oxNew(YamlFileLoader::class,
$container,
oxNew(FileLocator::class, $this->d3GetConfig()->getModulesDir())
);
return $fileLoader;
}
/**
* @param $container
*/
public function loadFiles($container)
{
$loader = $this->d3GetFileLoader($container);
$fileContainer = oxNew(definitionFileContainer::class);
foreach ($fileContainer->getYamlDefinitions() as $file) {
2022-12-28 13:31:44 +01:00
$fullPath = $this->d3GetConfig()->getModulesDir().$file;
if (is_file($fullPath)) {
$loader->load($file);
}
}
}
/**
* @param bool $compileAndDump
* @return ContainerBuilder
*/
public function buildContainer(bool $compileAndDump = true)
{
if ((bool) Registry::get( ConfigFile::class)->getVar( 'iDebug')) startProfile(__METHOD__);
$config = $this->d3GetConfig();
if ($config->isProductiveMode()
&& false == $config->getConfigParam('iDebug')
&& (false == defined('OXID_PHP_UNIT') || true == defined('D3_MODCFG_TEST'))
&& file_exists($this->d3GetCacheFilePath())
) {
$container = $this->d3GetCacheContainer();
} else {
$container = $this->getContainerBuilder();
$this->loadFiles($container);
if ($compileAndDump) {
$container->compile();
if (false == defined('OXID_PHP_UNIT')) {
$dumper = new PhpDumper($container);
file_put_contents($this->d3GetCacheFilePath(), $dumper->dump(array('class' => 'd3DIContainerCache')));
2022-12-28 13:31:44 +01:00
}
}
}
if ((bool) Registry::get( ConfigFile::class)->getVar( 'iDebug')) stopProfile(__METHOD__);
return $container;
}
public function getContainerBuilder()
{
return oxNew(ContainerBuilder::class);
}
/**
* clone
*/
public function __clone() {}
/**
* constructor
*/
public function __construct() {}
}