php8.5
Home/ Manual/ spl / regexiterator/ RegexIterator::getPregFlags

RegexIterator::getPregFlags

PHP function Edit on GitHub ✎

(PHP 5 >= 5.2.0, PHP 7, PHP 8)

Returns the regular expression flags

Description

RegexIterator::getPregFlags(): int

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

Parameters Parameters

Return Values

Returns a bitmask of the regular expression flags.

Examples

RegexIterator::getPregFlags example

php
<?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:

output
Ignoring empty pieces

See Also

  • RegexIterator::setPregFlags

Source: reference/spl/regexiterator/getpregflags.xml · from the official PHP manual (php/doc-en)