<!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>Create a new RegexIterator</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="regexiterator.accept.html">RegexIterator::accept</a></div>
<div class="next" style="text-align: right; float: right;"><a href="regexiterator.getflags.html">RegexIterator::getFlags</a></div>
<div class="up"><a href="class.regexiterator.html">RegexIterator</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="regexiterator.construct" class="refentry">
<div class="refnamediv">
<h1 class="refname">RegexIterator::__construct</h1>
<p class="verinfo">(PHP 5 >= 5.2.0)</p><p class="refpurpose"><span class="refname">RegexIterator::__construct</span> — <span class="dc-title">Create a new RegexIterator</span></p>
</div>
<div class="refsect1 description" id="refsect1-regexiterator.construct-description">
<h3 class="title">Description</h3>
<div class="constructorsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><strong>RegexIterator::__construct()</strong></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">$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>
<p class="para rdfs-comment">
Create a new <a href="class.regexiterator.html" class="classname">RegexIterator</a> which filters an
<span class="interfacename"><a href="class.iterator.html" class="interfacename">Iterator</a></span> using a regular expression.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-regexiterator.construct-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">iterator</code></em></span>
<dd>
<p class="para">
The iterator to apply this regex filter to.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">regex</code></em></span>
<dd>
<p class="para">
The regular expression to match.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">mode</code></em></span>
<dd>
<p class="para">
Operation mode, see <span class="methodname"><a href="regexiterator.setmode.html" class="methodname">RegexIterator::setMode()</a></span> for a list
of modes.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">flags</code></em></span>
<dd>
<p class="para">
Special flags, see <span class="methodname"><a href="regexiterator.setflags.html" class="methodname">RegexIterator::setFlags()</a></span> for a list
of available flags.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">preg_flags</code></em></span>
<dd>
<p class="para">
The regular expression flags. These flags depend on the operation mode parameter:
</p>
<p class="para">
<table class="doctable table">
<caption><strong><a href="class.regexiterator.html" class="classname">RegexIterator</a> preg_flags</strong></caption>
<thead>
<tr>
<th>operation mode</th>
<th>available flags</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td><var class="varname"><var class="varname">RegexIterator::ALL_MATCHES</var></var></td>
<td>
See <span class="function"><a href="function.preg-match-all.html" class="function">preg_match_all()</a></span>.
</td>
</tr>
<tr>
<td><var class="varname"><var class="varname">RegexIterator::GET_MATCH</var></var></td>
<td>
See <span class="function"><a href="function.preg-match.html" class="function">preg_match()</a></span>.
</td>
</tr>
<tr>
<td><var class="varname"><var class="varname">RegexIterator::MATCH</var></var></td>
<td>
See <span class="function"><a href="function.preg-match.html" class="function">preg_match()</a></span>.
</td>
</tr>
<tr>
<td><var class="varname"><var class="varname">RegexIterator::REPLACE</var></var></td>
<td>
none.
</td>
</tr>
<tr>
<td><var class="varname"><var class="varname">RegexIterator::SPLIT</var></var></td>
<td>
See <span class="function"><a href="function.preg-split.html" class="function">preg_split()</a></span>.
</td>
</tr>
</tbody>
</table>
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 examples" id="refsect1-regexiterator.construct-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3902">
<p><strong>Example #1 <span class="function"><strong>RegexIterator::__construct()</strong></span> example</strong></p>
<div class="example-contents"><p>
Creates a new RegexIterator that filters all strings that start with 'test'.
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$arrayIterator </span><span style="color: #007700">= new </span><span style="color: #0000BB">ArrayIterator</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'test 1'</span><span style="color: #007700">, </span><span style="color: #DD0000">'another test'</span><span style="color: #007700">, </span><span style="color: #DD0000">'test 123'</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$regexIterator </span><span style="color: #007700">= new </span><span style="color: #0000BB">RegexIterator</span><span style="color: #007700">(</span><span style="color: #0000BB">$arrayIterator</span><span style="color: #007700">, </span><span style="color: #DD0000">'/^test/'</span><span style="color: #007700">);<br /><br />foreach (</span><span style="color: #0000BB">$regexIterator </span><span style="color: #007700">as </span><span style="color: #0000BB">$value</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">$value </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</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>
test 1
test 123
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-regexiterator.construct-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.preg-match.html" class="function" rel="rdfs-seeAlso">preg_match()</a> - Perform a regular expression match</span></li>
<li class="member"> <span class="function"><a href="function.preg-match-all.html" class="function" rel="rdfs-seeAlso">preg_match_all()</a> - Perform a global regular expression match</span></li>
<li class="member"> <span class="function"><a href="function.preg-replace.html" class="function" rel="rdfs-seeAlso">preg_replace()</a> - Perform a regular expression search and replace</span></li>
<li class="member"> <span class="function"><a href="function.preg-split.html" class="function" rel="rdfs-seeAlso">preg_split()</a> - Split string by a regular expression</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="regexiterator.accept.html">RegexIterator::accept</a></div>
<div class="next" style="text-align: right; float: right;"><a href="regexiterator.getflags.html">RegexIterator::getFlags</a></div>
<div class="up"><a href="class.regexiterator.html">RegexIterator</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
