Php/docs/class.filteriterator

• PHP Manual
• Iterators
• The FilterIterator class

(PHP 5 >= 5.1.0, PHP 7)

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 FilterIterator extends IteratorIterator implements OuterIterator {

/* Methods */

public abstract accept ( ) : bool

public __construct ( Iterator $iterator )

public current ( ) : mixed

public getInnerIterator ( ) : Iterator

public key ( ) : mixed

public next ( ) : void

public rewind ( ) : void

public valid ( ) : bool

}

Table of Contents

• 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