The FilterIterator class

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

Introduction

This abstract iterator filters out unwanted values. This class should be extended to implement custom iterator filters. The FilterIterator::accept() must be implemented in the subclass.

Class synopsis

abstract class FilterIterator extends IteratorIterator {

/* Methods */

public __construct(Iterator $iterator)

public accept(): bool

public current(): mixed

public getInnerIterator(): Iterator

public key(): mixed

public next(): void

public rewind(): void

public valid(): bool

/* Inherited methods */

public IteratorIterator::current(): mixed

public IteratorIterator::getInnerIterator(): ?Iterator

public IteratorIterator::key(): mixed

public IteratorIterator::next(): void

public IteratorIterator::rewind(): void

public IteratorIterator::valid(): bool

}

FilterIterator::accept — Check whether the current element of the iterator is acceptable
FilterIterator::__construct — Construct a filterIterator
FilterIterator::current — Get the current element value
FilterIterator::getInnerIterator — Get the inner iterator
FilterIterator::key — Get the current key
FilterIterator::next — Move the iterator forward
FilterIterator::rewind — Rewind the iterator
FilterIterator::valid — Check whether the current element is valid