KeyedIterator

:::info[Note] This is a point-in-time snapshot of the API documentation from January 2026. Going forward, we will not be maintaining a public copy of these references, and recommend users to refer to the built-in signature helpers available in the Hack LSP instead for complete and up-to-date information. :::

For those entities that are KeyedTraversable, the KeyedIterator interfaces provides the methods of iteration, included being able to get the key

If a class implements KeyedIterator, then it provides the infrastructure to be iterated over using a foreach loop.

Guides

• Introduction
• Interfaces

Interface Synopsis

namespace HH;

interface KeyedIterator implements Iterator<Tv>, KeyedTraversable<Tk, Tv> {...}

Public Methods

• ->key(): Tk
  Return the current key at the current iterator position

Public Methods (HH\Iterator)

• ->current(): Tv
  ( excerpt from http://php.net/manual/en/iterator.current.php )
• ->next(): void
  ( excerpt from http://php.net/manual/en/iterator.next.php )
• ->rewind(): void
  ( excerpt from http://php.net/manual/en/iterator.rewind.php )
• ->valid(): bool
  ( excerpt from http://php.net/manual/en/iterator.valid.php )