<!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>Checks if iterateable</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="reflectionclass.isinternal.html">ReflectionClass::isInternal</a></div>
<div class="next" style="text-align: right; float: right;"><a href="reflectionclass.issubclassof.html">ReflectionClass::isSubclassOf</a></div>
<div class="up"><a href="class.reflectionclass.html">ReflectionClass</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="reflectionclass.isiterateable" class="refentry">
<div class="refnamediv">
<h1 class="refname">ReflectionClass::isIterateable</h1>
<p class="verinfo">(PHP 5)</p><p class="refpurpose"><span class="refname">ReflectionClass::isIterateable</span> — <span class="dc-title">Checks if iterateable</span></p>
</div>
<div class="refsect1 description" id="refsect1-reflectionclass.isiterateable-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>ReflectionClass::isIterateable</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Checks whether the class is iterateable.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-reflectionclass.isiterateable-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-reflectionclass.isiterateable-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-reflectionclass.isiterateable-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-5210">
<p><strong>Example #1 <span class="methodname"><strong>ReflectionClass::isIterateable()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #007700">class </span><span style="color: #0000BB">IteratorClass </span><span style="color: #007700">implements </span><span style="color: #0000BB">Iterator </span><span style="color: #007700">{<br /> public function </span><span style="color: #0000BB">__construct</span><span style="color: #007700">() { }<br /> public function </span><span style="color: #0000BB">key</span><span style="color: #007700">() { }<br /> public function </span><span style="color: #0000BB">current</span><span style="color: #007700">() { }<br /> function </span><span style="color: #0000BB">next</span><span style="color: #007700">() { }<br /> function </span><span style="color: #0000BB">valid</span><span style="color: #007700">() { }<br /> function </span><span style="color: #0000BB">rewind</span><span style="color: #007700">() { }<br />}<br />class </span><span style="color: #0000BB">DerivedClass </span><span style="color: #007700">extends </span><span style="color: #0000BB">IteratorClass </span><span style="color: #007700">{ }<br />class </span><span style="color: #0000BB">NonIterator </span><span style="color: #007700">{ }<br /><br />function </span><span style="color: #0000BB">dump_iterateable</span><span style="color: #007700">(</span><span style="color: #0000BB">$class</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$reflection </span><span style="color: #007700">= new </span><span style="color: #0000BB">ReflectionClass</span><span style="color: #007700">(</span><span style="color: #0000BB">$class</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$reflection</span><span style="color: #007700">-></span><span style="color: #0000BB">isIterateable</span><span style="color: #007700">());<br />}<br /><br /></span><span style="color: #0000BB">$classes </span><span style="color: #007700">= array(</span><span style="color: #DD0000">"ArrayObject"</span><span style="color: #007700">, </span><span style="color: #DD0000">"IteratorClass"</span><span style="color: #007700">, </span><span style="color: #DD0000">"DerivedClass"</span><span style="color: #007700">, </span><span style="color: #DD0000">"NonIterator"</span><span style="color: #007700">);<br /><br />foreach (</span><span style="color: #0000BB">$classes </span><span style="color: #007700">as </span><span style="color: #0000BB">$class</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"Is </span><span style="color: #0000BB">$class</span><span style="color: #DD0000"> iterateable? "</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">dump_iterateable</span><span style="color: #007700">(</span><span style="color: #0000BB">$class</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>
Is ArrayObject iterateable? bool(true)
Is IteratorClass iterateable? bool(true)
Is DerivedClass iterateable? bool(true)
Is NonIterator iterateable? bool(false)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-reflectionclass.isiterateable-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="reflectionclass.construct.html" class="methodname" rel="rdfs-seeAlso">ReflectionClass::__construct()</a> - Constructs a ReflectionClass</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="reflectionclass.isinternal.html">ReflectionClass::isInternal</a></div>
<div class="next" style="text-align: right; float: right;"><a href="reflectionclass.issubclassof.html">ReflectionClass::isSubclassOf</a></div>
<div class="up"><a href="class.reflectionclass.html">ReflectionClass</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
