RegexIterator::getPregFlags

(PHP 5 >= 5.2.0, PHP 7)

Returns the regular expression flags.

public int RegexIterator::getPregFlags ( void )

Returns the regular expression flags, see RegexIterator::__construct() for the list of flags.

Returns:

Returns a bitmask of the regular expression flags.

Examples:

RegexIterator::getPregFlags() example

<?php
 
$test = array ('str1' => 'test 1', 'teststr2' => 'another test', 'str3' => 'test 123');
 
$arrayIterator = new ArrayIterator($test);
$regexIterator = new RegexIterator($arrayIterator, '/\s/', RegexIterator::SPLIT);
$regexIterator->setPregFlags(PREG_SPLIT_NO_EMPTY | PREG_SPLIT_OFFSET_CAPTURE);
 
if ($regexIterator->getPregFlags() & PREG_SPLIT_NO_EMPTY) {
    echo 'Ignoring empty pieces';
} else {
    echo 'Not ignoring empty pieces';
}
 
?>

The above example will output:

Ignoring empty pieces