MultipleIterator::getFlags

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

MultipleIterator::getFlags — Gets the flag information

Description

public function MultipleIterator::getFlags(): int

Gets the flags that control how the attached iterators are iterated over.

Parameters

This function has no parameters.

Return Values

Returns a bitmask of the MultipleIterator constants. As MultipleIterator::MIT_NEED_ANY and MultipleIterator::MIT_KEYS_NUMERIC are 0, use the bitwise & operator to check for MultipleIterator::MIT_NEED_ALL and MultipleIterator::MIT_KEYS_ASSOC.

Examples

Example #1 Checking the flags

<?php
$iterator = new MultipleIterator(MultipleIterator::MIT_NEED_ANY | MultipleIterator::MIT_KEYS_ASSOC);

var_dump((bool) ($iterator->getFlags() & MultipleIterator::MIT_NEED_ALL));
var_dump((bool) ($iterator->getFlags() & MultipleIterator::MIT_KEYS_ASSOC));
?>

The above example will output:

bool(false)
bool(true)

See Also