The RegexIterator class
(PHP 5 >= 5.2.0)
Introduction
This iterator can be used to filter another iterator based on a regular expression.
Class synopsis
RegexIterator
extends
FilterIterator
{
/* Constants */
/* Methods */
public __construct
( Iterator
$iterator
, string $regex
[, int $mode = self::MATCH
[, int $flags = 0
[, int $preg_flags = 0
]]] )/* Inherited methods */
}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.
Table of Contents
- RegexIterator::accept — Get accept status
- RegexIterator::__construct — Create a new RegexIterator
- RegexIterator::getFlags — Get flags
- RegexIterator::getMode — Returns operation mode.
- RegexIterator::getPregFlags — Returns the regular expression flags.
- RegexIterator::getRegex — Returns current regular expression
- RegexIterator::setFlags — Sets the flags.
- RegexIterator::setMode — Sets the operation mode.
- RegexIterator::setPregFlags — Sets the regular expression flags.
- PHP Руководство
- Функции по категориям
- Индекс функций
- Справочник функций
- Другие базовые расширения
- Стандартная библиотека PHP (SPL)
- Класс AppendIterator
- Класс ArrayIterator
- Класс CachingIterator
- Класс CallbackFilterIterator
- Класс DirectoryIterator
- Класс EmptyIterator
- Класс FilesystemIterator
- Класс FilterIterator
- Класс GlobIterator
- Класс InfiniteIterator
- Класс IteratorIterator
- Класс LimitIterator
- Класс MultipleIterator
- Класс NoRewindIterator
- Класс ParentIterator
- Класс RecursiveArrayIterator
- Класс RecursiveCachingIterator
- Класс RecursiveCallbackFilterIterator
- Класс RecursiveDirectoryIterator
- Класс RecursiveFilterIterator
- Класс RecursiveIteratorIterator
- Класс RecursiveRegexIterator
- Класс RecursiveTreeIterator
- Класс RegexIterator
Коментарии
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
)
*/
?>
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.