The RegexIterator class

(PHP 5 >= 5.2.0, PHP 7)

Introduction

This iterator can be used to filter another iterator based on a regular expression.

RegexIterator extends FilterIterator {

/* Constants */

const integer MATCH = 0 ;

const integer GET_MATCH = 1 ;

const integer ALL_MATCHES = 2 ;

const integer SPLIT = 3 ;

const integer REPLACE = 4 ;

const integer USE_KEY = 1 ;

/* Methods */

public __construct ( Iterator $iterator , string $regex [, int $mode = self::MATCH [, int $flags = 0 [, int $preg_flags = 0 ]]] )

public accept ( void ) : bool

public getFlags ( void ) : int

public getMode ( void ) : int

public getPregFlags ( void ) : int

public getRegex ( void ) : string

public setFlags ( int $flags ) : void

public setMode ( int $mode ) : void

public setPregFlags ( int $preg_flags ) : void

/* Inherited methods */

public abstract FilterIterator::accept ( void ) : bool

public FilterIterator::__construct ( Iterator $iterator )

public FilterIterator::current ( void ) : mixed

public FilterIterator::key ( void ) : mixed

public FilterIterator::next ( void ) : void

public FilterIterator::rewind ( void ) : void

public FilterIterator::valid ( void ) : bool

}

RegexIterator::ALL_MATCHES: Return all matches for the current entry (see preg_match_all()).
RegexIterator::GET_MATCH: Return the first match for the current entry (see preg_match()).
RegexIterator::MATCH: Only execute match (filter) for the current entry (see preg_match()).
RegexIterator::REPLACE: Replace the current entry (see preg_replace(); Not fully implemented yet)
RegexIterator::SPLIT: Returns the split values for the current entry (see preg_split()).

RegexIterator::USE_KEY: Special flag: Match the entry key instead of the entry value.