How does \Magento\Ui\Model\Manager::prepareData() work?

dmitrii_fediuk · April 19, 2016, 9:27am

magento/magento2/blob/1aa5f73e/app/code/Magento/Ui/Model/Manager.php#L147-L154


/**
 * Prepare the initialization data of UI components
 *
 * @param string $name
 * @return ManagerInterface
 * @throws \Magento\Framework\Exception\LocalizedException
 */
public function prepareData($name)

github.com

magento/magento2/blob/1aa5f73e/app/code/Magento/Ui/Model/Manager.php#L253-L259


/**
 * Initialize the new component data
 *
 * @param string $name
 * @return void
 */
protected function prepare($name)

github.com

magento/magento2/blob/1aa5f73e/app/code/Magento/Ui/Model/Manager.php#L230-L236


/**
 * Get UIReader and collect base files configuration
 *
 * @param string $name
 * @return UiReaderInterface
 */
public function getReader($name)

github.com

magento/magento2/blob/1aa5f73e/app/code/Magento/Ui/Model/Manager.php#L240-L247


$this->uiReader[$name] =  $this->readerFactory->create(
    [
        'fileCollector' => $this->aggregatedFileCollectorFactory->create(
            ['searchPattern' => sprintf(ManagerInterface::SEARCH_PATTERN, $name)]
        ),
        'domMerger' => $this->domMerger
    ]
);

github.com

magento/magento2/blob/1aa5f73e/lib/internal/Magento/Framework/View/Element/UiComponent/Config/ManagerInterface.php#L13-L16


/**
 * Search pattern
 */
const SEARCH_PATTERN = '%s.xml';

app/code/Magento/Customer/view/base/ui_component/customer_form.xml

github.com

magento/magento2/blob/1aa5f73e/app/code/Magento/Ui/Model/Manager.php#L262-L268


$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]);

github.com

magento/magento2/blob/1aa5f73e/app/code/Magento/Ui/Model/Manager.php#L272-L279


/**
 * Create data for component instance
 *
 * @param string $name
 * @param array $componentsPool
 * @return array
 */
protected function createDataForComponent($name, array $componentsPool)

github.com

magento/magento2/blob/1aa5f73e/app/code/Magento/Ui/Model/Manager.php#L281-L285


$createdComponents = [];
$rootComponent = $this->createRawComponentData($name, false);
foreach ($componentsPool as $key => $component) {
    $resultConfiguration = [ManagerInterface::CHILDREN_KEY => []];
    $instanceName = $this->createName($component, $key, $name);

github.com

magento/magento2/blob/1aa5f73e/lib/internal/Magento/Framework/View/Element/UiComponent/Config/ManagerInterface.php#L33-L36


/**
 * The array key sub components
 */
const CHILDREN_KEY = 'children';

github.com

magento/magento2/blob/1aa5f73e/app/code/Magento/Ui/Model/Manager.php#L361-L374


/**
 * Create name component instance
 *
 * @param array $componentData
 * @param string|int $key
 * @param string $componentName
 * @return string
 */
protected function createName(array $componentData, $key, $componentName)
{
    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);
}

github.com

magento/magento2/blob/1aa5f73e/lib/internal/Magento/Framework/View/Element/UiComponent/Config/Converter.php#L16-L19


/**
 * The key attributes of a node
 */
const DATA_ATTRIBUTES_KEY = '@attributes';

github.com

magento/magento2/blob/1aa5f73e/lib/internal/Magento/Framework/View/Element/UiComponent/Config/Converter.php#L31-L34


/**
 * Key name attribute value
 */
const NAME_ATTRIBUTE_KEY = 'name';

github.com

magento/magento2/blob/1aa5f73e/lib/internal/Magento/Framework/View/Element/UiComponent/Config/ManagerInterface.php#L18-L21


/**
 * The anonymous template name
 */
const ANONYMOUS_TEMPLATE = 'anonymous_%s_component_%d';

The method’s result:

github.com

magento/magento2/blob/1aa5f73e/app/code/Magento/Ui/Model/Manager.php#L286-L289


$resultConfiguration[ManagerInterface::COMPONENT_ARGUMENTS_KEY] = $this->mergeArguments(
    $component,
    $rootComponent
);

github.com

magento/magento2/blob/1aa5f73e/app/code/Magento/Ui/Model/Manager.php#L322-L329


/**
 * Merge component arguments
 *
 * @param array $componentData
 * @param array $rootComponentData
 * @return array
 */
protected function mergeArguments(array $componentData, array $rootComponentData)

github.com

magento/magento2/blob/1aa5f73e/app/code/Magento/Ui/Model/Manager.php#L331-L338


$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);

github.com

magento/magento2/blob/1aa5f73e/app/code/Magento/Ui/Model/Manager.php#L290-L294


unset($component[Converter::DATA_ARGUMENTS_KEY]);
$resultConfiguration[ManagerInterface::COMPONENT_ATTRIBUTES_KEY] = $this->mergeAttributes(
    $component,
    $rootComponent
);

github.com

magento/magento2/blob/1aa5f73e/app/code/Magento/Ui/Model/Manager.php#L341-L356


/**
 * Merge component attributes
 *
 * @param array $componentData
 * @param array $rootComponentData
 * @return array
 */
protected function mergeAttributes(array $componentData, array $rootComponentData)
{
    $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']);

github.com

magento/magento2/blob/1aa5f73e/app/code/Magento/Ui/Model/Manager.php#L358-L358


return array_replace_recursive($baseAttributes, $componentAttributes);

github.com

magento/magento2/blob/1aa5f73e/app/code/Magento/Ui/Model/Manager.php#L295-L303


unset($component[Converter::DATA_ATTRIBUTES_KEY]);


// Create inner components
foreach ($component as $subComponentName => $subComponent) {
    $resultConfiguration[ManagerInterface::CHILDREN_KEY] = array_merge(
        $resultConfiguration[ManagerInterface::CHILDREN_KEY],
        $this->createDataForComponent($subComponentName, $subComponent)
    );
}

github.com

magento/magento2/blob/1aa5f73e/app/code/Magento/Ui/Model/Manager.php#L279-L279


protected function createDataForComponent($name, array $componentsPool)

github.com

magento/magento2/blob/1aa5f73e/app/code/Magento/Ui/Model/Manager.php#L284-L285


$resultConfiguration = [ManagerInterface::CHILDREN_KEY => []];
$instanceName = $this->createName($component, $key, $name);

github.com

magento/magento2/blob/1aa5f73e/app/code/Magento/Ui/Model/Manager.php#L286-L289


$resultConfiguration[ManagerInterface::COMPONENT_ARGUMENTS_KEY] = $this->mergeArguments(
    $component,
    $rootComponent
);

github.com

magento/magento2/blob/1aa5f73e/app/code/Magento/Ui/Model/Manager.php#L290-L294


unset($component[Converter::DATA_ARGUMENTS_KEY]);
$resultConfiguration[ManagerInterface::COMPONENT_ATTRIBUTES_KEY] = $this->mergeAttributes(
    $component,
    $rootComponent
);

github.com

magento/magento2/blob/1aa5f73e/app/code/Magento/Ui/Model/Manager.php#L295-L298


unset($component[Converter::DATA_ATTRIBUTES_KEY]);


// Create inner components
foreach ($component as $subComponentName => $subComponent) {

github.com

magento/magento2/blob/1aa5f73e/app/code/Magento/Ui/Model/Manager.php#L310-L320


/**
 * Add a component into pool
 *
 * @param string $instanceName
 * @param array $configuration
 * @return void
 */
protected function addComponentIntoPool($instanceName, array $configuration)
{
    $this->componentsPool->offsetSet($instanceName, $configuration);
}

github.com

magento/magento2/blob/1aa5f73e/app/code/Magento/Ui/Model/Manager.php#L174-L175


$this->componentsData->offsetSet($name, $this->componentsPool);
$this->componentsData->offsetSet($name, $this->evaluateComponentArguments($this->getData($name)));

github.com

magento/magento2/blob/1aa5f73e/app/code/Magento/Ui/Model/Manager.php#L180-L195


/**
 * Evaluated components data
 *
 * @param array $components
 * @return array
 */
protected function evaluateComponentArguments($components)
{
    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]
        );

After several cycles of recursion:

github.com

magento/magento2/blob/1aa5f73e/app/code/Magento/Ui/Model/Manager.php#L189-L189


foreach ($component[ManagerInterface::COMPONENT_ARGUMENTS_KEY] as $argumentName => $argument) {

github.com

magento/magento2/blob/1aa5f73e/app/code/Magento/Ui/Model/Manager.php#L190-L191


$component[ManagerInterface::COMPONENT_ARGUMENTS_KEY][$argumentName]
    = $this->argumentInterpreter->evaluate($argument);

github.com

magento/magento2/blob/1aa5f73e/lib/internal/Magento/Framework/Data/Argument/Interpreter/Composite.php#L47-L51


/**
 * {@inheritdoc}
 * @throws \InvalidArgumentException
 */
public function evaluate(array $data)

github.com

magento/magento2/blob/1aa5f73e/lib/internal/Magento/Framework/Data/Argument/Interpreter/Composite.php#L58-L58


$interpreterName = $data[$this->discriminator];

github.com

magento/magento2/blob/1aa5f73e/lib/internal/Magento/Framework/Data/Argument/Interpreter/Composite.php#L59-L60


unset($data[$this->discriminator]);
$interpreter = $this->getInterpreter($interpreterName);

github.com

magento/magento2/blob/1aa5f73e/app/code/Magento/Ui/etc/di.xml#L11-L11


<preference for="Magento\Framework\Data\Argument\InterpreterInterface" type="Magento\Framework\Data\Argument\Interpreter\Composite" />

github.com

magento/magento2/blob/1aa5f73e/app/code/Magento/Ui/etc/di.xml#L187-L191


<virtualType name="arrayArgumentInterpreterProxy" type="Magento\Framework\Data\Argument\InterpreterInterface\Proxy">
    <arguments>
        <argument name="instanceName" xsi:type="string">Magento\Framework\Data\Argument\Interpreter\ArrayType</argument>
    </arguments>
</virtualType>

github.com

magento/magento2/blob/1aa5f73e/app/etc/di.xml#L404-L413


<virtualType name="layoutArrayArgumentReaderInterpreter" type="Magento\Framework\Data\Argument\Interpreter\ArrayType">
    <arguments>
        <argument name="itemInterpreter" xsi:type="object">layoutArgumentReaderInterpreter</argument>
    </arguments>
</virtualType>
<virtualType name="layoutArrayArgumentGeneratorInterpreter" type="Magento\Framework\Data\Argument\Interpreter\ArrayType">
    <arguments>
        <argument name="itemInterpreter" xsi:type="object">layoutArgumentGeneratorInterpreterInternal</argument>
    </arguments>
</virtualType>

github.com

magento/magento2/blob/1aa5f73e/lib/internal/Magento/Framework/Data/Argument/Interpreter/Composite.php#L61-L61


return $interpreter->evaluate($data);

github.com

magento/magento2/blob/1aa5f73e/lib/internal/Magento/Framework/Data/Argument/Interpreter/ArrayType.php#L30-L35


/**
 * {@inheritdoc}
 * @return array
 * @throws \InvalidArgumentException
 */
public function evaluate(array $data)

github.com

magento/magento2/blob/1aa5f73e/lib/internal/Magento/Framework/Data/Argument/Interpreter/ArrayType.php#L37-L42


$items = isset($data['item']) ? $data['item'] : [];
if (!is_array($items)) {
    throw new \InvalidArgumentException('Array items are expected.');
}
$result = [];
foreach ($items as $itemKey => $itemData) {

github.com

magento/magento2/blob/1aa5f73e/lib/internal/Magento/Framework/Data/Argument/Interpreter/Composite.php#L51-L51


public function evaluate(array $data)

github.com

magento/magento2/blob/1aa5f73e/lib/internal/Magento/Framework/Data/Argument/Interpreter/Composite.php#L58-L60


$interpreterName = $data[$this->discriminator];
unset($data[$this->discriminator]);
$interpreter = $this->getInterpreter($interpreterName);

github.com

magento/magento2/blob/1aa5f73e/lib/internal/Magento/Framework/Data/Argument/Interpreter/ArrayType.php#L35-L35


public function evaluate(array $data)

github.com

magento/magento2/blob/1aa5f73e/lib/internal/Magento/Framework/Data/Argument/Interpreter/ArrayType.php#L42-L42


foreach ($items as $itemKey => $itemData) {

github.com

magento/magento2/blob/1aa5f73e/lib/internal/Magento/Framework/Data/Argument/Interpreter/Composite.php#L51-L51


public function evaluate(array $data)

github.com

magento/magento2/blob/1aa5f73e/lib/internal/Magento/Framework/Data/Argument/Interpreter/Composite.php#L58-L60


$interpreterName = $data[$this->discriminator];
unset($data[$this->discriminator]);
$interpreter = $this->getInterpreter($interpreterName);

github.com

magento/magento2/blob/1aa5f73e/lib/internal/Magento/Framework/Data/Argument/Interpreter/StringUtils.php#L29-L34


/**
 * {@inheritdoc}
 * @return string
 * @throws \InvalidArgumentException
 */
public function evaluate(array $data)

github.com

magento/magento2/blob/1aa5f73e/lib/internal/Magento/Framework/Data/Argument/Interpreter/StringUtils.php#L36-L48


if (isset($data['value'])) {
    $result = $data['value'];
    if (!is_string($result)) {
        throw new \InvalidArgumentException('String value is expected.');
    }
    $needTranslation = isset($data['translate']) ? $this->booleanUtils->toBoolean($data['translate']) : false;
    if ($needTranslation) {
        $result = (string)new \Magento\Framework\Phrase($result);
    }
} else {
    $result = '';
}
return $result;