This iterator can be used to filter another iterator based on a regular expression.
Return all matches for the current entry (see preg_match_all()).
Return the first match for the current entry (see preg_match()).
Only execute match (filter) for the current entry (see preg_match()).
Replace the current entry (see preg_replace(); Not fully implemented yet)
Returns the split values for the current entry (see preg_split()).
Special flag: Match the entry key instead of the entry value.
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
)
*/
?>