<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>The FilterIterator class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="filesystemiterator.setflags.html">FilesystemIterator::setFlags</a></div>
<div class="next" style="text-align: right; float: right;"><a href="filteriterator.accept.html">FilterIterator::accept</a></div>
<div class="up"><a href="spl.iterators.html">Iterators</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.filteriterator" class="reference">
<h1 class="title">The FilterIterator class</h1>
<div class="partintro"><p class="verinfo">(PHP 5 >= 5.1.0)</p>
<div class="section" id="filteriterator.intro">
<h2 class="title">Introduction</h2>
<p class="para">
This abstract iterator filters out unwanted values. This class should be extended to
implement custom iterator filters. The <span class="methodname"><a href="filteriterator.accept.html" class="methodname">FilterIterator::accept()</a></span>
must be implemented in the subclass.
</p>
</div>
<div class="section" id="filteriterator.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<span class="modifier">abstract</span>
<strong class="classname">FilterIterator</strong>
</span>
<span class="ooclass">
<span class="modifier">extends</span>
<a href="class.iteratoriterator.html" class="classname">IteratorIterator</a>
</span>
<span class="oointerface">implements
<span class="interfacename"><a href="class.outeriterator.html" class="interfacename">OuterIterator</a></span>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span>
<span class="modifier">abstract</span>
<span class="type">bool</span> <span class="methodname"><a href="filteriterator.accept.html" class="methodname">accept</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span>
<span class="methodname"><a href="filteriterator.construct.html" class="methodname">__construct</a></span>
( <span class="methodparam"><span class="type"><a href="class.iterator.html" class="type Iterator">Iterator</a></span> <code class="parameter">$iterator</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="filteriterator.current.html" class="methodname">current</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">Iterator</span> <span class="methodname"><a href="filteriterator.getinneriterator.html" class="methodname">getInnerIterator</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="filteriterator.key.html" class="methodname">key</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="filteriterator.next.html" class="methodname">next</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="filteriterator.rewind.html" class="methodname">rewind</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="filteriterator.valid.html" class="methodname">valid</a></span>
( <span class="methodparam">void</span>
)</div>
}</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="filteriterator.accept.html">FilterIterator::accept</a> — Check whether the current element of the iterator is acceptable</li><li><a href="filteriterator.construct.html">FilterIterator::__construct</a> — Construct a filterIterator</li><li><a href="filteriterator.current.html">FilterIterator::current</a> — Get the current element value</li><li><a href="filteriterator.getinneriterator.html">FilterIterator::getInnerIterator</a> — Get the inner iterator</li><li><a href="filteriterator.key.html">FilterIterator::key</a> — Get the current key</li><li><a href="filteriterator.next.html">FilterIterator::next</a> — Move the iterator forward</li><li><a href="filteriterator.rewind.html">FilterIterator::rewind</a> — Rewind the iterator</li><li><a href="filteriterator.valid.html">FilterIterator::valid</a> — Check whether the current element is valid</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="filesystemiterator.setflags.html">FilesystemIterator::setFlags</a></div>
<div class="next" style="text-align: right; float: right;"><a href="filteriterator.accept.html">FilterIterator::accept</a></div>
<div class="up"><a href="spl.iterators.html">Iterators</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
