RecursiveRegexIterator::__construct
PHP function
Edit on GitHub ✎
(PHP 5 >= 5.2.0, PHP 7, PHP 8)
Creates a new RecursiveRegexIterator
Description
RecursiveRegexIterator::__construct(RecursiveIterator $iterator, string $pattern, int $mode = RecursiveRegexIterator::MATCH, int $flags = 0, int $pregFlags = 0)
Creates a new regular expression iterator.
Parameters
iteratorThe recursive iterator to apply this regex filter to.
patternThe regular expression to match.
modeOperation mode, see
RegexIterator::setModefor a list of modes.flagsSpecial flags, see
RegexIterator::setFlagsfor a list of available flags.pregFlagsThe regular expression flags. These flags depend on the operation mode parameter:
operation mode available flags RecursiveRegexIterator::ALL_MATCHESSee preg_match_all().RecursiveRegexIterator::GET_MATCHSee preg_match().RecursiveRegexIterator::MATCHSee preg_match().RecursiveRegexIterator::REPLACEnone. RecursiveRegexIterator::SPLITSee preg_split().
Examples
RecursiveRegexIterator::__construct() example
Creates a new RegexIterator that filters all strings that start with 'test'.
php
<?php
$rArrayIterator = new RecursiveArrayIterator(array('test1', array('tet3', 'test4', 'test5')));
$rRegexIterator = new RecursiveRegexIterator($rArrayIterator, '/^test/',
RecursiveRegexIterator::ALL_MATCHES);
foreach ($rRegexIterator as $key1 => $value1) {
if ($rRegexIterator->hasChildren()) {
// print all children
echo "Children: ";
foreach ($rRegexIterator->getChildren() as $key => $value) {
echo $value . " ";
}
echo "\n";
} else {
echo "No children\n";
}
}
?>The above example will output something similar to:
output
No children
Children: test4 test5