-
-
Notifications
You must be signed in to change notification settings - Fork 0
TrimIteratorIterator
An iterator that trims each value within a iterable.
This class extends ClosureIteratorIterator and applies trim()
to each element, removing leading and trailing characters based on
the specified character mask.
- Full name:
\FastForward\Iterator\TrimIteratorIterator - Parent class:
\FastForward\Iterator\ClosureIteratorIterator
Initializes the TrimIteratorIterator.
public __construct(iterable $iterator, string|null $characters = \self::DEFAULT_CHARACTERS): mixedParameters:
| 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. |
Counts the number of elements exposed by the inner iterator.
public count(): intIf 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
Initializes the ClosureIteratorIterator.
public __construct(iterable $iterator, \Closure $closure): mixedParameters:
| Parameter | Type | Description |
|---|---|---|
$iterator |
iterable | the underlying iterator to wrap |
$closure |
\Closure | the transformation function applied to each element |
Returns the current transformed element.
public current(): mixedThe closure is applied to the original current element of the iterator.
Return Value:
the transformed element