Structure Class Reference

Inheritance diagram for Structure:

Public Member Functions
	__construct (\Psr\Log\LoggerInterface $logger, State $state, array $elements=null)
	createStructuralElement ($name, $type, $class)
	reorderChildElement ($parentName, $childName, $offsetOrSibling, $after=true)

Protected Member Functions
	_generateAnonymousName ($class)
	_filterSearchMinus ($needle, array $haystack, $isLast)

Protected Attributes
	$_nameIncrement = []
	$logger
	$state

Detailed Description

An associative data structure, that features "nested set" parent-child relations

@api

Since

100.0.2

Definition at line 17 of file Structure.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Psr\Log\LoggerInterface	$logger,
		State	$state,
		array	$elements = null
	)

Constructor

Parameters

\Psr\Log\LoggerInterface	$logger
State	$state
array	$elements

Definition at line 43 of file Structure.php.

      {
        $this->logger = $logger;
        $this->state = $state;
        parent::__construct($elements);
    }

Member Function Documentation

_filterSearchMinus()

_filterSearchMinus (   $needle, array  $haystack,   $isLast  )

protected

Search for an array element using needle, but needle may be '-', which means "first" or "last" element

Returns first or last element in the haystack, or the $needle argument

Parameters

string	$needle
array	$haystack
bool	$isLast

Returns

string

Definition at line 147 of file Structure.php.

    {
        if ('-' === $needle) {
            if ($isLast) {
                return array_pop($haystack);
            }
            return array_shift($haystack);
        }
        return $needle;
    }

_generateAnonymousName()

_generateAnonymousName (   $class )

protected

Generate anonymous element name for structure

Parameters

string

$class

Returns

string

Definition at line 78 of file Structure.php.

    {
        $position = strpos($class, '\\Block\\');
        $key = $position !== false ? substr($class, $position + 7) : $class;
        $key = strtolower(trim($key, '_'));

        if (!isset($this->_nameIncrement[$key])) {
            $this->_nameIncrement[$key] = 0;
        }

        do {
            $name = $key . '_' . $this->_nameIncrement[$key]++;
        } while ($this->hasElement($name));

        return $name;
    }

createStructuralElement()

createStructuralElement	(		$name,
			$type,
			$class
	)

Register an element in structure

Will assign an "anonymous" name to the element, if provided with an empty name

Parameters

string	$name
string	$type
string	$class

Returns

string

Definition at line 63 of file Structure.php.

    {
        if (empty($name)) {
            $name = $this->_generateAnonymousName($class);
        }
        $this->createElement($name, ['type' => $type]);
        return $name;
    }

reorderChildElement()

reorderChildElement	(		$parentName,
			$childName,
			$offsetOrSibling,
			$after = true
	)

Reorder a child of a specified element

If $offsetOrSibling is null, it will put the element to the end If $offsetOrSibling is numeric (integer) value, it will put the element after/before specified position Otherwise – after/before specified sibling

Parameters

string	$parentName
string	$childName
string | int | null	$offsetOrSibling
bool	$after

Returns

void

Definition at line 108 of file Structure.php.

    {
        if (is_numeric($offsetOrSibling)) {
            $offset = (int)abs($offsetOrSibling) * ($after ? 1 : -1);
            $this->reorderChild($parentName, $childName, $offset);
        } elseif (null === $offsetOrSibling) {
            $this->reorderChild($parentName, $childName, null);
        } else {
            $children = array_keys($this->getChildren($parentName));
            if ($this->getChildId($parentName, $offsetOrSibling) !== false) {
                $offsetOrSibling = $this->getChildId($parentName, $offsetOrSibling);
            }
            $sibling = $this->_filterSearchMinus($offsetOrSibling, $children, $after);
            if ($childName !== $sibling) {
                $siblingParentName = $this->getParentId($sibling);
                if ($parentName !== $siblingParentName) {
                    if ($this->state->getMode() === State::MODE_DEVELOPER) {
                        $this->logger->info(
                            "Broken reference: the '{$childName}' tries to reorder itself towards '{$sibling}', but " .
                            "their parents are different: '{$parentName}' and '{$siblingParentName}' respectively."
                        );
                    }
                    return;
                }
                $this->reorderToSibling($parentName, $childName, $sibling, $after ? 1 : -1);
            }
        }
    }

Field Documentation

$_nameIncrement

$_nameIncrement = []

protected

Definition at line 24 of file Structure.php.

$logger

$logger

protected

Definition at line 29 of file Structure.php.

$state

$state

protected

Definition at line 34 of file Structure.php.

---

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

• vendor/magento/framework/View/Layout/Data/Structure.php