Block Class Reference

Inheritance diagram for Block:

Public Member Functions
	__construct (Layout\ScheduledStructure\Helper $helper, Layout\Argument\Parser $argumentParser, Layout\ReaderPool $readerPool, InterpreterInterface $argumentInterpreter, Condition $conditionReader, $scopeType=null)
	getSupportedNodes ()
	interpret (Context $readerContext, Element $currentElement)
Public Member Functions inherited from ReaderInterface
	interpret (Reader\Context $readerContext, Element $element)

Data Fields
const	TYPE_BLOCK = 'block'
const	TYPE_REFERENCE_BLOCK = 'referenceBlock'
const	TYPE_ARGUMENTS = 'arguments'
const	TYPE_ACTION = 'action'
const	ATTRIBUTE_GROUP = 'group'
const	ATTRIBUTE_CLASS = 'class'
const	ATTRIBUTE_TEMPLATE = 'template'
const	ATTRIBUTE_TTL = 'ttl'
const	ATTRIBUTE_DISPLAY = 'display'
const	ATTRIBUTE_ACL = 'aclResource'

Protected Member Functions
	scheduleBlock (ScheduledStructure $scheduledStructure, Element $currentElement)
	mergeBlockAttributes (array $elementData, Element $currentElement)
	scheduleReference (ScheduledStructure $scheduledStructure, Element $currentElement)
	updateScheduledData ($currentElement, array &$data)
	getAttributes (Element $blockElement)
	getArguments (Element $blockElement)
	parseArguments (Element $node)
	evaluateArguments (Element $blockElement, array &$data)

Protected Attributes
	$attributes
	$helper
	$argumentParser
	$readerPool
	$scopeType
	$argumentInterpreter

Detailed Description

Block structure reader

Definition at line 17 of file Block.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Layout\ScheduledStructure\Helper	$helper,
		Layout\Argument\Parser	$argumentParser,
		Layout\ReaderPool	$readerPool,
		InterpreterInterface	$argumentInterpreter,
		Condition	$conditionReader,
			$scopeType = null
	)

Constructor

Parameters

Layout\ScheduledStructure\Helper	$helper
Layout\Argument\Parser	$argumentParser
Layout\ReaderPool	$readerPool
InterpreterInterface	$argumentInterpreter
Condition	$conditionReader
string | null	$scopeType

Definition at line 99 of file Block.php.

      {
        $this->helper = $helper;
        $this->argumentParser = $argumentParser;
        $this->readerPool = $readerPool;
        $this->scopeType = $scopeType;
        $this->argumentInterpreter = $argumentInterpreter;
        $this->conditionReader = $conditionReader;
    }

Member Function Documentation

evaluateArguments()

evaluateArguments ( Element  $blockElement, array &  $data  )

protected

Compute argument values

Parameters

Element	$blockElement
array	$data

Returns

void

Definition at line 363 of file Block.php.

    {
        $arguments = $this->getArguments($blockElement);
        foreach ($arguments as $argumentName => $argumentData) {
            if (isset($argumentData['updater'])) {
                continue;
            }
            $result = $this->argumentInterpreter->evaluate($argumentData);
            if (is_array($result)) {
                $data['arguments'][$argumentName] = isset($data['arguments'][$argumentName])
                    ? array_replace_recursive($data['arguments'][$argumentName], $result)
                    : $result;
            } else {
                $data['arguments'][$argumentName] = $result;
            }
        }
    }

getArguments()

getArguments ( Element  $blockElement )

protected

Get block arguments

Parameters

Element

$blockElement

Returns

array

Definition at line 310 of file Block.php.

    {
        $arguments = $this->getElementsByType($blockElement, self::TYPE_ARGUMENTS);
        // We have only one declaration of <arguments> node in block or its reference
        $argumentElement = reset($arguments);
        return $argumentElement ? $this->parseArguments($argumentElement) : [];
    }

getAttributes()

getAttributes ( Element  $blockElement )

protected

Get block attributes

Parameters

Element

$blockElement

Returns

array

Definition at line 276 of file Block.php.

    {
        $attributes = [];
        foreach ($this->attributes as $attributeName) {
            $attributes[$attributeName] = (string)$blockElement->getAttribute($attributeName);
        }
        return $attributes;
    }

getSupportedNodes()

getSupportedNodes

(

)

{Get nodes types that current reader is support

Returns

string[]

}

Returns

string[]

Implements ReaderInterface.

Definition at line 120 of file Block.php.

    {
        return [self::TYPE_BLOCK, self::TYPE_REFERENCE_BLOCK];
    }

interpret()

interpret	(	Context	$readerContext,
		Element	$currentElement
	)

{}

Parameters

Context	$readerContext
Element	$currentElement
Element	$parentElement

Returns

$this

Definition at line 133 of file Block.php.

    {
        $scheduledStructure = $readerContext->getScheduledStructure();
        switch ($currentElement->getName()) {
            case self::TYPE_BLOCK:
                $this->scheduleBlock($scheduledStructure, $currentElement);
                break;
            case self::TYPE_REFERENCE_BLOCK:
                $this->scheduleReference($scheduledStructure, $currentElement);
                break;
            default:
                break;
        }
        $this->readerPool->interpret($readerContext, $currentElement);
        return $this;
    }

mergeBlockAttributes()

mergeBlockAttributes ( array  $elementData, Element  $currentElement  )

protected

Merge Block attributes

Parameters

array	$elementData
Element	$currentElement

Returns

array

Definition at line 184 of file Block.php.

    {
        $currentElement = $this->replaceDeprecatedAclKey($currentElement);
        if (isset($elementData['attributes'])) {
            $elementData['attributes'] = $this->replaceDeprecatedAclKey($elementData['attributes']);
            $keys = array_keys($elementData['attributes']);
            foreach ($keys as $key) {
                if (isset($currentElement[$key])) {
                    $elementData['attributes'][$key] = (string)$currentElement[$key];
                }
            }
        } else {
            $elementData['attributes'] = [
                self::ATTRIBUTE_CLASS    => (string)$currentElement[self::ATTRIBUTE_CLASS],
                self::ATTRIBUTE_GROUP    => (string)$currentElement[self::ATTRIBUTE_GROUP],
                self::ATTRIBUTE_TEMPLATE => (string)$currentElement[self::ATTRIBUTE_TEMPLATE],
                self::ATTRIBUTE_TTL      => (string)$currentElement[self::ATTRIBUTE_TTL],
                self::ATTRIBUTE_DISPLAY  => (string)$currentElement[self::ATTRIBUTE_DISPLAY],
                self::ATTRIBUTE_ACL  => (string)$currentElement[self::ATTRIBUTE_ACL],
            ];
        }
        return $elementData['attributes'];
    }

parseArguments()

parseArguments ( Element  $node )

protected

Parse argument nodes and return their array representation

Parameters

Element

$node

Returns

array

Definition at line 343 of file Block.php.

    {
        $nodeDom = dom_import_simplexml($node);
        $result = [];
        foreach ($nodeDom->childNodes as $argumentNode) {
            if ($argumentNode instanceof \DOMElement && $argumentNode->nodeName == 'argument') {
                $argumentName = $argumentNode->getAttribute('name');
                $result[$argumentName] = $this->argumentParser->parse($argumentNode);
            }
        }
        return $result;
    }

scheduleBlock()

scheduleBlock ( ScheduledStructure  $scheduledStructure, Element  $currentElement  )

protected

Process block element their attributes and children

Parameters

ScheduledStructure	$scheduledStructure
Element	$currentElement

Returns

void

Definition at line 157 of file Block.php.

      {
        $elementName = $this->helper->scheduleStructure(
            $scheduledStructure,
            $currentElement,
            $currentElement->getParent()
        );
        $data = $scheduledStructure->getStructureElementData($elementName, []);
        $data['attributes'] = $this->mergeBlockAttributes($data, $currentElement);
        $this->updateScheduledData($currentElement, $data);
        $this->evaluateArguments($currentElement, $data);
        $data['attributes'] = array_merge(
            $data['attributes'],
            ['visibilityConditions' => $this->conditionReader->parseConditions($currentElement)]
        );
        $scheduledStructure->setStructureElementData($elementName, $data);
    }

scheduleReference()

scheduleReference ( ScheduledStructure  $scheduledStructure, Element  $currentElement  )

protected

Schedule reference data

Parameters

ScheduledStructure	$scheduledStructure
Element	$currentElement

Returns

void

Definition at line 231 of file Block.php.

      {
        $elementName = $currentElement->getAttribute('name');
        $elementRemove = filter_var($currentElement->getAttribute('remove'), FILTER_VALIDATE_BOOLEAN);
        if ($elementRemove) {
            $scheduledStructure->setElementToRemoveList($elementName);
            return;
        } elseif ($currentElement->getAttribute('remove')) {
            $scheduledStructure->unsetElementFromListToRemove($elementName);
        }
        $data = $scheduledStructure->getStructureElementData($elementName, []);
        $data['attributes'] = $this->mergeBlockAttributes($data, $currentElement);
        $this->updateScheduledData($currentElement, $data);
        $this->evaluateArguments($currentElement, $data);
        $scheduledStructure->setStructureElementData($elementName, $data);
    }

updateScheduledData()

updateScheduledData (   $currentElement, array &  $data  )

protected

Update data for scheduled element

Parameters

Element	$currentElement
array	&$data

Returns

array

Definition at line 257 of file Block.php.

    {
        $actions = $this->getActions($currentElement);
        $arguments = $this->getArguments($currentElement);
        $data['actions'] = isset($data['actions'])
            ? array_merge($data['actions'], $actions)
            : $actions;
        $data['arguments'] = isset($data['arguments'])
            ? array_replace_recursive($data['arguments'], $arguments)
            : $arguments;
        return $data;
    }

Field Documentation

$argumentInterpreter

$argumentInterpreter

protected

Definition at line 76 of file Block.php.

$argumentParser

$argumentParser

protected

Definition at line 61 of file Block.php.

$attributes

$attributes

protected

Initial value:

= [
        self::ATTRIBUTE_GROUP,
        self::ATTRIBUTE_CLASS,
        self::ATTRIBUTE_TEMPLATE,
        self::ATTRIBUTE_TTL,
        self::ATTRIBUTE_DISPLAY
    ]

#- #-

Definition at line 45 of file Block.php.

$helper

$helper

protected

Definition at line 56 of file Block.php.

$readerPool

$readerPool

protected

Definition at line 66 of file Block.php.

$scopeType

$scopeType

protected

Definition at line 71 of file Block.php.

ATTRIBUTE_ACL

const ATTRIBUTE_ACL = 'aclResource'

Definition at line 41 of file Block.php.

ATTRIBUTE_CLASS

const ATTRIBUTE_CLASS = 'class'

Definition at line 37 of file Block.php.

ATTRIBUTE_DISPLAY

const ATTRIBUTE_DISPLAY = 'display'

Definition at line 40 of file Block.php.

ATTRIBUTE_GROUP

const ATTRIBUTE_GROUP = 'group'

#- #+ Names of block attributes in layout

Definition at line 36 of file Block.php.

ATTRIBUTE_TEMPLATE

const ATTRIBUTE_TEMPLATE = 'template'

Definition at line 38 of file Block.php.

ATTRIBUTE_TTL

const ATTRIBUTE_TTL = 'ttl'

Definition at line 39 of file Block.php.

TYPE_ACTION

const TYPE_ACTION = 'action'

Definition at line 30 of file Block.php.

TYPE_ARGUMENTS

const TYPE_ARGUMENTS = 'arguments'

#- #+ Supported subtypes for blocks

Definition at line 29 of file Block.php.

TYPE_BLOCK

const TYPE_BLOCK = 'block'

#+ Supported types

Definition at line 22 of file Block.php.

TYPE_REFERENCE_BLOCK

const TYPE_REFERENCE_BLOCK = 'referenceBlock'

Definition at line 23 of file Block.php.

---

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

• vendor/magento/framework/View/Layout/Reader/Block.php