RecursiveRegexIterator::hasChildren
RegexIterator::__construct
Iterators
PHP Manual

# The RegexIterator class

## Introduction

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

## Class synopsis

RegexIterator
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` ]]] )
int getFlags ( void )
int getMode ( void )
int getPregFlags ( void )
void setFlags ( int `$flags` )
void setMode ( int `$mode` )
void setPregFlags ( int `$preg_flags` )
/* Inherited methods */
abstract bool FilterIterator::accept ( void )
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 or the current key (see preg_replace()).

`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.

## Table of Contents

- RegexIterator::__construct — Creates a new RegexIterator.
- RegexIterator::getFlags — Returns the special flags.
- RegexIterator::getMode — Returns operation mode.
- RegexIterator::getPregFlags — Returns the regular expression flags.
- RegexIterator::setFlags — Sets the special flags.
- RegexIterator::setMode — Sets the operation mode.
- RegexIterator::setPregFlags — Sets the regular expression flags.

RecursiveRegexIterator::hasChildren
RegexIterator::__construct
Iterators
PHP Manual