<!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>Returns if the current iterator entry is valid</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="splobjectstorage.unserialize.html">SplObjectStorage::unserialize</a></div>
<div class="next" style="text-align: right; float: right;"><a href="spl.iterators.html">Iterators</a></div>
<div class="up"><a href="class.splobjectstorage.html">SplObjectStorage</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="splobjectstorage.valid" class="refentry">
<div class="refnamediv">
<h1 class="refname">SplObjectStorage::valid</h1>
<p class="verinfo">(PHP 5 >= 5.1.0)</p><p class="refpurpose"><span class="refname">SplObjectStorage::valid</span> — <span class="dc-title">Returns if the current iterator entry is valid</span></p>
</div>
<div class="refsect1 description" id="refsect1-splobjectstorage.valid-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>SplObjectStorage::valid</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Returns if the current iterator entry is valid.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-splobjectstorage.valid-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-splobjectstorage.valid-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> if the iterator entry is valid, <strong><code>FALSE</code></strong> otherwise.
</p>
</div>
<div class="refsect1 examples" id="refsect1-splobjectstorage.valid-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3829">
<p><strong>Example #1 <span class="function"><strong>SplObjectStorage::valid()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$s </span><span style="color: #007700">= new </span><span style="color: #0000BB">SplObjectStorage</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$o1 </span><span style="color: #007700">= new </span><span style="color: #0000BB">StdClass</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$o2 </span><span style="color: #007700">= new </span><span style="color: #0000BB">StdClass</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$s</span><span style="color: #007700">-></span><span style="color: #0000BB">attach</span><span style="color: #007700">(</span><span style="color: #0000BB">$o1</span><span style="color: #007700">, </span><span style="color: #DD0000">"d1"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$s</span><span style="color: #007700">-></span><span style="color: #0000BB">attach</span><span style="color: #007700">(</span><span style="color: #0000BB">$o2</span><span style="color: #007700">, </span><span style="color: #DD0000">"d2"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$s</span><span style="color: #007700">-></span><span style="color: #0000BB">rewind</span><span style="color: #007700">();<br />while(</span><span style="color: #0000BB">$s</span><span style="color: #007700">-></span><span style="color: #0000BB">valid</span><span style="color: #007700">()) {<br /> echo </span><span style="color: #0000BB">$s</span><span style="color: #007700">-></span><span style="color: #0000BB">key</span><span style="color: #007700">().</span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$s</span><span style="color: #007700">-></span><span style="color: #0000BB">next</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
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
0
1
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-splobjectstorage.valid-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="splobjectstorage.current.html" class="methodname" rel="rdfs-seeAlso">SplObjectStorage::current()</a> - Returns the current storage entry</span></li>
<li class="member"> <span class="methodname"><a href="splobjectstorage.getinfo.html" class="methodname" rel="rdfs-seeAlso">SplObjectStorage::getInfo()</a> - Returns the data associated with the current iterator entry</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="splobjectstorage.unserialize.html">SplObjectStorage::unserialize</a></div>
<div class="next" style="text-align: right; float: right;"><a href="spl.iterators.html">Iterators</a></div>
<div class="up"><a href="class.splobjectstorage.html">SplObjectStorage</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
