The RegexIterator class

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

    Introduction

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

    Class synopsis

    classRegexIteratorextendsFilterIterator {
    publicconstintUSE_KEY;
    publicconstintINVERT_MATCH;
    publicconstintMATCH;
    publicconstintGET_MATCH;
    publicconstintALL_MATCHES;
    publicconstintSPLIT;
    publicconstintREPLACE;
    public?string$replacement = null;
    public__construct(
        Iterator$iterator,
        string$pattern,
        int$mode = RegexIterator::MATCH,
        int$flags = 0,
        int$pregFlags = 0
    )
    publicaccept(): bool
    publicgetFlags(): int
    publicgetMode(): int
    publicgetPregFlags(): int
    publicgetRegex(): string
    publicsetFlags(int$flags): void
    publicsetMode(int$mode): void
    publicsetPregFlags(int$pregFlags): void
    publicFilterIterator::accept(): bool
    publicFilterIterator::current(): mixed
    publicFilterIterator::key(): mixed
    publicFilterIterator::next(): void
    publicFilterIterator::rewind(): void
    publicFilterIterator::valid(): bool
    publicIteratorIterator::current(): mixed
    publicIteratorIterator::getInnerIterator(): ?Iterator
    publicIteratorIterator::key(): mixed
    publicIteratorIterator::next(): void
    publicIteratorIterator::rewind(): void
    publicIteratorIterator::valid(): bool
    }

    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::INVERT_MATCH

    Inverts the return value of RegexIterator::accept().

    Properties

    replacement

    Table of Contents

    To Top