The RegexIterator class

Introduction

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

Class synopsis

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 */

__construct ( Iterator $iterator , string $regex [, int $mode [, int $flags [, int $preg_flags ]]] )

public bool accept ( void )

public int getFlags ( void )

public int getMode ( void )

public int getPregFlags ( void )

public void setFlags ( int $flags )

public void setMode ( int $mode )

public void setPregFlags ( int $preg_flags )

/* Inherited methods */

abstract bool FilterIterator::accept ( void )

FilterIterator::__construct ( Iterator $iterator )

mixed FilterIterator::current ( void )

Iterator FilterIterator::getInnerIterator ( void )

mixed FilterIterator::key ( void )

void FilterIterator::next ( void )

void FilterIterator::rewind ( void )

bool FilterIterator::valid ( void )

}

Predefined Constants

RegexIterator operation modes

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 Flags

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

RegexIterator::accept — Get accept status
RegexIterator::__construct — Create a new RegexIterator
RegexIterator::getFlags — Get flags
RegexIterator::getMode — Returns operation mode.
RegexIterator::getPregFlags — Returns the regular expression flags.
RegexIterator::setFlags — Sets the flags.
RegexIterator::setMode — Sets the operation mode.
RegexIterator::setPregFlags — Sets the regular expression flags.

RecursiveTreeIterator::valid

RegexIterator::accept

Iterators

PHP Manual

docs.sk

comprehensive documentation repository