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

RegexIterator::getFlags

PHP function Edit on GitHub ✎

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

Get flags

Description

RegexIterator::getFlags(): int

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

Parameters Parameters

Return Values

Returns the set flags.

Examples

RegexIterator::getFlags example

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

output
Filtering based on the array keys.

See Also

  • RegexIterator::setFlags

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