<!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 RecursiveCachingIterator class</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="recursivearrayiterator.haschildren.html">RecursiveArrayIterator::hasChildren</a></div> <div class="next" style="text-align: right; float: right;"><a href="recursivecachingiterator.construct.html">RecursiveCachingIterator::__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.recursivecachingiterator" class="reference"> <h1 class="title">The RecursiveCachingIterator class</h1> <div class="partintro"><p class="verinfo">(PHP 5 >= 5.1.0)</p> <div class="section" id="recursivecachingiterator.intro"> <h2 class="title">Introduction</h2> <p class="para"> ... </p> </div> <div class="section" id="recursivecachingiterator.synopsis"> <h2 class="title">Class synopsis</h2> <div class="classsynopsis"> <div class="ooclass"></div> <div class="classsynopsisinfo"> <span class="ooclass"> <strong class="classname">RecursiveCachingIterator</strong> </span> <span class="ooclass"> <span class="modifier">extends</span> <a href="class.cachingiterator.html" class="classname">CachingIterator</a> </span> <span class="oointerface">implements <span class="interfacename"><a href="class.countable.html" class="interfacename">Countable</a></span> </span> <span class="oointerface">, <span class="interfacename"><a href="class.arrayaccess.html" class="interfacename">ArrayAccess</a></span> </span> <span class="oointerface">, <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="recursivecachingiterator.construct.html" class="methodname">__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> [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$flags</code><span class="initializer"> = self::CALL_TOSTRING</span></span> ] )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">RecursiveCachingIterator</span> <span class="methodname"><a href="recursivecachingiterator.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">bool</span> <span class="methodname"><a href="recursivecachingiterator.haschildren.html" class="methodname">hasChildren</a></span> ( <span class="methodparam">void</span> )</div> <div class="classsynopsisinfo classsynopsisinfo_comment">/* Inherits */</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="methodname"><a href="cachingiterator.construct.html" class="methodname">CachingIterator::__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> [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$flags</code><span class="initializer"> = self::CALL_TOSTRING</span></span> ] )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="cachingiterator.count.html" class="methodname">CachingIterator::count</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="cachingiterator.current.html" class="methodname">CachingIterator::current</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="cachingiterator.getcache.html" class="methodname">CachingIterator::getCache</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="cachingiterator.getflags.html" class="methodname">CachingIterator::getFlags</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="cachingiterator.getinneriterator.html" class="methodname">CachingIterator::getInnerIterator</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="cachingiterator.hasnext.html" class="methodname">CachingIterator::hasNext</a></span> ( <span class="methodparam">void</span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">scalar</span> <span class="methodname"><a href="cachingiterator.key.html" class="methodname">CachingIterator::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="cachingiterator.next.html" class="methodname">CachingIterator::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="cachingiterator.offsetexists.html" class="methodname">CachingIterator::offsetExists</a></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$index</code></span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="cachingiterator.offsetget.html" class="methodname">CachingIterator::offsetGet</a></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$index</code></span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="cachingiterator.offsetset.html" class="methodname">CachingIterator::offsetSet</a></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$index</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$newval</code></span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="cachingiterator.offsetunset.html" class="methodname">CachingIterator::offsetUnset</a></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$index</code></span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="cachingiterator.rewind.html" class="methodname">CachingIterator::rewind</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="cachingiterator.setflags.html" class="methodname">CachingIterator::setFlags</a></span> ( <span class="methodparam"><span class="type"><span class="type bitmask">bitmask</span></span> <code class="parameter">$flags</code></span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="cachingiterator.tostring.html" class="methodname">CachingIterator::__toString</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="cachingiterator.valid.html" class="methodname">CachingIterator::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="recursivecachingiterator.construct.html">RecursiveCachingIterator::__construct</a> — Construct</li><li><a href="recursivecachingiterator.getchildren.html">RecursiveCachingIterator::getChildren</a> — Return the inner iterator's children as a RecursiveCachingIterator</li><li><a href="recursivecachingiterator.haschildren.html">RecursiveCachingIterator::hasChildren</a> — Check whether the current element of the inner iterator has children</li></ul> </div> <hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="recursivearrayiterator.haschildren.html">RecursiveArrayIterator::hasChildren</a></div> <div class="next" style="text-align: right; float: right;"><a href="recursivecachingiterator.construct.html">RecursiveCachingIterator::__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>