<!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 RecursiveFilterIterator class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="recursivedirectoryiterator.rewind.html">RecursiveDirectoryIterator::rewind</a></div>
<div class="next" style="text-align: right; float: right;"><a href="recursivefilteriterator.construct.html">RecursiveFilterIterator::__construct</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.recursivefilteriterator" class="reference">
<h1 class="title">The RecursiveFilterIterator class</h1>
<div class="partintro"><p class="verinfo">(PHP 5 >= 5.1.0)</p>
<div class="section" id="recursivefilteriterator.intro">
<h2 class="title">Introduction</h2>
<p class="para">
This abstract iterator filters out unwanted values for a <a href="class.recursiveiterator.html" class="classname">RecursiveIterator</a>.
This class should be extended to implement custom filters.
The <span class="methodname"><strong>RecursiveFilterIterator::accept()</strong></span> must be implemented in the subclass.
</p>
</div>
<div class="section" id="recursivefilteriterator.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">RecursiveFilterIterator</strong>
</span>
<span class="ooclass">
<span class="modifier">extends</span>
<a href="class.filteriterator.html" class="classname">FilterIterator</a>
</span>
<span class="oointerface">implements
<span class="interfacename"><a href="class.outeriterator.html" class="interfacename">OuterIterator</a></span>
</span>
<span class="oointerface">,
<span class="interfacename"><a href="class.recursiveiterator.html" class="interfacename">RecursiveIterator</a></span>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><a href="recursivefilteriterator.construct.html" class="methodname">__construct</a></span>
( <span class="methodparam"><span class="type"><a href="class.recursiveiterator.html" class="type RecursiveIterator">RecursiveIterator</a></span> <code class="parameter">$iterator</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="recursivefilteriterator.getchildren.html" class="methodname">getChildren</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="recursivefilteriterator.haschildren.html" class="methodname">hasChildren</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Inherited 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">FilterIterator::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">FilterIterator::__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">FilterIterator::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">FilterIterator::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">FilterIterator::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">FilterIterator::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">FilterIterator::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">FilterIterator::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="recursivefilteriterator.construct.html">RecursiveFilterIterator::__construct</a> — Create a RecursiveFilterIterator from a RecursiveIterator</li><li><a href="recursivefilteriterator.getchildren.html">RecursiveFilterIterator::getChildren</a> — Return the inner iterator's children contained in a RecursiveFilterIterator</li><li><a href="recursivefilteriterator.haschildren.html">RecursiveFilterIterator::hasChildren</a> — Check whether the inner iterator's current element has children</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="recursivedirectoryiterator.rewind.html">RecursiveDirectoryIterator::rewind</a></div>
<div class="next" style="text-align: right; float: right;"><a href="recursivefilteriterator.construct.html">RecursiveFilterIterator::__construct</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>
