The RecursiveFilterIterator class

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

Introduction

This abstract iterator filters out unwanted values for a RecursiveIterator. This class should be extended to implement custom filters. The RecursiveFilterIterator::accept() must be implemented in the subclass.

Class synopsis

abstract class RecursiveFilterIterator extends FilterIterator implements RecursiveIterator {

/* Methods */

public __construct(RecursiveIterator $iterator)

public getChildren(): ?RecursiveFilterIterator

public hasChildren(): bool

/* Inherited methods */

public FilterIterator::accept(): bool

public FilterIterator::current(): mixed

public FilterIterator::key(): mixed

public FilterIterator::next(): void

public FilterIterator::rewind(): void

public FilterIterator::valid(): bool

public IteratorIterator::current(): mixed

public IteratorIterator::getInnerIterator(): ?Iterator

public IteratorIterator::key(): mixed

public IteratorIterator::next(): void

public IteratorIterator::rewind(): void

public IteratorIterator::valid(): bool

}

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

add a note

User Contributed Notes 2 notes

down

lemats ¶

13 years ago


Recursive directory/file listing, filteres ".svn":

<?php

class MyRecursiveFilterIterator extends RecursiveFilterIterator {

    public static $FILTERS = array(
        '.svn',
    );

    public function accept() {
        return !in_array(
            $this->current()->getFilename(),
            self::$FILTERS,
            true
        );
    }

}

$dirItr    = new RecursiveDirectoryIterator('/sample/path');
$filterItr = new MyRecursiveFilterIterator($dirItr);
$itr       = new RecursiveIteratorIterator($filterItr, RecursiveIteratorIterator::SELF_FIRST);
foreach ($itr as $filePath => $fileInfo) {
    echo $fileInfo->getFilename() . PHP_EOL;
}

?>

down

Russell Dias ¶

14 years ago


I had to create a filter to get values greater than a certain number in a multidimensional array.

Hope someone else finds it helpful:

<?php
class GreaterThanFilter extends RecursiveFilterIterator {
    protected $limit;

    public function __construct(RecursiveIterator $recursiveIter, $limit) {
        $this->limit = $limit;
        parent::__construct($recursiveIter);
    }
    public function accept() {
        return $this->hasChildren() || strlen($this->current()) >= $this->limit;
    }
     public function getChildren() {
        return new self($this->getInnerIterator()->getChildren(), $this->limit);
    }
}
$iter = new RecursiveArrayIterator($array);
$filter   = new GreaterThanFilter($iter, 5);

foreach(new RecursiveIteratorIterator($filter) as $key => $value)
{
    echo $value . "\n";
}
?>

add a note

The RecursiveFilterIterator class

Introduction

Class synopsis

Table of Contents

User Contributed Notes 2 notes