123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151 |
- <?php
- /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
- */
- namespace Magento\Config\Model\Config\Structure\Element;
- /**
- * @api
- * @since 100.0.2
- */
- class Iterator implements \Iterator
- {
- /**
- * List of element data
- *
- * @var \Magento\Config\Model\Config\StructureElementInterface[]
- */
- protected $_elements;
- /**
- * Config structure element flyweight
- *
- * @var \Magento\Config\Model\Config\Structure\AbstractElement
- */
- protected $_flyweight;
- /**
- * Configuration scope
- *
- * @var string
- */
- protected $_scope;
- /**
- * Last element id
- *
- * @var string
- */
- protected $_lastId;
- /**
- * @param \Magento\Config\Model\Config\Structure\AbstractElement $element
- */
- public function __construct(\Magento\Config\Model\Config\Structure\AbstractElement $element)
- {
- $this->_flyweight = $element;
- }
- /**
- * Set element data
- *
- * @param array $elements
- * @param string $scope
- * @return void
- */
- public function setElements(array $elements, $scope)
- {
- $this->_elements = $elements;
- $this->_scope = $scope;
- if (count($elements)) {
- $lastElement = end($elements);
- $this->_lastId = $lastElement['id'];
- }
- }
- /**
- * Return the current element
- *
- * @return \Magento\Config\Model\Config\StructureElementInterface
- */
- public function current()
- {
- return $this->_flyweight;
- }
- /**
- * Move forward to next element
- *
- * @return void Any returned value is ignored.
- */
- public function next()
- {
- next($this->_elements);
- if (current($this->_elements)) {
- $this->_initFlyweight(current($this->_elements));
- if (!$this->current()->isVisible()) {
- $this->next();
- }
- }
- }
- /**
- * Initialize current flyweight
- *
- * @param array $element
- * @return void
- */
- protected function _initFlyweight(array $element)
- {
- $this->_flyweight->setData($element, $this->_scope);
- }
- /**
- * Return the key of the current element
- *
- * @return void
- */
- public function key()
- {
- key($this->_elements);
- }
- /**
- * Checks if current position is valid
- *
- * @return bool The return value will be casted to boolean and then evaluated.
- * Returns true on success or false on failure.
- */
- public function valid()
- {
- return (bool)current($this->_elements);
- }
- /**
- * Rewind the \Iterator to the first element
- *
- * @return void Any returned value is ignored.
- */
- public function rewind()
- {
- reset($this->_elements);
- if (current($this->_elements)) {
- $this->_initFlyweight(current($this->_elements));
- if (!$this->current()->isVisible()) {
- $this->next();
- }
- }
- }
- /**
- * Check whether element is last in list
- *
- * @param \Magento\Config\Model\Config\Structure\ElementInterface $element
- * @return bool
- */
- public function isLast(\Magento\Config\Model\Config\Structure\ElementInterface $element)
- {
- return $element->getId() == $this->_lastId;
- }
- }
|