Класс RecursiveCallbackFilterIterator

(PHP 5 >= 5.4.0)

Введение

Обзор классов

RecursiveCallbackFilterIterator extends CallbackFilterIterator implements OuterIterator , Traversable , Iterator , RecursiveIterator {

/* Методы */

public __construct ( RecursiveIterator $iterator , string $callback )

public RecursiveCallbackFilterIterator getChildren ( void )

public void hasChildren ( void )

/* Наследуемые методы */

public string CallbackFilterIterator::accept ( void )

}

Примеры

Обратный вызов может принимать до трех аргументов: текущий элемент, текущий ключ и итератор соответсвенно.

Пример #1 Доступные аргументы обратного вызова


<?php

/**
 * Обратный вызов для RecursiveCallbackFilterIterator
 *
 * @param $current   Значение текущего элемента
 * @param $key       Ключ текущего элемента
 * @param $iterator  Итератор, который фильтруется
 * @return boolean   TRUE для приема текущего элемента или FALSE - в ином случае.
 */
function my_callback($current, $key, $iterator) {
    // Здесь ваш код фильтрации
}

?>

Фильтрация рекурсивного итератора обычно включает в себя два условия. Первое заключается в том, чтобы разрешить рекурсию. Функция обратного вызова должна возвращать TRUE, если текущий элемент итератора имеет потомков. Второе - это нормальное условие фильтра, например, проверка размера файла или расширения, как в примере ниже.

Пример #2 Простой пример рекурсивного обратного вызова


<?php

$dir = new FilesystemIterator(__DIR__);

// Фильтр больших файлов ( > 100MB)
$files = new RecursiveCallbackFilterIterator($dir, function ($current, $key, $iterator) {
    // Разрешить рекурсию
    if ($iterator->hasChildren()) {
        return TRUE;
    }
    // Проверка больших файлов
    if ($current->isFile() && $current->getSize() > 104857600) {
        return TRUE;
    }
    return FALSE;
});
 
foreach (new RecursiveIteratorIterator($files) as $file) {
    echo $file->getPathname() . PHP_EOL;
}

?>

Содержание

RecursiveCallbackFilterIterator::__construct — Create a RecursiveCallbackFilterIterator from a RecursiveIterator
RecursiveCallbackFilterIterator::getChildren — Return the inner iterator's children contained in a RecursiveCallbackFilterIterator
RecursiveCallbackFilterIterator::hasChildren — Check whether the inner iterator's current element has children

add a note User Contributed Notes RecursiveCallbackFilterIterator

Anonymous 11-Dec-2011 01:31


Note that the following filters out both files and directories whos names start with the letter "T". The important thing here is that since the function returns false for a directory entry whos name starts with T, the directory is also not traversed recursively.



<?php

$doesntStartWithLetterT = function ($current) {

    return $current->getFileName()[0] !== 'T';

};



$rdi = new RecursiveDirectoryIterator(__DIR__);

$files = new RecursiveCallbackFilterIterator($rdi, $doesntStartWithLetterT);

foreach (new RecursiveIteratorIterator($files) as $file) {

    echo $file->getPathname() . PHP_EOL;

}

?>

add a note