Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/old/vendor/magento/framework/View/Layout/ |
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\View\Layout;
/**
* Layout structure model
*
* @api
* @since 100.0.2
*/
class ScheduledStructure
{
/**#@+
* Keys for array of elements to sort
*/
const ELEMENT_NAME = 'elementName';
const ELEMENT_PARENT_NAME = 'parentName';
const ELEMENT_OFFSET_OR_SIBLING = 'offsetOrSibling';
const ELEMENT_IS_AFTER = 'isAfter';
/**#@-*/
/**#@-*/
private $serializableProperties = [
'scheduledStructure',
'scheduledData',
'scheduledElements',
'scheduledMoves',
'scheduledRemoves',
'scheduledPaths',
'elementsToSort',
'brokenParent',
];
/**
* Information about structural elements, scheduled for creation
*
* @var array
*/
protected $scheduledStructure = [];
/**
* Scheduled structure data
*
* @var array
*/
protected $scheduledData = [];
/**
* Full information about elements to be populated in the layout structure after generating structure
*
* @var array
*/
protected $scheduledElements = [];
/**
* Scheduled structure elements moves
*
* @var array
*/
protected $scheduledMoves = [];
/**
* Scheduled structure elements removes
*
* @var array
*/
protected $scheduledRemoves = [];
/**
* Materialized paths for overlapping workaround of scheduled structural elements
*
* @var array
*/
protected $scheduledPaths = [];
/**
* Elements with reference to non-existing parent element
*
* @var array
*/
protected $brokenParent = [];
/**
* Elements that need to sort
*
* @var array
*/
protected $elementsToSort = [];
/**
* @param array $data
*/
public function __construct(array $data = [])
{
$this->populateWithArray($data);
}
/**
* Set elements to sort
*
* @param string $parentName
* @param string $elementName
* @param string|int|null $offsetOrSibling
* @param bool $isAfter
* @return void
*/
public function setElementToSortList($parentName, $elementName, $offsetOrSibling, $isAfter = true)
{
$this->elementsToSort[$elementName] = [
self::ELEMENT_NAME => $elementName,
self::ELEMENT_PARENT_NAME => $parentName,
self::ELEMENT_OFFSET_OR_SIBLING => $offsetOrSibling,
self::ELEMENT_IS_AFTER => $isAfter
];
}
/**
* Check if elements list of sorting is empty
*
* @return bool
*/
public function isListToSortEmpty()
{
return empty($this->elementsToSort);
}
/**
* Unset specified element from list of sorting
*
* @param string $elementName
* @return void
*/
public function unsetElementToSort($elementName)
{
unset($this->elementsToSort[$elementName]);
}
/**
* Get element to sort by name
*
* @param string $elementName
* @param array $default
* @return array
*/
public function getElementToSort($elementName, array $default = [])
{
return $this->elementsToSort[$elementName] ?? $default;
}
/**
* Get elements to sort
*
* @return array
*/
public function getListToSort()
{
return $this->elementsToSort;
}
/**
* Get elements to move
*
* @return array
*/
public function getListToMove()
{
return array_keys(array_intersect_key($this->scheduledElements, $this->scheduledMoves));
}
/**
* Get elements to remove
*
* @return array
*/
public function getListToRemove()
{
return array_keys(array_intersect_key(
$this->scheduledElements,
array_merge($this->scheduledRemoves, $this->brokenParent)
));
}
/**
* Get scheduled elements list
*
* @return array
*/
public function getElements()
{
return $this->scheduledElements;
}
/**
* Get element by name
*
* @param string $elementName
* @param array $default
* @return bool|array
*/
public function getElement($elementName, $default = [])
{
return $this->hasElement($elementName) ? $this->scheduledElements[$elementName] : $default;
}
/**
* Check if scheduled elements list is empty
*
* @return bool
*/
public function isElementsEmpty()
{
return empty($this->scheduledElements);
}
/**
* Add element to scheduled elements list
*
* @param string $elementName
* @param array $data
* @return void
*/
public function setElement($elementName, array $data)
{
$this->scheduledElements[$elementName] = $data;
}
/**
* Check if element present in scheduled elements list
*
* @param string $elementName
* @return bool
*/
public function hasElement($elementName)
{
return isset($this->scheduledElements[$elementName]);
}
/**
* Unset specified element from scheduled elements list
*
* @param string $elementName
* @return void
*/
public function unsetElement($elementName)
{
unset($this->scheduledElements[$elementName]);
}
/**
* Get element to move by name
*
* @param string $elementName
* @param mixed $default
* @return mixed
*/
public function getElementToMove($elementName, $default = null)
{
return $this->scheduledMoves[$elementName] ?? $default;
}
/**
* Add element to move list
*
* @param string $elementName
* @param array $data
* @return void
*/
public function setElementToMove($elementName, array $data)
{
$this->scheduledMoves[$elementName] = $data;
}
/**
* Unset removed element by name
*
* @param string $elementName
* @return void
*/
public function unsetElementFromListToRemove($elementName)
{
unset($this->scheduledRemoves[$elementName]);
}
/**
* Set removed element value
*
* @param string $elementName
* @return void
*/
public function setElementToRemoveList($elementName)
{
$this->scheduledRemoves[$elementName] = 1;
}
/**
* Get scheduled structure
*
* @return array
*/
public function getStructure()
{
return $this->scheduledStructure;
}
/**
* Get element of scheduled structure
*
* @param string $elementName
* @param mixed|null $default
* @return mixed
*/
public function getStructureElement($elementName, $default = null)
{
return $this->hasStructureElement($elementName) ? $this->scheduledStructure[$elementName] : $default;
}
/**
* Check if scheduled structure is empty
*
* @return bool
*/
public function isStructureEmpty()
{
return empty($this->scheduledStructure);
}
/**
* Check if element present in scheduled structure elements list
*
* @param string $elementName
* @return bool
*/
public function hasStructureElement($elementName)
{
return isset($this->scheduledStructure[$elementName]);
}
/**
* Add element to scheduled structure elements list
*
* @param string $elementName
* @param array $data
* @return void
*/
public function setStructureElement($elementName, array $data)
{
$this->scheduledStructure[$elementName] = $data;
}
/**
* Unset scheduled structure element by name
*
* @param string $elementName
* @return void
*/
public function unsetStructureElement($elementName)
{
unset($this->scheduledStructure[$elementName]);
unset($this->scheduledData[$elementName]);
}
/**
* Get scheduled data for element
*
* @param string $elementName
* @param null $default
* @return null
*/
public function getStructureElementData($elementName, $default = null)
{
return $this->scheduledData[$elementName] ?? $default;
}
/**
* Set scheduled data for element
*
* @param string $elementName
* @param array $data
* @return void
*/
public function setStructureElementData($elementName, array $data)
{
$this->scheduledData[$elementName] = $data;
}
/**
* Get scheduled paths
*
* @return array
*/
public function getPaths()
{
return $this->scheduledPaths;
}
/**
* Get path from paths list
*
* @param string $elementName
* @param mixed $default
* @return mixed
*/
public function getPath($elementName, $default = null)
{
return $this->hasPath($elementName) ? $this->scheduledPaths[$elementName] : $default;
}
/**
* Check if element present in scheduled paths list
*
* @param string $elementName
* @return bool
*/
public function hasPath($elementName)
{
return isset($this->scheduledPaths[$elementName]);
}
/**
* Add element to scheduled paths elements list
*
* @param string $elementName
* @param string $data
* @return void
*/
public function setPathElement($elementName, $data)
{
$this->scheduledPaths[$elementName] = $data;
}
/**
* Unset scheduled paths element by name
*
* @param string $elementName
* @return void
*/
public function unsetPathElement($elementName)
{
unset($this->scheduledPaths[$elementName]);
}
/**
* Remove element from broken parent list
*
* @param string $elementName
* @return void
*/
public function unsetElementFromBrokenParentList($elementName)
{
unset($this->brokenParent[$elementName]);
}
/**
* Set element to broken parent list
*
* @param string $elementName
* @return void
*/
public function setElementToBrokenParentList($elementName)
{
$this->brokenParent[$elementName] = 1;
}
/**
* Flush scheduled paths list
*
* @return void
*/
public function flushPaths()
{
$this->scheduledPaths = [];
}
/**
* Flush scheduled structure list
*
* @return void
*/
public function flushScheduledStructure()
{
$this->flushPaths();
$this->scheduledElements = [];
$this->scheduledStructure = [];
}
/**
* Reformat 'Layout scheduled structure' to array.
*
* @return array
* @since 101.0.0
*/
public function __toArray()
{
$result = [];
foreach ($this->serializableProperties as $property) {
$result[$property] = $this->{$property};
}
return $result;
}
/**
* Update 'Layout scheduled structure' data.
*
* @param array $data
* @return void
* @since 101.0.0
*/
public function populateWithArray(array $data)
{
foreach ($this->serializableProperties as $property) {
$this->{$property} = $this->getArrayValueByKey($property, $data);
}
}
/**
* Get value from array by key.
*
* @param string $key
* @param array $array
* @return array
*/
private function getArrayValueByKey($key, array $array)
{
return $array[$key] ?? [];
}
}