PHP Manual
Iterators
The RecursiveRegexIterator class

The RecursiveRegexIterator class

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

Introduction

This recursive iterator can filter another recursive iterator via a regular expression.

Class synopsis

class RecursiveRegexIterator extends RegexIterator implements RecursiveIterator {

/* Inherited constants */

const int MATCH = 0;

const int GET_MATCH = 1;

const int ALL_MATCHES = 2;

const int SPLIT = 3;

const int REPLACE = 4;

const int USE_KEY = 1;

/* Inherited properties */

public ?string $replacement = null;

/* Methods */

public __construct(
    RecursiveIterator $iterator,
    string $pattern,
    int $mode = RecursiveRegexIterator::MATCH,
    int $flags = 0,
    int $pregFlags = 0
)

public getChildren(): RecursiveRegexIterator

public hasChildren(): bool

/* Inherited methods */

public RegexIterator::accept(): bool

public RegexIterator::getFlags(): int

public RegexIterator::getMode(): int

public RegexIterator::getPregFlags(): int

public RegexIterator::getRegex(): string

public RegexIterator::setFlags(int $flags): void

public RegexIterator::setMode(int $mode): void

public RegexIterator::setPregFlags(int $pregFlags): void

public FilterIterator::accept(): bool

public FilterIterator::current(): mixed

public FilterIterator::getInnerIterator(): Iterator

public FilterIterator::key(): mixed

public FilterIterator::next(): void

public FilterIterator::rewind(): void

public FilterIterator::valid(): bool

public IteratorIterator::current(): mixed

public IteratorIterator::getInnerIterator(): ?Iterator

public IteratorIterator::key(): mixed

public IteratorIterator::next(): void

public IteratorIterator::rewind(): void

public IteratorIterator::valid(): bool

}

RecursiveRegexIterator::__construct — Creates a new RecursiveRegexIterator
RecursiveRegexIterator::getChildren — Returns an iterator for the current entry
RecursiveRegexIterator::hasChildren — Returns whether an iterator can be obtained for the current entry