PHP 8.1.0 Beta 1 available for testing

RecursiveIteratorIterator::__construct

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

RecursiveIteratorIterator::__constructКонструктор класса RecursiveIteratorIterator

Описание

public RecursiveIteratorIterator::__construct(Traversable $iterator, int $mode = RecursiveIteratorIterator::LEAVES_ONLY, int $flags = 0)

Создаёт новый объект класса RecursiveIteratorIterator на основе объекта RecursiveIterator.

Список параметров

iterator

Объект-итератор, на основе которого требуется построить данный экземпляр. Это может быть объект класса RecursiveIterator или класса IteratorAggregate.

mode

Необязательный параметр. Задание режима работы конструктора. Возможные значения:

  • RecursiveIteratorIterator::LEAVES_ONLY - По умолчанию. Итерация будет осуществляться только по листам дерева элементов.
  • RecursiveIteratorIterator::SELF_FIRST - Итерация будет осуществляться по всему дереву элементов, причём первыми будут идти родительские элементы.
  • RecursiveIteratorIterator::CHILD_FIRST - Итерация будет осуществляться по всему дереву элементов, причём первыми будут идти дочерние элементы.

flags

Необязательный настроечный флаг. Возможное значение RecursiveIteratorIterator::CATCH_GET_CHILD даёт предписание объекту не принимать во внимание исключения, которые вызывает метод RecursiveIteratorIterator::getChildren().

Возвращаемые значения

Эта функция не возвращает значения после выполнения.

Примеры

Пример #1 Итерация по дереву элементов с помощью RecursiveIteratorIterator

<?php
$array 
= array(
    array(
        array(
            array(
                
'leaf-0-0-0-0',
                
'leaf-0-0-0-1'
            
),
            
'leaf-0-0-0'
        
),
        array(
            array(
                
'leaf-0-1-0-0',
                
'leaf-0-1-0-1'
            
),
            
'leaf-0-1-0'
        
),
        
'leaf-0-0'
    
)
);

$iterator = new RecursiveIteratorIterator(
    new 
RecursiveArrayIterator($array),
    
$mode
);
foreach (
$iterator as $key => $leaf) {
    echo 
"$key => $leaf"PHP_EOL;
}
?>

Вывод примера в режиме $mode = RecursiveIteratorIterator::LEAVES_ONLY

0 => leaf-0-0-0-0
1 => leaf-0-0-0-1
0 => leaf-0-0-0
0 => leaf-0-1-0-0
1 => leaf-0-1-0-1
0 => leaf-0-1-0
0 => leaf-0-0

Вывод примера в режиме $mode = RecursiveIteratorIterator::SELF_FIRST

0 => Array
0 => Array
0 => Array
0 => leaf-0-0-0-0
1 => leaf-0-0-0-1
1 => leaf-0-0-0
1 => Array
0 => Array
0 => leaf-0-1-0-0
1 => leaf-0-1-0-1
1 => leaf-0-1-0
2 => leaf-0-0

Вывод примера в режиме $mode = RecursiveIteratorIterator::CHILD_FIRST

0 => leaf-0-0-0-0
1 => leaf-0-0-0-1
0 => Array
1 => leaf-0-0-0
0 => Array
0 => leaf-0-1-0-0
1 => leaf-0-1-0-1
0 => Array
1 => leaf-0-1-0
1 => Array
2 => leaf-0-0
0 => Array

add a note add a note

User Contributed Notes 2 notes

up
1
Tom
10 years ago
Note: the missing documentation of the argument list for this constructor is currently as follows (according to source code).

Param iter: see RecursiveIterator

Param mode:
- LEAVES_ONLY = (default) only iterate leaves
- SELF_FIRST = iterate parents prior to children
- CHILD_FIRST = iterate children prior to parents

Param flags:
- CATCH_GET_CHILD = ignore exceptions in getChildren() call
up
-1
Matt Creenan
11 years ago
Note that LEAVES_ONLY, SELF_FIRST and CHILD_FIRST do not work by themselves.

They are class constants so you need to use RecursiveIteratorIterator::LEAVES_ONLY, etc.
To Top