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

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.     /**
  80.      * Removes the iterator's cursors from the managed cursors of the
  81.      * corresponding {@link OrderedHashMap} instance.
  82.      */
  83.     public function __destruct()
  84.     {
  85.         // Use array_splice() instead of unset() to prevent holes in the
  86.         // array indices, which would break the initialization of $cursorId
  87.         array_splice($this->managedCursors, $this->cursorId, 1);
  88.     }
  90.     /**
  91.      * {@inheritdoc}
  92.      */
  93.     public function current()
  94.     {
  95.         return $this->current;
  96.     }
  98.     /**
  99.      * {@inheritdoc}
  100.      */
  101.     public function next()
  102.     {
  103.         ++$this->cursor;
  105.         if (isset($this->orderedKeys[$this->cursor])) {
  106.             $this->key = $this->orderedKeys[$this->cursor];
  107.             $this->current = $this->elements[$this->key];
  108.         } else {
  109.             $this->key = null;
  110.             $this->current = null;
  111.         }
  112.     }
  114.     /**
  115.      * {@inheritdoc}
  116.      */
  117.     public function key()
  118.     {
  119.         if (null === $this->key) {
  120.             return null;
  121.         }
  123.         $array = [$this->key => null];
  125.         return key($array);
  126.     }
  128.     /**
  129.      * {@inheritdoc}
  130.      */
  131.     public function valid(): bool
  132.     {
  133.         return null !== $this->key;
  134.     }
  136.     /**
  137.      * {@inheritdoc}
  138.      */
  139.     public function rewind()
  140.     {
  141.         $this->cursor = 0;
  143.         if (isset($this->orderedKeys[0])) {
  144.             $this->key = $this->orderedKeys[0];
  145.             $this->current = $this->elements[$this->key];
  146.         } else {
  147.             $this->key = null;
  148.             $this->current = null;
  149.         }
  150.     }
  151. }