The FilterIterator class

Introduction

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

Class synopsis

abstract FilterIterator extends IteratorIterator implements OuterIterator , Traversable , Iterator {
/* Methods */
abstract bool accept ( void )
__construct ( Iterator $iterator )
mixed current ( void )
Iterator getInnerIterator ( void )
mixed key ( void )
void next ( void )
void rewind ( void )
bool valid ( void )
}

Table of Contents

add a note add a note

User Contributed Notes 1 note

up
6
Venelin Vulkov
5 years ago
The code below is a simple example of usage . Note that the method which does the actual job is accept.

<?php
class UserFilter extends FilterIterator
{
    private
$userFilter;
   
    public function
__construct(Iterator $iterator , $filter )
    {
       
parent::__construct($iterator);
       
$this->userFilter = $filter;
    }
   
    public function
accept()
    {
       
$user = $this->getInnerIterator()->current();
        if(
strcasecmp($user['name'],$this->userFilter) == 0) {
            return
false;
        }       
        return
true;
    }
}

$array = array(
array(
'name' => 'Jonathan','id' => '5'),
array(
'name' => 'Abdul' ,'id' => '22')
);

$object = new ArrayObject($array);

// Note it is case insensitive check in our example due the usage of strcasecmp function
$iterator = new UserFilter($object->getIterator(),'abdul');

foreach (
$iterator as $result) {
    echo
$result['name'];
}

/* Outputs Jonathan */

?>
Regards.
To Top