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 __construct(
    Iterator $iterator,
    string $pattern,
    int $mode = RegexIterator::MATCH,
    int $flags = 0,
    int $pregFlags = 0
)
public accept(): bool
public getFlags(): int
public getMode(): int
public getPregFlags(): int
public getRegex(): string
public setFlags(int $flags): void
public setMode(int $mode): void
public setPregFlags(int $pregFlags): void
/* Métodos herdados */
}

Constantes pré-definidas

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

add a note

User Contributed Notes 2 notes

up
33
jinmoku at hotmail dot com
13 years ago
An exemple :

<?php
$a
= new ArrayIterator(array('test1', 'test2', 'test3'));
$i = new RegexIterator($a, '/^(test)(\d+)/', RegexIterator::REPLACE);
$i->replacement = '$2:$1';

print_r(iterator_to_array($i));
/*
Array
(
[0] => 1:test
[1] => 2:test
[2] => 3:test
)
*/
?>
up
2
chris dot snyder at totara dot com
1 year ago
In case the difference between modes RegexIterator::MATCH and RegexIterator::GET_MATCH is not immediately clear:

MATCH will only return one value per matched element, as a string.

GET_MATCH will return as many values, per matched element, as there are sub-patterns. If there are sub-patterns, each iteration returns an indexed array with the full pattern match at 0 and each of the sub-pattern matches as another element.

If there are no sub-patterns, the behaviour of GET_MATCH is the same as MATCH.
To Top