RegexIterator::__construct
RegexIterator::__construct
(PHP 5 >= 5.2.0, PHP 7)
RegexIterator::__construct — Create a new RegexIterator
Description
public RegexIterator::__construct ( Iterator $iterator , string $regex [, int $mode = self::MATCH [, int $flags = 0 , int $preg_flags = 0 ]] )
Create a new RegexIterator which filters an Iterator using a regular expression.
Parameters
iterator
The iterator to apply this regex filter to.
regex
The regular expression to match.
mode
Operation mode, see RegexIterator::setMode() for a list of modes.
flags
Special flags, see RegexIterator::setFlags() for a list of available flags.
preg_flags
The regular expression flags. These flags depend on the operation mode parameter:
| operation mode | available flags |
|---|---|
| RegexIterator::ALL_MATCHES | See preg_match_all(). |
| RegexIterator::GET_MATCH | See preg_match(). |
| RegexIterator::MATCH | See preg_match(). |
| RegexIterator::REPLACE | none. |
| RegexIterator::SPLIT | See preg_split(). |
Errors/Exceptions
Throws an InvalidArgumentException if the regex argument is invalid.
Examples
Example #1 RegexIterator::__construct() example
Creates a new RegexIterator that filters all strings that start with 'test'.
<?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:
test 1
test 123
See Also
- preg_match() - Perform a regular expression match
- preg_match_all() - Perform a global regular expression match
- preg_replace() - Perform a regular expression search and replace
- preg_split() - Split string by a regular expression
← RegexIterator::accept
RegexIterator::getFlags →
© 1997–2017 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://secure.php.net/manual/en/regexiterator.construct.php
