<!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>Gets the iterator classname for the ArrayObject.</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="arrayobject.getiterator.html">ArrayObject::getIterator</a></div>
<div class="next" style="text-align: right; float: right;"><a href="arrayobject.ksort.html">ArrayObject::ksort</a></div>
<div class="up"><a href="class.arrayobject.html">ArrayObject</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="arrayobject.getiteratorclass" class="refentry">
<div class="refnamediv">
<h1 class="refname">ArrayObject::getIteratorClass</h1>
<p class="verinfo">(PHP 5 >= 5.1.0)</p><p class="refpurpose"><span class="refname">ArrayObject::getIteratorClass</span> — <span class="dc-title">Gets the iterator classname for the ArrayObject.</span></p>
</div>
<div class="refsect1 description" id="refsect1-arrayobject.getiteratorclass-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><strong>ArrayObject::getIteratorClass</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Gets the class name of the array iterator that is used by
<a href="arrayobject.getiterator.html" class="link">ArrayObject::getIterator()</a>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-arrayobject.getiteratorclass-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-arrayobject.getiteratorclass-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the iterator class name that is used to iterate over this object.
</p>
</div>
<div class="refsect1 examples" id="refsect1-arrayobject.getiteratorclass-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3985">
<p><strong>Example #1 <span class="function"><strong>ArrayObject::getIteratorClass()</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">// Custom ArrayIterator (inherits from ArrayIterator)<br /></span><span style="color: #007700">class </span><span style="color: #0000BB">MyArrayIterator </span><span style="color: #007700">extends </span><span style="color: #0000BB">ArrayIterator </span><span style="color: #007700">{<br /> </span><span style="color: #FF8000">// custom implementation<br /></span><span style="color: #007700">}<br /><br /></span><span style="color: #FF8000">// Array of available fruits<br /></span><span style="color: #0000BB">$fruits </span><span style="color: #007700">= array(</span><span style="color: #DD0000">"lemons" </span><span style="color: #007700">=> </span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #DD0000">"oranges" </span><span style="color: #007700">=> </span><span style="color: #0000BB">4</span><span style="color: #007700">, </span><span style="color: #DD0000">"bananas" </span><span style="color: #007700">=> </span><span style="color: #0000BB">5</span><span style="color: #007700">, </span><span style="color: #DD0000">"apples" </span><span style="color: #007700">=> </span><span style="color: #0000BB">10</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$fruitsArrayObject </span><span style="color: #007700">= new </span><span style="color: #0000BB">ArrayObject</span><span style="color: #007700">(</span><span style="color: #0000BB">$fruits</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Get the current class name<br /></span><span style="color: #0000BB">$className </span><span style="color: #007700">= </span><span style="color: #0000BB">$fruitsArrayObject</span><span style="color: #007700">-></span><span style="color: #0000BB">getIteratorClass</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$className</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Set new classname<br /></span><span style="color: #0000BB">$fruitsArrayObject</span><span style="color: #007700">-></span><span style="color: #0000BB">setIteratorClass</span><span style="color: #007700">(</span><span style="color: #DD0000">'MyArrayIterator'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Get the new iterator classname<br /></span><span style="color: #0000BB">$className </span><span style="color: #007700">= </span><span style="color: #0000BB">$fruitsArrayObject</span><span style="color: #007700">-></span><span style="color: #0000BB">getIteratorClass</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$className</span><span style="color: #007700">);<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>
string(13) "ArrayIterator"
string(15) "MyArrayIterator"
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-arrayobject.getiteratorclass-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member">The <a href="arrayobject.setiteratorclass.html" class="link">ArrayObject::setIteratorClass</a> method</li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="arrayobject.getiterator.html">ArrayObject::getIterator</a></div>
<div class="next" style="text-align: right; float: right;"><a href="arrayobject.ksort.html">ArrayObject::ksort</a></div>
<div class="up"><a href="class.arrayobject.html">ArrayObject</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
