vendor/symfony/form/Util/OrderedHashMapIterator.php line 149

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Form\Util;
  14. /**
  15.  * Iterator for {@link OrderedHashMap} objects.
  16.  *
  17.  * @author Bernhard Schussek <bschussek@gmail.com>
  18.  *
  19.  * @internal
  20.  */
  21. class OrderedHashMapIterator implements \Iterator
  22. {
  23.     /**
  24.      * @var array
  25.      */
  26.     private $elements;
  28.     /**
  29.      * @var array
  30.      */
  31.     private $orderedKeys;
  33.     /**
  34.      * @var int
  35.      */
  36.     private $cursor;
  38.     /**
  39.      * @var int
  40.      */
  41.     private $cursorId;
  43.     /**
  44.      * @var array
  45.      */
  46.     private $managedCursors;
  48.     /**
  49.      * @var string|int|null
  50.      */
  51.     private $key;
  53.     /**
  54.      * @var mixed
  55.      */
  56.     private $current;
  58.     /**
  59.      * @param array $elements       The elements of the map, indexed by their
  60.      *                              keys
  61.      * @param array $orderedKeys    The keys of the map in the order in which
  62.      *                              they should be iterated
  63.      * @param array $managedCursors An array from which to reference the
  64.      *                              iterator's cursor as long as it is alive.
  65.      *                              This array is managed by the corresponding
  66.      *                              {@link OrderedHashMap} instance to support
  67.      *                              recognizing the deletion of elements.
  68.      */
  69.     public function __construct(array &$elements, array &$orderedKeys, array &$managedCursors)
  70.     {
  71.         $this->elements = &$elements;
  72.         $this->orderedKeys = &$orderedKeys;
  73.         $this->managedCursors = &$managedCursors;
  74.         $this->cursorId = \count($managedCursors);
  76.         $this->managedCursors[$this->cursorId] = &$this->cursor;
  77.     }
  79.     public function __sleep()
  80.     {
  81.         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
  82.     }
  84.     public function __wakeup()
  85.     {
  86.         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
  87.     }
  89.     /**
  90.      * Removes the iterator's cursors from the managed cursors of the
  91.      * corresponding {@link OrderedHashMap} instance.
  92.      */
  93.     public function __destruct()
  94.     {
  95.         // Use array_splice() instead of unset() to prevent holes in the
  96.         // array indices, which would break the initialization of $cursorId
  97.         array_splice($this->managedCursors, $this->cursorId, 1);
  98.     }
  100.     /**
  101.      * {@inheritdoc}
  102.      */
  103.     public function current()
  104.     {
  105.         return $this->current;
  106.     }
  108.     /**
  109.      * {@inheritdoc}
  110.      */
  111.     public function next()
  112.     {
  113.         ++$this->cursor;
  115.         if (isset($this->orderedKeys[$this->cursor])) {
  116.             $this->key = $this->orderedKeys[$this->cursor];
  117.             $this->current = $this->elements[$this->key];
  118.         } else {
  119.             $this->key = null;
  120.             $this->current = null;
  121.         }
  122.     }
  124.     /**
  125.      * {@inheritdoc}
  126.      */
  127.     public function key()
  128.     {
  129.         if (null === $this->key) {
  130.             return null;
  131.         }
  133.         $array = [$this->key => null];
  135.         return key($array);
  136.     }
  138.     /**
  139.      * {@inheritdoc}
  140.      */
  141.     public function valid(): bool
  142.     {
  143.         return null !== $this->key;
  144.     }
  146.     /**
  147.      * {@inheritdoc}
  148.      */
  149.     public function rewind()
  150.     {
  151.         $this->cursor = 0;
  153.         if (isset($this->orderedKeys[0])) {
  154.             $this->key = $this->orderedKeys[0];
  155.             $this->current = $this->elements[$this->key];
  156.         } else {
  157.             $this->key = null;
  158.             $this->current = null;
  159.         }
  160.     }
  161. }