HH\KeyedIterator

The HH\KeyedIterator<Tk,Tv> interface

This page is a quick reference for people already familiar with the class. If this is new to you, we strongly recommend reading the introductory guides first:

• Collections: Introduction
• Collections: Interfaces

---

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.

Interface synopsis

interface KeyedIterator implements KeyedTraversable, Iterator {...}

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