RegexIterator::getFlags

(PHP 5 >= 5.2.0, PHP 7)

Get flags

public int RegexIterator::getFlags ( void )

Returns the flags, see RegexIterator::setFlags() for a list of available flags.

Returns:

Returns the set flags.

Examples:

RegexIterator::getFlags() example

<?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);
 
if ($regexIterator->getFlags() & RegexIterator::USE_KEY) {
    echo 'Filtering based on the array keys.';
} else {
    echo 'Filtering based on the array values.';
}
?>

The above example will output:

Filtering based on the array keys.