UiComponentFactory Class Reference

Inheritance diagram for UiComponentFactory:

Public Member Functions
	__construct (ObjectManagerInterface $objectManager, ManagerInterface $componentManager, InterpreterInterface $argumentInterpreter, ContextFactory $contextFactory, array $data=[], array $componentChildFactories=[], DataInterface $definitionData=null, DataInterfaceFactory $configFactory=null)
Public Member Functions inherited from DataObject
	__construct (array $data=[])
	addData (array $arr)
	setData ($key, $value=null)
	unsetData ($key=null)
	getData ($key='', $index=null)
	getDataByPath ($path)
	getDataByKey ($key)
	setDataUsingMethod ($key, $args=[])
	getDataUsingMethod ($key, $args=null)
	hasData ($key='')
	toArray (array $keys=[])
	convertToArray (array $keys=[])
	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	toJson (array $keys=[])
	convertToJson (array $keys=[])
	toString ($format='')
	__call ($method, $args)
	isEmpty ()
	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
	debug ($data=null, &$objects=[])
	offsetSet ($offset, $value)
	offsetExists ($offset)
	offsetUnset ($offset)
	offsetGet ($offset)

Protected Member Functions
	createChildComponent (array &$bundleComponents, ContextInterface $renderContext, $identifier, array $arguments=[])
	argumentsResolver ($identifier, array $componentData)
	getBundleChildren (array $children=[])
	mergeMetadata ($identifier, array $bundleComponents, $reverseMerge=false)
	mergeMetadataElement (array $bundleComponents, $name, array $data, $reverseMerge=false)
	mergeMetadataItem (array $bundleComponents, array $metadata, $reverseMerge=false)
	getDataProvider ($identifier, array $bundleComponents)
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)

Protected Attributes
	$objectManager
	$argumentInterpreter
	$contextFactory
	$componentManager
Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Class UiComponentFactory

@api @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since

100.0.2

Definition at line 29 of file UiComponentFactory.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ObjectManagerInterface	$objectManager,
		ManagerInterface	$componentManager,
		InterpreterInterface	$argumentInterpreter,
		ContextFactory	$contextFactory,
		array	$data = [],
		array	$componentChildFactories = [],
		DataInterface	$definitionData = null,
		DataInterfaceFactory	$configFactory = null
	)

Parameters

ObjectManagerInterface	$objectManager
ManagerInterface	$componentManager
InterpreterInterface	$argumentInterpreter
ContextFactory	$contextFactory
DataInterfaceFactory | null	$configFactory
array	$data
array	$componentChildFactories
DataInterface | null	$definitionData

Definition at line 83 of file UiComponentFactory.php.

      {
        $this->objectManager = $objectManager;
        $this->componentManager = $componentManager;
        $this->argumentInterpreter = $argumentInterpreter;
        $this->contextFactory = $contextFactory;
        $this->componentChildFactories = $componentChildFactories;
        $this->configFactory = $configFactory ?: $this->objectManager->get(DataInterfaceFactory::class);
        parent::__construct($data);
        $this->definitionData = $definitionData ?:
            $this->objectManager->get(DataInterface::class);
    }

Member Function Documentation

argumentsResolver()

argumentsResolver (   $identifier, array  $componentData  )

protected

Resolve arguments

Parameters

string	$identifier
array	$componentData

Returns

array

Definition at line 174 of file UiComponentFactory.php.

    {
        $attributes = $componentData[ManagerInterface::COMPONENT_ATTRIBUTES_KEY];
        $className = $attributes['class'];
        unset($attributes['class']);
        $arguments = $componentData[ManagerInterface::COMPONENT_ARGUMENTS_KEY];

        if (!isset($arguments['data'])) {
            $arguments['data'] = [];
        }

        unset($attributes['component']);
        $arguments['data'] = array_merge($arguments['data'], ['name' => $identifier], $attributes);
        return [$className, $arguments];
    }

createChildComponent()

createChildComponent ( array &  $bundleComponents, ContextInterface  $renderContext,   $identifier, array  $arguments = []  )

protected

Create child components

Parameters

array	$bundleComponents
ContextInterface	$renderContext
string	$identifier
array	$arguments

Returns

UiComponentInterface

Add an ability to fill component variables from child factory.

Factory return nothing because factory should put created components in the right place

Prevent passing ACL restricted blocks to htmlContent constructor

Definition at line 113 of file UiComponentFactory.php.

      {
        $componentArguments = &$bundleComponents['arguments'];
        list($className, $componentArguments) = $this->argumentsResolver($identifier, $bundleComponents);
        if (isset($componentArguments['data']['disabled']) && (int)$componentArguments['data']['disabled']) {
            return null;
        }

        $bundleComponents['components'] = [];
        $components = &$bundleComponents['components'];

        if (isset($this->componentChildFactories[$className])) {
            $factory = $this->componentChildFactories[$className];

            $factory->create($bundleComponents, $arguments);
        } else {
            foreach ($bundleComponents['children'] as $childrenIdentifier => $childrenData) {
                $children = $this->createChildComponent(
                    $childrenData,
                    $renderContext,
                    $childrenIdentifier,
                    $arguments
                );
                $components[$childrenIdentifier] = $children;
            }
        }
        $components = array_filter($components);
        $componentArguments['components'] = $components;

        if (isset($componentArguments['block']) && !$componentArguments['block']) {
            return null;
        }

        if (!isset($componentArguments['context'])) {
            $componentArguments['context'] = $renderContext;
        }

        return $this->objectManager->create($className, $componentArguments);
    }

getBundleChildren()

getBundleChildren ( array  $children = [] )

protected

Get bundle children

Parameters

array

$children

Returns

array

Exceptions

LocalizedException

Since

100.1.0

Definition at line 263 of file UiComponentFactory.php.

    {
        $bundleChildren = [];

        foreach ($children as $identifier => $config) {
            if (!isset($config['componentType'])) {
                throw new LocalizedException(new Phrase(
                    'The "componentType" configuration parameter is required for the "%1" component.',
                    $identifier
                ));
            }

            if (!isset($componentArguments['context'])) {
                throw new LocalizedException(
                    new \Magento\Framework\Phrase(
                        'An error occurred with the UI component. Each component needs context. Verify and try again.'
                    )
                );
            }

            $rawComponentData = $this->definitionData->get($config['componentType']);
            list(, $componentArguments) = $this->argumentsResolver($identifier, $rawComponentData);
            $arguments = array_replace_recursive($componentArguments, ['data' => ['config' => $config]]);
            $rawComponentData[ManagerInterface::COMPONENT_ARGUMENTS_KEY] = $arguments;

            $bundleChildren[$identifier] = $rawComponentData;
            $bundleChildren[$identifier]['children'] = [];

            if (isset($arguments['data']['config']['children'])) {
                $bundleChildren[$identifier]['children'] = $this->getBundleChildren(
                    $arguments['data']['config']['children']
                );
            }
        }

        return $bundleChildren;
    }

getDataProvider()

getDataProvider (   $identifier, array  $bundleComponents  )

protected

Find and return data provider

Parameters

string	$identifier
array	$bundleComponents

Returns

DataProviderInterface|null

Since

100.1.0

Definition at line 426 of file UiComponentFactory.php.

    {
        foreach ($bundleComponents[$identifier]['children'] as $childrenData) {
            if (isset($childrenData['arguments']['dataProvider'])
                && $childrenData['arguments']['dataProvider'] instanceof DataProviderInterface
            ) {
                return $childrenData['arguments']['dataProvider'];
            }
        }

        return null;
    }

mergeMetadata()

mergeMetadata (   $identifier, array  $bundleComponents,   $reverseMerge = false  )

protected

Merge data provider's metadata to components

Parameters

string	$identifier
array	$bundleComponents
bool	$reverseMerge

Returns

array

Since

100.1.0

Definition at line 310 of file UiComponentFactory.php.

    {
        $dataProvider = $this->getDataProvider($identifier, $bundleComponents);
        if ($dataProvider instanceof DataProviderInterface) {
            $metadata = [
                $identifier => [
                    'children' => $dataProvider->getMeta(),
                ],
            ];
            $bundleComponents = $this->mergeMetadataItem($bundleComponents, $metadata, $reverseMerge);
        }

        return $bundleComponents;
    }

mergeMetadataElement()

mergeMetadataElement ( array  $bundleComponents,   $name, array  $data,   $reverseMerge = false  )

protected

Find element in components or its containers and merge data to it

Parameters

array	$bundleComponents
string	$name
array	$data
bool	$reverseMerge

Returns

array

Since

100.1.0

Definition at line 335 of file UiComponentFactory.php.

    {
        if (isset($bundleComponents[$name])) {
            $bundleComponents[$name] = $reverseMerge
                ? array_replace_recursive($data, $bundleComponents[$name])
                : array_replace_recursive($bundleComponents[$name], $data);
            return [$bundleComponents, true];
        } else {
            foreach ($bundleComponents as &$childData) {
                if (isset($childData['attributes']['class'])
                    && is_a($childData['attributes']['class'], \Magento\Ui\Component\Container::class, true)
                    && isset($childData['children']) && is_array($childData['children'])
                ) {
                    list($childData['children'], $isMerged) = $this->mergeMetadataElement(
                        $childData['children'],
                        $name,
                        $data,
                        $reverseMerge
                    );
                    if ($isMerged) {
                        return [$bundleComponents, true];
                    }
                }
            }
        }
        return [$bundleComponents, false];
    }

mergeMetadataItem()

mergeMetadataItem ( array  $bundleComponents, array  $metadata,   $reverseMerge = false  )

protected

Merge metadata item to components

Parameters

array	$bundleComponents
array	$metadata
bool	$reverseMerge

Returns

array

Exceptions

LocalizedException

Since

100.1.0

Definition at line 373 of file UiComponentFactory.php.

    {
        foreach ($metadata as $name => $data) {
            $selfData = $data;
            if (isset($selfData['children'])) {
                unset($selfData['children']);
            }

            list($bundleComponents, $isMerged) = $this->mergeMetadataElement(
                $bundleComponents,
                $name,
                $selfData,
                $reverseMerge
            );

            if (!$isMerged) {
                if (!isset($data['arguments']['data']['config']['componentType'])) {
                    throw new LocalizedException(new Phrase(
                        'The "componentType" configuration parameter is required for the "%1" component.',
                        [$name]
                    ));
                }
                $rawComponentData = $this->definitionData->get(
                    $data['arguments']['data']['config']['componentType']
                );
                list(, $componentArguments) = $this->argumentsResolver($name, $rawComponentData);
                $arguments = array_replace_recursive($componentArguments, $data['arguments']);
                $rawComponentData[ManagerInterface::COMPONENT_ARGUMENTS_KEY] = $arguments;

                $bundleComponents[$name] = $rawComponentData;
                $bundleComponents[$name]['children'] = [];
            }

            if (isset($data['children']) && is_array($data['children'])) {
                $bundleComponents[$name]['children'] = $this->mergeMetadataItem(
                    $bundleComponents[$name]['children'],
                    $data['children'],
                    $reverseMerge
                );
            }
        }

        return $bundleComponents;
    }

Field Documentation

$argumentInterpreter

$argumentInterpreter

protected

Definition at line 43 of file UiComponentFactory.php.

$componentManager

$componentManager

protected

Definition at line 56 of file UiComponentFactory.php.

$contextFactory

$contextFactory

protected

Definition at line 48 of file UiComponentFactory.php.

$objectManager

$objectManager

protected

Definition at line 36 of file UiComponentFactory.php.

---

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

• vendor/magento/framework/View/Element/UiComponentFactory.php