<!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>Sets the operation mode.</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="regexiterator.setflags.html">RegexIterator::setFlags</a></div>
<div class="next" style="text-align: right; float: right;"><a href="regexiterator.setpregflags.html">RegexIterator::setPregFlags</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.setmode" class="refentry">
<div class="refnamediv">
<h1 class="refname">RegexIterator::setMode</h1>
<p class="verinfo">(PHP 5 >= 5.2.0)</p><p class="refpurpose"><span class="refname">RegexIterator::setMode</span> — <span class="dc-title">Sets the operation mode.</span></p>
</div>
<div class="refsect1 description" id="refsect1-regexiterator.setmode-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>RegexIterator::setMode</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$mode</code></span>
)</div>
<p class="para rdfs-comment">
Sets the operation mode.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-regexiterator.setmode-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">mode</code></em></span>
<dd>
<p class="para">
The operation mode.
</p>
<p class="para">
The available modes are listed below. The actual
meanings of these modes are described in the
<a href="class.regexiterator.html#regexiterator.constants" class="link">predefined constants</a>.
<table class="doctable table">
<caption><strong><a href="class.regexiterator.html" class="classname">RegexIterator</a> modes</strong></caption>
<thead>
<tr>
<th>value</th>
<th>constant</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>0</td>
<td>
<a href="class.regexiterator.html#regexiterator.constants.match" class="link">RegexIterator::MATCH</a>
</td>
</tr>
<tr>
<td>1</td>
<td>
<a href="class.regexiterator.html#regexiterator.constants.get-match" class="link">RegexIterator::GET_MATCH</a>
</td>
</tr>
<tr>
<td>2</td>
<td>
<a href="class.regexiterator.html#regexiterator.constants.all-matches" class="link">RegexIterator::ALL_MATCHES</a>
</td>
</tr>
<tr>
<td>3</td>
<td>
<a href="class.regexiterator.html#regexiterator.constants.split" class="link">RegexIterator::SPLIT</a>
</td>
</tr>
<tr>
<td>4</td>
<td>
<a href="class.regexiterator.html#regexiterator.constants.replace" class="link">RegexIterator::REPLACE</a>
</td>
</tr>
</tbody>
</table>
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-regexiterator.setmode-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No value is returned.
</p>
</div>
<div class="refsect1 examples" id="refsect1-regexiterator.setmode-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="regexiterator.setmode.example.basic">
<p><strong>Example #1 <span class="methodname"><strong>RegexIterator::setMode()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$test </span><span style="color: #007700">= array (</span><span style="color: #DD0000">'str1' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'test 1'</span><span style="color: #007700">, </span><span style="color: #DD0000">'test str2' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'another test'</span><span style="color: #007700">, </span><span style="color: #DD0000">'str3' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'test 123'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$arrayIterator </span><span style="color: #007700">= new </span><span style="color: #0000BB">ArrayIterator</span><span style="color: #007700">(</span><span style="color: #0000BB">$test</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// Filter everything that starts with 'test ' followed by one or more numbers.<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 (\d+)/'</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// Operation mode: Replace actual value with the matches<br /></span><span style="color: #0000BB">$regexIterator</span><span style="color: #007700">-></span><span style="color: #0000BB">setMode</span><span style="color: #007700">(</span><span style="color: #0000BB">RegexIterator</span><span style="color: #007700">::</span><span style="color: #0000BB">GET_MATCH</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">$key </span><span style="color: #007700">=> </span><span style="color: #0000BB">$value</span><span style="color: #007700">) {<br /> </span><span style="color: #FF8000">// print out the matched number(s)<br /> </span><span style="color: #007700">echo </span><span style="color: #0000BB">$key </span><span style="color: #007700">. </span><span style="color: #DD0000">' => ' </span><span style="color: #007700">. </span><span style="color: #0000BB">$value</span><span style="color: #007700">[</span><span style="color: #0000BB">1</span><span style="color: #007700">] . </span><span style="color: #0000BB">PHP_EOL</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>
str1 => 1
str3 => 123
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-regexiterator.setmode-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="regexiterator.getmode.html" class="methodname" rel="rdfs-seeAlso">RegexIterator::getMode()</a> - Returns operation mode.</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.setflags.html">RegexIterator::setFlags</a></div>
<div class="next" style="text-align: right; float: right;"><a href="regexiterator.setpregflags.html">RegexIterator::setPregFlags</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>
