DocumentationHackReferenceClassHH\SetgetIterator

HH\Set::getIterator

Returns an iterator that points to beginning of the current Set

public function getIterator(): KeyedIterator<arraykey, Tv>;

Returns

KeyedIterator<arraykey,Tv> - A KeyedIterator that allows you to traverse the current Set.

Examples

This example shows how to get an iterator from a Set and how to consume it:

$s = Set {'red', 'green', 'blue', 'yellow'};

// Get an iterator for the Set of colors
$iterator = $s->getIterator();

// Print each color using the iterator
while ($iterator->valid()) {
  echo $iterator->current()."\n";
  $iterator->next();
}