Skip to content

IterableIterator

github-actions edited this page Mar 31, 2026 · 3 revisions

Class IterableIterator.

A normalized iterator wrapper that ensures any iterable (array or Traversable) is treated as a standard \Iterator.

This utility class simplifies iterator interoperability by converting arrays into \ArrayIterator and wrapping \Traversable instances as needed. It SHALL be used when an \Iterator is expected but the input MAY be any iterable.

Example usage:

$items = new IterableIterator([1, 2, 3]);

foreach ($items as $item) {
    echo $item;
}
// Output: 123

Methods

__construct

Constructs an IterableIterator from any iterable input.

public __construct(iterable $iterable): mixed

Arrays are converted to \ArrayIterator; Traversables are passed directly.

Parameters:

Parameter Type Description
$iterable iterable the iterable to wrap as an \Iterator

Inherited methods

count

Counts the number of elements in the iterable.

public count(): int

If the inner iterator implements Countable, it uses that. Otherwise, it counts the elements by iterating through them.

Return Value:

the number of elements in the iterable


Clone this wiki locally