<!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>Check whether the current element of the iterator is acceptable</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.filteriterator.html">FilterIterator</a></div>
<div class="next" style="text-align: right; float: right;"><a href="filteriterator.construct.html">FilterIterator::__construct</a></div>
<div class="up"><a href="class.filteriterator.html">FilterIterator</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="filteriterator.accept" class="refentry">
<div class="refnamediv">
<h1 class="refname">FilterIterator::accept</h1>
<p class="verinfo">(PHP 5 >= 5.1.0)</p><p class="refpurpose"><span class="refname">FilterIterator::accept</span> — <span class="dc-title">Check whether the current element of the iterator is acceptable</span></p>
</div>
<div class="refsect1 description" id="refsect1-filteriterator.accept-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span>
<span class="modifier">abstract</span>
<span class="type">bool</span> <span class="methodname"><strong>FilterIterator::accept</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Returns whether the current element of the iterator is acceptable through this filter.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-filteriterator.accept-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-filteriterator.accept-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
<strong><code>TRUE</code></strong> if the current element is acceptable, otherwise <strong><code>FALSE</code></strong>.
</p>
</div>
<div class="refsect1 examples" id="refsect1-filteriterator.accept-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3879">
<p><strong>Example #1 <span class="function"><strong>FilterIterator::accept()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// This iterator filters all values with less than 10 characters<br /></span><span style="color: #007700">class </span><span style="color: #0000BB">LengthFilterIterator </span><span style="color: #007700">extends </span><span style="color: #0000BB">FilterIterator </span><span style="color: #007700">{<br /><br /> public function </span><span style="color: #0000BB">accept</span><span style="color: #007700">() {<br /> </span><span style="color: #FF8000">// Only accept strings with a length of 10 and greater<br /> </span><span style="color: #007700">return </span><span style="color: #0000BB">strlen</span><span style="color: #007700">(</span><span style="color: #0000BB">parent</span><span style="color: #007700">::</span><span style="color: #0000BB">current</span><span style="color: #007700">()) > </span><span style="color: #0000BB">10</span><span style="color: #007700">;<br /> }<br /><br />}<br /><br /></span><span style="color: #0000BB">$arrayIterator </span><span style="color: #007700">= new </span><span style="color: #0000BB">ArrayIterator</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'test1'</span><span style="color: #007700">, </span><span style="color: #DD0000">'more than 10 characters'</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$lengthFilter </span><span style="color: #007700">= new </span><span style="color: #0000BB">LengthFilterIterator</span><span style="color: #007700">(</span><span style="color: #0000BB">$arrayIterator</span><span style="color: #007700">);<br /><br />foreach (</span><span style="color: #0000BB">$lengthFilter </span><span style="color: #007700">as </span><span style="color: #0000BB">$value</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">$value </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
more than 10 characters
</pre></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.filteriterator.html">FilterIterator</a></div>
<div class="next" style="text-align: right; float: right;"><a href="filteriterator.construct.html">FilterIterator::__construct</a></div>
<div class="up"><a href="class.filteriterator.html">FilterIterator</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
