The RecursiveCallbackFilterIterator class

(PHP 5 >= 5.4.0)

Einführung

Klassenbeschreibung

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

/* Methoden */

public __construct ( RecursiveIterator $iterator , string $callback )

public RecursiveCallbackFilterIterator getChildren ( void )

public void hasChildren ( void )

/* Geerbte Methoden */

public string CallbackFilterIterator::accept ( void )

}

Beispiele

The callback should accept up to three arguments: the current item, the current key and the iterator, respectively.

Beispiel #1 Available callback arguments


<?php

/**
 * Callback for RecursiveCallbackFilterIterator
 *
 * @param $current   Current item's value
 * @param $key       Current item's key
 * @param $iterator  Iterator being filtered
 * @return boolean   TRUE to accept the current item, FALSE otherwise
 */
function my_callback($current, $key, $iterator) {
    // Your filtering code here
}

?>

Filtering a recursive iterator generally involves two conditions. The first is that, to allow recursion, the callback function should return TRUE if the current iterator item has children. The second is the normal filter condition, such as a file size or extension check as in the example below.

Beispiel #2 Recursive callback basic example


<?php

$dir = new FilesystemIterator(__DIR__);

// Filter large files ( > 100MB)
$files = new RecursiveCallbackFilterIterator($dir, function ($current, $key, $iterator) {
    // Allow recursion
    if ($iterator->hasChildren()) {
        return TRUE;
    }
    // Check for large file
    if ($current->isFile() && $current->getSize() > 104857600) {
        return TRUE;
    }
    return FALSE;
});
 
foreach (new RecursiveIteratorIterator($files) as $file) {
    echo $file->getPathname() . PHP_EOL;
}

?>

Inhaltsverzeichnis

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 02: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