<!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 RecursiveRegexIterator class</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="recursiveiteratoriterator.valid.html">RecursiveIteratorIterator::valid</a></div> <div class="next" style="text-align: right; float: right;"><a href="recursiveregexiterator.construct.html">RecursiveRegexIterator::__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.recursiveregexiterator" class="reference"> <h1 class="title">The RecursiveRegexIterator class</h1> <div class="partintro"><p class="verinfo">(PHP 5 >= 5.2.0)</p> <div class="section" id="recursiveregexiterator.intro"> <h2 class="title">Introduction</h2> <p class="para"> This recursive iterator can filter another recursive iterator via a regular expression. </p> </div> <div class="section" id="recursiveregexiterator.synopsis"> <h2 class="title">Class synopsis</h2> <div class="classsynopsis"> <div class="ooclass"></div> <div class="classsynopsisinfo"> <span class="ooclass"> <strong class="classname">RecursiveRegexIterator</strong> </span> <span class="ooclass"> <span class="modifier">extends</span> <a href="class.regexiterator.html" class="classname">RegexIterator</a> </span> <span class="oointerface">implements <span class="interfacename"><a href="class.recursiveiterator.html" class="interfacename">RecursiveIterator</a></span> </span> {</div> <div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div> <div class="constructorsynopsis dc-description"> <span class="modifier">public</span> <span class="methodname"><a href="recursiveregexiterator.construct.html" class="methodname">__construct</a></span> ( <span class="methodparam"><span class="type"><a href="class.recursiveiterator.html" class="type RecursiveIterator">RecursiveIterator</a></span> <code class="parameter">$iterator</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$regex</code></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$mode</code><span class="initializer"> = self::MATCH</span></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code><span class="initializer"> = 0</span></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$preg_flags</code><span class="initializer"> = 0</span></span> ]]] )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">RecursiveRegexIterator</span> <span class="methodname"><a href="recursiveregexiterator.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="recursiveregexiterator.haschildren.html" class="methodname">hasChildren</a></span> ( <span class="methodparam">void</span> )</div> <div class="classsynopsisinfo classsynopsisinfo_comment">/* Inherited methods */</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">RecursiveIterator</span> <span class="methodname"><a href="recursiveiterator.getchildren.html" class="methodname">RecursiveIterator::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="recursiveiterator.haschildren.html" class="methodname">RecursiveIterator::hasChildren</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="regexiterator.accept.html" class="methodname">RegexIterator::accept</a></span> ( <span class="methodparam">void</span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="regexiterator.getflags.html" class="methodname">RegexIterator::getFlags</a></span> ( <span class="methodparam">void</span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="regexiterator.getmode.html" class="methodname">RegexIterator::getMode</a></span> ( <span class="methodparam">void</span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="regexiterator.getpregflags.html" class="methodname">RegexIterator::getPregFlags</a></span> ( <span class="methodparam">void</span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="regexiterator.getregex.html" class="methodname">RegexIterator::getRegex</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="regexiterator.setflags.html" class="methodname">RegexIterator::setFlags</a></span> ( <span class="methodparam"><span class="type">int</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="regexiterator.setmode.html" class="methodname">RegexIterator::setMode</a></span> ( <span class="methodparam"><span class="type">int</span> <code class="parameter">$mode</code></span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="regexiterator.setpregflags.html" class="methodname">RegexIterator::setPregFlags</a></span> ( <span class="methodparam"><span class="type">int</span> <code class="parameter">$preg_flags</code></span> )</div> }</div> </div> </div> <h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="recursiveregexiterator.construct.html">RecursiveRegexIterator::__construct</a> — Creates a new RecursiveRegexIterator.</li><li><a href="recursiveregexiterator.getchildren.html">RecursiveRegexIterator::getChildren</a> — Returns an iterator for the current entry.</li><li><a href="recursiveregexiterator.haschildren.html">RecursiveRegexIterator::hasChildren</a> — Returns whether an iterator can be obtained for the current entry.</li></ul> </div> <hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="recursiveiteratoriterator.valid.html">RecursiveIteratorIterator::valid</a></div> <div class="next" style="text-align: right; float: right;"><a href="recursiveregexiterator.construct.html">RecursiveRegexIterator::__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>