RegexIterator::__construct
PHP function
Edit on GitHub ✎
(PHP 5 >= 5.2.0, PHP 7, PHP 8)
Create a new RegexIterator
Description
RegexIterator::__construct(Iterator $iterator, string $pattern, int $mode = RegexIterator::MATCH, int $flags = 0, int $pregFlags = 0)
Create a new RegexIterator which filters an Iterator using a regular expression.
Parameters
iteratorThe 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 RegexIterator::ALL_MATCHESSee preg_match_all().RegexIterator::GET_MATCHSee preg_match().RegexIterator::MATCHSee preg_match().RegexIterator::REPLACEnone. RegexIterator::SPLITSee preg_split().
Errors/Exceptions
Throws an InvalidArgumentException if the pattern argument is invalid.
Examples
RegexIterator::__construct() example
Creates a new RegexIterator that filters all strings that start with 'test'.
php
<?php
$arrayIterator = new ArrayIterator(array('test 1', 'another test', 'test 123'));
$regexIterator = new RegexIterator($arrayIterator, '/^test/');
foreach ($regexIterator as $value) {
echo $value . "\n";
}
?>The above example will output something similar to:
output
test 1
test 123