Skip to content

TrimIteratorIterator

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

Class TrimIteratorIterator.

An iterator that trims each value within a Traversable.

This class extends ClosureIteratorIterator and applies trim() to each element, removing leading and trailing characters based on the specified character mask.

Usage Example:


Methods

__construct

Initializes the TrimIteratorIterator.

public __construct(iterable $iterator, string|null $characters = \self::DEFAULT_CHARACTERS): mixed

Parameters:

Parameter Type Description
$iterator iterable the iterator containing values to be trimmed
$characters string|null A string defining the characters to be trimmed.
Defaults to standard whitespace characters.

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


__construct

Initializes the ClosureIteratorIterator.

public __construct(iterable $iterator, \Closure $closure): mixed

Parameters:

Parameter Type Description
$iterator iterable the underlying iterator to wrap
$closure \Closure the transformation function applied to each element

current

Returns the current transformed element.

public current(): mixed

The closure is applied to the original current element of the iterator.

Return Value:

the transformed element


Clone this wiki locally