(PHP 5 >= 5.2.0, PHP 7, PHP 8)
This iterator can be used to filter another iterator based on a regular expression.
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::USE_KEY Special flag: Match the entry key instead of the entry value.
RegexIterator::INVERT_MATCH Inverts the return value of RegexIterator::accept() .
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.