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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\App;
use Magento\Framework\App\Filesystem\DirectoryList;
use Magento\Framework\Filesystem\DriverPool;
use Magento\Framework\Interception\ObjectManager\ConfigInterface;
use Magento\Framework\App\ObjectManager\Environment;
use Magento\Framework\Config\File\ConfigFilePool;
use Magento\Framework\Code\GeneratedFiles;
/**
* Initialization of object manager is a complex operation.
* To abstract away this complexity, this class was introduced.
* Objects of this class create fully initialized instance of object manager with "global" configuration loaded.
*
* @api
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* @since 100.0.2
*/
class ObjectManagerFactory
{
/**
* Initialization parameter for a custom deployment configuration file
*/
const INIT_PARAM_DEPLOYMENT_CONFIG_FILE = 'MAGE_CONFIG_FILE';
/**
* Initialization parameter for custom deployment configuration data
*/
const INIT_PARAM_DEPLOYMENT_CONFIG = 'MAGE_CONFIG';
/**
* Locator class name
*
* @var string
*/
protected $_locatorClassName = \Magento\Framework\App\ObjectManager::class;
/**
* Config class name
*
* @var string
*/
protected $_configClassName = \Magento\Framework\Interception\ObjectManager\ConfigInterface::class;
/**
* Environment factory class name
*
* @var string
*/
protected $envFactoryClassName = \Magento\Framework\App\EnvironmentFactory::class;
/**
* Filesystem directory list
*
* @var DirectoryList
*/
protected $directoryList;
/**
* Filesystem driver pool
*
* @var DriverPool
*/
protected $driverPool;
/**
* Configuration file pool
*
* @var ConfigFilePool
*/
protected $configFilePool;
/**
* Factory
*
* @var \Magento\Framework\ObjectManager\FactoryInterface
*/
protected $factory;
/**
* Constructor
*
* @param DirectoryList $directoryList
* @param DriverPool $driverPool
* @param ConfigFilePool $configFilePool
*/
public function __construct(DirectoryList $directoryList, DriverPool $driverPool, ConfigFilePool $configFilePool)
{
$this->directoryList = $directoryList;
$this->driverPool = $driverPool;
$this->configFilePool = $configFilePool;
}
/**
* Create ObjectManager
*
* @param array $arguments
* @return \Magento\Framework\ObjectManagerInterface
*
* @SuppressWarnings(PHPMD.NPathComplexity)
*/
public function create(array $arguments)
{
$writeFactory = new \Magento\Framework\Filesystem\Directory\WriteFactory($this->driverPool);
$generatedFiles = new GeneratedFiles($this->directoryList, $writeFactory);
$generatedFiles->cleanGeneratedFiles();
$deploymentConfig = $this->createDeploymentConfig($this->directoryList, $this->configFilePool, $arguments);
$arguments = array_merge($deploymentConfig->get(), $arguments);
$definitionFactory = new \Magento\Framework\ObjectManager\DefinitionFactory(
$this->driverPool->getDriver(DriverPool::FILE),
$this->directoryList->getPath(DirectoryList::GENERATED_CODE)
);
$definitions = $definitionFactory->createClassDefinition();
$relations = $definitionFactory->createRelations();
/** @var EnvironmentFactory $envFactory */
$envFactory = new $this->envFactoryClassName($relations, $definitions);
/** @var EnvironmentInterface $env */
$env = $envFactory->createEnvironment();
/** @var ConfigInterface $diConfig */
$diConfig = $env->getDiConfig();
$appMode = isset($arguments[State::PARAM_MODE]) ? $arguments[State::PARAM_MODE] : State::MODE_DEFAULT;
$booleanUtils = new \Magento\Framework\Stdlib\BooleanUtils();
$argInterpreter = $this->createArgumentInterpreter($booleanUtils);
$argumentMapper = new \Magento\Framework\ObjectManager\Config\Mapper\Dom($argInterpreter);
if ($env->getMode() != Environment\Compiled::MODE) {
$configData = $this->_loadPrimaryConfig($this->directoryList, $this->driverPool, $argumentMapper, $appMode);
if ($configData) {
$diConfig->extend($configData);
}
}
// set cache profiler decorator if enabled
if (\Magento\Framework\Profiler::isEnabled()) {
$cacheFactoryArguments = $diConfig->getArguments(\Magento\Framework\App\Cache\Frontend\Factory::class);
$cacheFactoryArguments['decorators'][] = [
'class' => \Magento\Framework\Cache\Frontend\Decorator\Profiler::class,
'parameters' => ['backendPrefixes' => ['Zend_Cache_Backend_', 'Cm_Cache_Backend_']],
];
$cacheFactoryConfig = [
\Magento\Framework\App\Cache\Frontend\Factory::class => ['arguments' => $cacheFactoryArguments]
];
$diConfig->extend($cacheFactoryConfig);
}
$sharedInstances = [
\Magento\Framework\App\DeploymentConfig::class => $deploymentConfig,
\Magento\Framework\App\Filesystem\DirectoryList::class => $this->directoryList,
\Magento\Framework\Filesystem\DirectoryList::class => $this->directoryList,
\Magento\Framework\Filesystem\DriverPool::class => $this->driverPool,
\Magento\Framework\ObjectManager\RelationsInterface::class => $relations,
\Magento\Framework\Interception\DefinitionInterface::class => $definitionFactory->createPluginDefinition(),
\Magento\Framework\ObjectManager\ConfigInterface::class => $diConfig,
\Magento\Framework\Interception\ObjectManager\ConfigInterface::class => $diConfig,
\Magento\Framework\ObjectManager\DefinitionInterface::class => $definitions,
\Magento\Framework\Stdlib\BooleanUtils::class => $booleanUtils,
\Magento\Framework\ObjectManager\Config\Mapper\Dom::class => $argumentMapper,
\Magento\Framework\ObjectManager\ConfigLoaderInterface::class => $env->getObjectManagerConfigLoader(),
$this->_configClassName => $diConfig,
];
$arguments['shared_instances'] = &$sharedInstances;
$this->factory = $env->getObjectManagerFactory($arguments);
/** @var \Magento\Framework\ObjectManagerInterface $objectManager */
$objectManager = new $this->_locatorClassName($this->factory, $diConfig, $sharedInstances);
$this->factory->setObjectManager($objectManager);
$generatorParams = $diConfig->getArguments(\Magento\Framework\Code\Generator::class);
/** Arguments are stored in different format when DI config is compiled, thus require custom processing */
$generatedEntities = isset($generatorParams['generatedEntities']['_v_'])
? $generatorParams['generatedEntities']['_v_']
: (isset($generatorParams['generatedEntities']) ? $generatorParams['generatedEntities'] : []);
$definitionFactory->getCodeGenerator()
->setObjectManager($objectManager)
->setGeneratedEntities($generatedEntities);
$env->configureObjectManager($diConfig, $sharedInstances);
return $objectManager;
}
/**
* Creates deployment configuration object
*
* @param DirectoryList $directoryList
* @param ConfigFilePool $configFilePool
* @param array $arguments
* @return DeploymentConfig
*/
protected function createDeploymentConfig(
DirectoryList $directoryList,
ConfigFilePool $configFilePool,
array $arguments
) {
$customFile = isset($arguments[self::INIT_PARAM_DEPLOYMENT_CONFIG_FILE])
? $arguments[self::INIT_PARAM_DEPLOYMENT_CONFIG_FILE]
: null;
$customData = isset($arguments[self::INIT_PARAM_DEPLOYMENT_CONFIG])
? $arguments[self::INIT_PARAM_DEPLOYMENT_CONFIG]
: [];
$reader = new DeploymentConfig\Reader($directoryList, $this->driverPool, $configFilePool, $customFile);
return new DeploymentConfig($reader, $customData);
}
/**
* Return newly created instance on an argument interpreter, suitable for processing DI arguments
*
* @param \Magento\Framework\Stdlib\BooleanUtils $booleanUtils
* @return \Magento\Framework\Data\Argument\InterpreterInterface
*/
protected function createArgumentInterpreter(
\Magento\Framework\Stdlib\BooleanUtils $booleanUtils
) {
$constInterpreter = new \Magento\Framework\Data\Argument\Interpreter\Constant();
$result = new \Magento\Framework\Data\Argument\Interpreter\Composite(
[
'boolean' => new \Magento\Framework\Data\Argument\Interpreter\Boolean($booleanUtils),
'string' => new \Magento\Framework\Data\Argument\Interpreter\BaseStringUtils($booleanUtils),
'number' => new \Magento\Framework\Data\Argument\Interpreter\Number(),
'null' => new \Magento\Framework\Data\Argument\Interpreter\NullType(),
'object' => new \Magento\Framework\Data\Argument\Interpreter\DataObject($booleanUtils),
'const' => $constInterpreter,
'init_parameter' => new \Magento\Framework\App\Arguments\ArgumentInterpreter($constInterpreter),
],
\Magento\Framework\ObjectManager\Config\Reader\Dom::TYPE_ATTRIBUTE
);
// Add interpreters that reference the composite
$result->addInterpreter('array', new \Magento\Framework\Data\Argument\Interpreter\ArrayType($result));
return $result;
}
/**
* Load primary config
*
* @param DirectoryList $directoryList
* @param DriverPool $driverPool
* @param mixed $argumentMapper
* @param string $appMode
* @return array
* @throws \Magento\Framework\Exception\State\InitException
*/
protected function _loadPrimaryConfig(DirectoryList $directoryList, $driverPool, $argumentMapper, $appMode)
{
$configData = null;
try {
$fileResolver = new \Magento\Framework\App\Arguments\FileResolver\Primary(
new \Magento\Framework\Filesystem(
$directoryList,
new \Magento\Framework\Filesystem\Directory\ReadFactory($driverPool),
new \Magento\Framework\Filesystem\Directory\WriteFactory($driverPool)
),
new \Magento\Framework\Config\FileIteratorFactory(
new \Magento\Framework\Filesystem\File\ReadFactory($driverPool)
)
);
$schemaLocator = new \Magento\Framework\ObjectManager\Config\SchemaLocator();
$validationState = new \Magento\Framework\App\Arguments\ValidationState($appMode);
$reader = new \Magento\Framework\ObjectManager\Config\Reader\Dom(
$fileResolver,
$argumentMapper,
$schemaLocator,
$validationState
);
$configData = $reader->read('primary');
} catch (\Exception $e) {
throw new \Magento\Framework\Exception\State\InitException(
new \Magento\Framework\Phrase($e->getMessage()),
$e
);
}
return $configData;
}
/**
* Crete plugin list object
*
* @param \Magento\Framework\ObjectManagerInterface $objectManager
* @param \Magento\Framework\ObjectManager\RelationsInterface $relations
* @param \Magento\Framework\ObjectManager\DefinitionFactory $definitionFactory
* @param \Magento\Framework\ObjectManager\Config\Config $diConfig
* @param \Magento\Framework\ObjectManager\DefinitionInterface $definitions
* @return \Magento\Framework\Interception\PluginList\PluginList
* @deprecated 101.0.0
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
protected function _createPluginList(
\Magento\Framework\ObjectManagerInterface $objectManager,
\Magento\Framework\ObjectManager\RelationsInterface $relations,
\Magento\Framework\ObjectManager\DefinitionFactory $definitionFactory,
\Magento\Framework\ObjectManager\Config\Config $diConfig,
\Magento\Framework\ObjectManager\DefinitionInterface $definitions
) {
return $objectManager->create(
\Magento\Framework\Interception\PluginList\PluginList::class,
[
'relations' => $relations,
'definitions' => $definitionFactory->createPluginDefinition(),
'omConfig' => $diConfig,
'classDefinitions' => null
]
);
}
}