# A classe RegexIterator

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

## Introdução

Este iterador pode ser usado para filtrar outro iterador com base em uma expressão regular.

## Resumo da classe

class RegexIterator extends FilterIterator {
/* Constantes */
public const int USE_KEY;
public const int INVERT_MATCH;
public const int MATCH;
public const int GET_MATCH;
public const int ALL_MATCHES;
public const int SPLIT;
public const int REPLACE;
/* Propriedades */
public ?string $replacement = null;
/* Métodos */
public function __construct(
Iterator `$iterator`,
string `$pattern`,
int `$mode` = `RegexIterator::MATCH`,
int `$flags` = 0,
int `$pregFlags` = 0
)
public function accept(): bool
public function getFlags(): int
public function getMode(): int
public function getPregFlags(): int
public function getRegex(): string
public function setFlags(int `$flags`): void
public function setMode(int `$mode`): void
public function setPregFlags(int `$pregFlags`): void
/* Métodos herdados */
public function FilterIterator::accept(): bool
public function FilterIterator::current(): mixed
public function FilterIterator::key(): mixed
public function FilterIterator::next(): void
public function FilterIterator::rewind(): void
public function FilterIterator::valid(): bool
public function IteratorIterator::current(): mixed
public function IteratorIterator::getInnerIterator(): ?Iterator
public function IteratorIterator::key(): mixed
public function IteratorIterator::next(): void
public function IteratorIterator::rewind(): void
public function IteratorIterator::valid(): bool
}

## Constantes predefinidas

## Modos de Operação do RegexIterator

`RegexIterator::ALL_MATCHES`

  Retorna todas as correspondências para a entrada atual (veja preg_match_all()).

`RegexIterator::GET_MATCH`

  Retorna a primeira correspondência para a entrada atual (veja preg_match()).

`RegexIterator::MATCH`

  Execute somente a correspondência (filtro) para a entrada atual (veja preg_match()).

`RegexIterator::REPLACE`

  Substitui a entrada atual (veja preg_replace(); Não totalmente implementado ainda)

`RegexIterator::SPLIT`

  Retorna os valores divididos para a entrada atual (veja preg_split()).

## RegexIterator Flags

`RegexIterator::USE_KEY`

  Flag especial: Correspondência à chave da entrada em vez do valor da entrada.

`RegexIterator::INVERT_MATCH`

  Inverte o valor de retorno de RegexIterator::accept().

## Propriedades

replacement

## Índice

- RegexIterator::accept — Obtém o status de aceitação
- RegexIterator::__construct — Cria um novo RegexIterator
- RegexIterator::getFlags — Obtém opções
- RegexIterator::getMode — Retorna o modo de operação
- RegexIterator::getPregFlags — Retorna as opções da expressão regular
- RegexIterator::getRegex — Retorna a expressão regular atual
- RegexIterator::setFlags — Define as opções
- RegexIterator::setMode — Define o modo de operação
- RegexIterator::setPregFlags — Define as opções da expressão regular

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open