Skip to content

ChunkedIteratorAggregate

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

Splits an iterable into fixed-size chunks.

This iterator wraps a Traversable and groups elements into subarrays of a fixed size. If the total number of elements is not a multiple of the chunk size, the last chunk may contain fewer elements.

Usage Example:


Methods

__construct

Initializes the ChunkedIteratorAggregate.

public __construct(iterable $iterator, int $chunkSize): mixed

Parameters:

Parameter Type Description
$iterator iterable the iterator containing values to be chunked
$chunkSize int the number of elements per chunk (must be >= 1)

getIterator

Retrieves an iterator that yields arrays containing elements in chunks.

public getIterator(): \Traversable<int,array<int,mixed>>

The iteration groups elements from the original iterator into subarrays of $chunkSize elements each.

Return Value:

the iterator yielding chunked arrays


Inherited methods

count

Counts the number of elements exposed by the inner iterator.

public count(): int

If the inner iterator implements

  • See: \Countable, this method SHALL return the value provided by that implementation. Otherwise, it MUST count elements by iterating over the iterator. If the inner iterator is not cloneable, this method SHALL wrap the current object in an

  • See: \IteratorIterator instance and count through that wrapper to avoid performing an invalid clone operation. If the inner iterator is cloneable, this method SHOULD count over a clone so that the original iterator state is preserved as much as possible.

Return Value:

the total number of elements available from the inner iterator


Clone this wiki locally