Layout.php 1.78 KB
Newer Older
Ketan's avatar
Ketan committed
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
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
namespace Magento\Ui\Component;

use Magento\Framework\View\Layout\Pool as LayoutPool;
use Magento\Framework\View\Element\Template;
use Magento\Framework\View\Element\UiComponent\LayoutInterface;
use Magento\Framework\View\Element\UiComponent\ContextInterface;

/**
 * Class Layout
 */
class Layout extends AbstractComponent
{
    const NAME = 'layout';

    /**
     * @var LayoutPool
     */
    protected $layoutPool;

    /**
     * @var string
     */
    protected $type;

    /**
     * @var LayoutInterface
     */
    protected $layoutTypeObject;

    /**
     * @var array
     */
    protected $structure = [];

    /**
     * Constructor
     *
     * @param ContextInterface $context
     * @param LayoutPool $layoutPool
     * @param string $type
     * @param array $components
     * @param array $data
     */
    public function __construct(
        ContextInterface $context,
        LayoutPool $layoutPool,
        $type,
        array $components = [],
        array $data = []
    ) {
        $this->layoutPool = $layoutPool;
        $this->type = $type;
        parent::__construct($context, $components, $data);
    }

    /**
     * Get component name
     *
     * @return string
     */
    public function getComponentName()
    {
        return static::NAME;
    }

    /**
     * Register component and build layout structure
     *
     * @inheritdoc
     */
    public function prepare()
    {
        $this->layoutTypeObject = $this->layoutPool->create($this->type);
        $this->structure = $this->layoutTypeObject->build($this);
        parent::prepare();
    }

    /**
     * @return array
     */
    public function getStructure()
    {
        return $this->structure;
    }
}