RegexIterator::setFlags

(PHP 5 >= 5.2.0, PHP 7)

Sets the flags.

public void RegexIterator::setFlags ( int $flags )

Sets the flags.

Parameters:

flags

The flags to set, a bitmask of class constants.

The available flags are listed below. The actual meanings of these flags are described in the predefined constants.

**RegexIterator flags**
value	constant
1	RegexIterator::USE_KEY

Returns:

No value is returned.

Examples:

RegexIterator::setFlags() example

Creates a new RegexIterator that filters all entries whose key starts with 'test'.

<?php
$test = array ('str1' => 'test 1', 'teststr2' => 'another test', 'str3' => 'test 123');
 
$arrayIterator = new ArrayIterator($test);
$regexIterator = new RegexIterator($arrayIterator, '/^test/');
$regexIterator->setFlags(RegexIterator::USE_KEY);
 
foreach ($regexIterator as $key => $value) {
    echo $key . ' => ' . $value . "\n";
}
?>

The above example will output:

teststr2 => another test