Inheritance diagram for Manager:

Public Member Functions
	__construct (ComponentDefinition $componentConfigProvider, DomMergerInterface $domMerger, ReaderFactory $readerFactory, ArrayObjectFactory $arrayObjectFactory, AggregatedFileCollectorFactory $aggregatedFileCollectorFactory, CacheInterface $cache, InterpreterInterface $argumentInterpreter, SerializerInterface $serializer=null)

	getData ($name)

	prepareData ($name)

	createRawComponentData ($component, $evaluated=true)

	getReader ($name)

Public Member Functions inherited from ManagerInterface
	createRawComponentData ($component)

Data Fields
const	CACHE_ID = 'ui_component_configuration_data'

Data Fields inherited from ManagerInterface
const	SEARCH_PATTERN = '%s.xml'

const	ANONYMOUS_TEMPLATE = 'anonymous_%s_component_%d'

const	COMPONENT_ARGUMENTS_KEY = 'arguments'

const	COMPONENT_ATTRIBUTES_KEY = 'attributes'

const	CHILDREN_KEY = 'children'

Protected Member Functions
	hasData ($name)

	evaluateComponentArguments ($components)

	prepare ($name)

	createDataForComponent ($name, array $componentsPool)

	addComponentIntoPool ($instanceName, array $configuration)

	mergeArguments (array $componentData, array $rootComponentData)

	mergeAttributes (array $componentData, array $rootComponentData)

	createName (array $componentData, $key, $componentName)

Protected Attributes
	$componentConfigProvider

	$argumentInterpreter

	$domMerger

	$readerFactory

	$componentsData

	$componentsPool

	$arrayObjectFactory

	$aggregatedFileCollectorFactory

	$cache

	$uiReader

Detailed Description

Class Manager

Deprecated:: 101.0.0 @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 29 of file Manager.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	ComponentDefinition	$componentConfigProvider,
		DomMergerInterface	$domMerger,
		ReaderFactory	$readerFactory,
		ArrayObjectFactory	$arrayObjectFactory,
		AggregatedFileCollectorFactory	$aggregatedFileCollectorFactory,
		CacheInterface	$cache,
		InterpreterInterface	$argumentInterpreter,
		SerializerInterface	$serializer = `null`
	)

Parameters

ComponentDefinition	$componentConfigProvider
DomMergerInterface	$domMerger
ReaderFactory	$readerFactory
ArrayObjectFactory	$arrayObjectFactory
AggregatedFileCollectorFactory	$aggregatedFileCollectorFactory
CacheInterface	$cache
InterpreterInterface	$argumentInterpreter
SerializerInterface \| null	$serializer

Definition at line 115 of file Manager.php.

       {
         $this->componentConfigProvider = $componentConfigProvider;
         $this->domMerger = $domMerger;
         $this->readerFactory = $readerFactory;
         $this->arrayObjectFactory = $arrayObjectFactory;
         $this->componentsData = $this->arrayObjectFactory->create();
         $this->aggregatedFileCollectorFactory = $aggregatedFileCollectorFactory;
         $this->cache = $cache;
         $this->argumentInterpreter = $argumentInterpreter;
         $this->serializer = $serializer ?: ObjectManager::getInstance()->get(SerializerInterface::class);
     }

Member Function Documentation

◆ addComponentIntoPool()

addComponentIntoPool	(		$instanceName,
		array	$configuration
	)

protected

Add a component into pool

Parameters

string	$instanceName
array	$configuration

Returns: void

Definition at line 335 of file Manager.php.

     {
         $this->componentsPool->offsetSet($instanceName, $configuration);
     }

◆ createDataForComponent()

createDataForComponent	(		$name,
		array	$componentsPool
	)

protected

Create data for component instance

Parameters

string	$name
array	$componentsPool

Returns: array

Definition at line 295 of file Manager.php.

     {
         $createdComponents = [];
         $rootComponent = $this->createRawComponentData($name, false);
         foreach ($componentsPool as $key => $component) {
             $resultConfiguration = [ManagerInterface::CHILDREN_KEY => []];
             $instanceName = $this->createName($component, $key, $name);
             $resultConfiguration[ManagerInterface::COMPONENT_ARGUMENTS_KEY] = $this->mergeArguments(
                 $component,
                 $rootComponent
             );
             unset($component[Converter::DATA_ARGUMENTS_KEY]);
             $resultConfiguration[ManagerInterface::COMPONENT_ATTRIBUTES_KEY] = $this->mergeAttributes(
                 $component,
                 $rootComponent
             );
             unset($component[Converter::DATA_ATTRIBUTES_KEY]);
 
             // Create inner components
             foreach ($component as $subComponentName => $subComponent) {
                 if (is_array($subComponent)) {
                     $resultConfiguration[ManagerInterface::CHILDREN_KEY] = array_merge(
                         $resultConfiguration[ManagerInterface::CHILDREN_KEY],
                         $this->createDataForComponent($subComponentName, $subComponent)
                     );
                 }
             }
             $createdComponents[$instanceName] = $resultConfiguration;
         }
 
         return $createdComponents;
     }

◆ createName()

createName	(	array	$componentData,
			$key,
			$componentName
	)

protected

Create name component instance

Parameters

array	$componentData
string \| int	$key
string	$componentName

Returns: string

Definition at line 387 of file Manager.php.

     {
         return isset($componentData[Converter::DATA_ATTRIBUTES_KEY][Converter::NAME_ATTRIBUTE_KEY])
             ? $componentData[Converter::DATA_ATTRIBUTES_KEY][Converter::NAME_ATTRIBUTE_KEY]
             : sprintf(ManagerInterface::ANONYMOUS_TEMPLATE, $componentName, $key);
     }

◆ createRawComponentData()

createRawComponentData	(	$component,
		$evaluated = `true`
	)

To create the raw data components

Parameters

string	$component
bool	$evaluated

Returns: array

Definition at line 224 of file Manager.php.

     {
         $componentData = $this->componentConfigProvider->getComponentData($component);
         $componentData[Converter::DATA_ATTRIBUTES_KEY] = isset($componentData[Converter::DATA_ATTRIBUTES_KEY])
             ? $componentData[Converter::DATA_ATTRIBUTES_KEY]
             : [];
         $componentData[Converter::DATA_ARGUMENTS_KEY] = isset($componentData[Converter::DATA_ARGUMENTS_KEY])
             ? $componentData[Converter::DATA_ARGUMENTS_KEY]
             : [];
         if ($evaluated) {
             foreach ($componentData[Converter::DATA_ARGUMENTS_KEY] as $argumentName => $argument) {
                 $componentData[Converter::DATA_ARGUMENTS_KEY][$argumentName]
                     = $this->argumentInterpreter->evaluate($argument);
             }
         }
 
         return [
             ManagerInterface::COMPONENT_ATTRIBUTES_KEY => $componentData[Converter::DATA_ATTRIBUTES_KEY],
             ManagerInterface::COMPONENT_ARGUMENTS_KEY => $componentData[Converter::DATA_ARGUMENTS_KEY],
         ];
     }

◆ evaluateComponentArguments()

evaluateComponentArguments ( $components )

protected

Evaluated components data

Parameters

array $components

Returns: array

Definition at line 202 of file Manager.php.

     {
         foreach ($components as &$component) {
             foreach ($component[ManagerInterface::COMPONENT_ARGUMENTS_KEY] as $argumentName => $argument) {
                 $component[ManagerInterface::COMPONENT_ARGUMENTS_KEY][$argumentName]
                     = $this->argumentInterpreter->evaluate($argument);
             }
             $component[ManagerInterface::CHILDREN_KEY] = $this->evaluateComponentArguments(
                 $component[ManagerInterface::CHILDREN_KEY]
             );
         }
 
         return $components;
     }

◆ getData()

getData ( $name )

Get component data

Parameters

string $name

Returns: array

Implements ManagerInterface.

Definition at line 142 of file Manager.php.

     {
         return (array) $this->componentsData->offsetGet($name);
     }

◆ getReader()

getReader ( $name )

Get UIReader and collect base files configuration

Parameters

string $name

Returns: UiReaderInterface

Implements ManagerInterface.

Definition at line 252 of file Manager.php.

     {
         if (!isset($this->uiReader[$name])) {
             $this->domMerger->unsetDom();
             $this->uiReader[$name] =  $this->readerFactory->create(
                 [
                     'fileCollector' => $this->aggregatedFileCollectorFactory->create(
                         ['searchPattern' => sprintf(ManagerInterface::SEARCH_PATTERN, $name)]
                     ),
                     'domMerger' => $this->domMerger
                 ]
             );
         }
 
         return $this->uiReader[$name];
     }

◆ hasData()

hasData ( $name )

protected

Has component data

Parameters

string $name

Returns: bool

Definition at line 153 of file Manager.php.

     {
         return $this->componentsData->offsetExists($name);
     }

◆ mergeArguments()

mergeArguments	(	array	$componentData,
		array	$rootComponentData
	)

protected

Merge component arguments

Parameters

array	$componentData
array	$rootComponentData

Returns: array

Definition at line 347 of file Manager.php.

     {
         $baseArguments = isset($rootComponentData[ManagerInterface::COMPONENT_ARGUMENTS_KEY])
             ? $rootComponentData[ManagerInterface::COMPONENT_ARGUMENTS_KEY]
             : [];
         $componentArguments = isset($componentData[Converter::DATA_ARGUMENTS_KEY])
             ? $componentData[Converter::DATA_ARGUMENTS_KEY]
             : [];
 
         return array_replace_recursive($baseArguments, $componentArguments);
     }

◆ mergeAttributes()

mergeAttributes	(	array	$componentData,
		array	$rootComponentData
	)

protected

Merge component attributes

Parameters

array	$componentData
array	$rootComponentData

Returns: array

Definition at line 366 of file Manager.php.

     {
         $baseAttributes = isset($rootComponentData[ManagerInterface::COMPONENT_ATTRIBUTES_KEY])
             ? $rootComponentData[ManagerInterface::COMPONENT_ATTRIBUTES_KEY]
             : [];
         $componentAttributes = isset($componentData[Converter::DATA_ATTRIBUTES_KEY])
             ? $componentData[Converter::DATA_ATTRIBUTES_KEY]
             : [];
         unset($componentAttributes['noNamespaceSchemaLocation']);
 
         return array_replace_recursive($baseAttributes, $componentAttributes);
     }

◆ prepare()

prepare ( $name )

protected

Initialize the new component data

Parameters

string $name

Returns: void

Definition at line 275 of file Manager.php.

     {
         $componentData = $this->getReader($name)->read();
         $componentsPool = reset($componentData);
         $componentsPool = reset($componentsPool);
         $componentsPool[Converter::DATA_ATTRIBUTES_KEY] = array_merge(
             ['name' => $name],
             $componentsPool[Converter::DATA_ATTRIBUTES_KEY]
         );
         $components = $this->createDataForComponent(key($componentData), [$componentsPool]);
         $this->addComponentIntoPool($name, reset($components));
     }

◆ prepareData()

prepareData ( $name )

Prepare the initialization data of UI components

Parameters

string $name

Returns: ManagerInterface

Exceptions

Implements ManagerInterface.

Definition at line 165 of file Manager.php.

     {
         if ($name === null || $this->hasData($name)) {
             throw new LocalizedException(
                 new \Magento\Framework\Phrase(
                     'The "%1" UI component element name is invalid. Verify the name and try again.',
                     [$name]
                 )
             );
         }
         $this->componentsPool = $this->arrayObjectFactory->create();
 
         $cacheID = static::CACHE_ID . '_' . $name;
         $cachedPool = $this->cache->load($cacheID);
         if ($cachedPool === false) {
             $this->prepare($name);
             $this->cache->save(
                 $this->serializer->serialize($this->componentsPool->getArrayCopy()),
                 $cacheID
             );
         } else {
             $this->componentsPool->exchangeArray(
                 $this->serializer->unserialize($cachedPool)
             );
         }
         $this->componentsData->offsetSet($name, $this->componentsPool);
         $this->componentsData->offsetSet($name, $this->evaluateComponentArguments($this->getData($name)));
 
         return $this;
     }

Field Documentation

◆ $aggregatedFileCollectorFactory

$aggregatedFileCollectorFactory

protected

Definition at line 88 of file Manager.php.

◆ $argumentInterpreter

$argumentInterpreter

protected

Definition at line 48 of file Manager.php.

◆ $arrayObjectFactory

$arrayObjectFactory

protected

Definition at line 83 of file Manager.php.

◆ $cache

$cache

protected

Definition at line 93 of file Manager.php.

◆ $componentConfigProvider

$componentConfigProvider

protected

Definition at line 41 of file Manager.php.

◆ $componentsData

$componentsData

protected

Definition at line 69 of file Manager.php.

◆ $componentsPool

$componentsPool

protected

Definition at line 76 of file Manager.php.

◆ $domMerger

$domMerger

protected

Definition at line 55 of file Manager.php.

◆ $readerFactory

$readerFactory

protected

Definition at line 62 of file Manager.php.

◆ $uiReader

$uiReader

protected

Definition at line 98 of file Manager.php.

◆ CACHE_ID

const CACHE_ID = 'ui_component_configuration_data'

ID in the storage cache

Definition at line 34 of file Manager.php.

The documentation for this class was generated from the following file:

vendor/magento/module-ui/Model/Manager.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addComponentIntoPool()

◆ createDataForComponent()

◆ createName()

◆ createRawComponentData()

◆ evaluateComponentArguments()

◆ getData()

◆ getReader()

◆ hasData()

◆ mergeArguments()

◆ mergeAttributes()

◆ prepare()

◆ prepareData()

Field Documentation

◆ $aggregatedFileCollectorFactory

◆ $argumentInterpreter

◆ $arrayObjectFactory

◆ $cache

◆ $componentConfigProvider

◆ $componentsData

◆ $componentsPool

◆ $domMerger

◆ $readerFactory

◆ $uiReader

◆ CACHE_ID