Container Class Reference

Inheritance diagram for Container:

Public Member Functions
	getType ()
	process (Layout\Reader\Context $readerContext, Layout\Generator\Context $generatorContext)
	generateContainer (Layout\Data\Structure $structure, $elementName, $options)
Public Member Functions inherited from GeneratorInterface
	process (Reader\Context $readerContext, Generator\Context $generatorContext)

Data Fields
const	CONTAINER_OPT_HTML_TAG = 'htmlTag'
const	CONTAINER_OPT_HTML_CLASS = 'htmlClass'
const	CONTAINER_OPT_HTML_ID = 'htmlId'
const	CONTAINER_OPT_LABEL = 'label'
const	TYPE = 'container'

Protected Member Functions
	validateOptions ($options)

Protected Attributes
	$allowedTags

Detailed Description

Definition at line 10 of file Container.php.

Member Function Documentation

generateContainer()

generateContainer	(	Layout\Data\Structure	$structure,
			$elementName,
			$options
	)

Set container-specific data to structure element

Parameters

\Magento\Framework\View\Layout\Data\Structure	$structure
string	$elementName
array	$options

Returns

void

Definition at line 83 of file Container.php.

      {
        unset($options['type']);

        $this->validateOptions($options);

        foreach ($options as $key => $value) {
            $structure->setAttribute($elementName, $key, $value);
        }
    }

getType()

getType

(

)

{Return type of generator

Returns

string

}

Returns

string

Implements GeneratorInterface.

Definition at line 49 of file Container.php.

    {
        return self::TYPE;
    }

process()

process	(	Layout\Reader\Context	$readerContext,
		Layout\Generator\Context	$generatorContext
	)

Process container elements

Parameters

\Magento\Framework\View\Layout\Reader\Context	$readerContext
Context	$generatorContext

Returns

$this

Definition at line 61 of file Container.php.

    {
        $structure = $generatorContext->getStructure();
        $scheduledStructure = $readerContext->getScheduledStructure();
        foreach ($scheduledStructure->getElements() as $elementName => $element) {
            list($type, $data) = $element;
            if ($type === self::TYPE) {
                $this->generateContainer($structure, $elementName, $data['attributes']);
                $scheduledStructure->unsetElement($elementName);
            }
        }
        return $this;
    }

validateOptions()

validateOptions (   $options )

protected

Parameters

array

$options

Returns

void

Exceptions

Definition at line 102 of file Container.php.

    {
        if (!empty($options[Layout\Element::CONTAINER_OPT_HTML_TAG])
            && !in_array(
                $options[Layout\Element::CONTAINER_OPT_HTML_TAG],
                $this->allowedTags
            )
        ) {
            throw new \Magento\Framework\Exception\LocalizedException(
                new \Magento\Framework\Phrase(
                    'Html tag "%1" is forbidden for usage in containers. Consider to use one of the allowed: %2.',
                    [$options[Layout\Element::CONTAINER_OPT_HTML_TAG], implode(', ', $this->allowedTags)]
                )
            );
        }

        if (empty($options[Layout\Element::CONTAINER_OPT_HTML_TAG])
            && (
                !empty($options[Layout\Element::CONTAINER_OPT_HTML_ID])
                || !empty($options[Layout\Element::CONTAINER_OPT_HTML_CLASS])
            )
        ) {
            throw new \Magento\Framework\Exception\LocalizedException(
                new \Magento\Framework\Phrase('HTML ID or class will not have effect, if HTML tag is not specified.')
            );
        }
    }

Field Documentation

$allowedTags

$allowedTags

protected

Initial value:

= [
        'aside',
        'dd',
        'div',
        'dl',
        'fieldset',
        'main',
        'nav',
        'header',
        'footer',
        'ol',
        'p',
        'section',
        'table',
        'tfoot',
        'ul',
    ]

Definition at line 26 of file Container.php.

CONTAINER_OPT_HTML_CLASS

const CONTAINER_OPT_HTML_CLASS = 'htmlClass'

Definition at line 16 of file Container.php.

CONTAINER_OPT_HTML_ID

const CONTAINER_OPT_HTML_ID = 'htmlId'

Definition at line 17 of file Container.php.

CONTAINER_OPT_HTML_TAG

const CONTAINER_OPT_HTML_TAG = 'htmlTag'

#+ Names of container options in layout

Definition at line 15 of file Container.php.

CONTAINER_OPT_LABEL

const CONTAINER_OPT_LABEL = 'label'

Definition at line 18 of file Container.php.

TYPE

const TYPE = 'container'

#-

Definition at line 21 of file Container.php.

---

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

• vendor/magento/framework/View/Layout/Generator/Container.php