name: OrderedHashMapIterator
class_comment: '# * Iterator for {@link OrderedHashMap} objects.

  # *

  # * @author Bernhard Schussek <bschussek@gmail.com>

  # *

  # * @internal

  # *

  # * @template-covariant TValue

  # *

  # * @implements \Iterator<string, TValue>'
dependencies: []
properties: []
methods:
- name: __construct
  visibility: public
  parameters:
  - name: '&$elements'
  - name: '&$orderedKeys'
  - name: '&$managedCursors'
  comment: "# * Iterator for {@link OrderedHashMap} objects.\n# *\n# * @author Bernhard\
    \ Schussek <bschussek@gmail.com>\n# *\n# * @internal\n# *\n# * @template-covariant\
    \ TValue\n# *\n# * @implements \\Iterator<string, TValue>\n# */\n# class OrderedHashMapIterator\
    \ implements \\Iterator\n# {\n# private int $cursor = 0;\n# private int $cursorId;\n\
    # private ?string $key = null;\n# /** @var TValue|null */\n# private mixed $current\
    \ = null;\n# \n# /**\n# * @param TValue[]        $elements       The elements\
    \ of the map, indexed by their\n# *                                        keys\n\
    # * @param list<string>    $orderedKeys    The keys of the map in the order in\
    \ which\n# *                                        they should be iterated\n\
    # * @param array<int, int> $managedCursors An array from which to reference the\n\
    # *                                        iterator's cursor as long as it is\
    \ alive.\n# *                                        This array is managed by\
    \ the corresponding\n# *                                        {@link OrderedHashMap}\
    \ instance to support\n# *                                        recognizing\
    \ the deletion of elements."
- name: __sleep
  visibility: public
  parameters: []
  comment: null
- name: __wakeup
  visibility: public
  parameters: []
  comment: null
- name: __destruct
  visibility: public
  parameters: []
  comment: '# * Removes the iterator''s cursors from the managed cursors of the

    # * corresponding {@link OrderedHashMap} instance.'
- name: current
  visibility: public
  parameters: []
  comment: null
- name: next
  visibility: public
  parameters: []
  comment: null
- name: key
  visibility: public
  parameters: []
  comment: null
- name: valid
  visibility: public
  parameters: []
  comment: null
- name: rewind
  visibility: public
  parameters: []
  comment: null
traits: []
interfaces:
- \Iterator
- \Iterator