<!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>Returns operation mode.</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="regexiterator.getflags.html">RegexIterator::getFlags</a></div> <div class="next" style="text-align: right; float: right;"><a href="regexiterator.getpregflags.html">RegexIterator::getPregFlags</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.getmode" class="refentry"> <div class="refnamediv"> <h1 class="refname">RegexIterator::getMode</h1> <p class="verinfo">(PHP 5 >= 5.2.0)</p><p class="refpurpose"><span class="refname">RegexIterator::getMode</span> — <span class="dc-title">Returns operation mode.</span></p> </div> <div class="refsect1 description" id="refsect1-regexiterator.getmode-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><strong>RegexIterator::getMode</strong></span> ( <span class="methodparam">void</span> )</div> <p class="para rdfs-comment"> Returns the operation mode, see <span class="methodname"><a href="regexiterator.setmode.html" class="methodname">RegexIterator::setMode()</a></span> for the list of operation modes. </p> </div> <div class="refsect1 returnvalues" id="refsect1-regexiterator.getmode-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns the operation mode. </p> </div> <div class="refsect1 examples" id="refsect1-regexiterator.getmode-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="regexiterator.getmode.example.basic"> <p><strong>Example #1 <span class="methodname"><strong>RegexIterator::getMode()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><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">'teststr2' </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: #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">'/^[a-z]+/'</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 /></span><span style="color: #0000BB">$mode </span><span style="color: #007700">= </span><span style="color: #0000BB">$regexIterator</span><span style="color: #007700">-></span><span style="color: #0000BB">getMode</span><span style="color: #007700">();<br />if (</span><span style="color: #0000BB">$mode </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 /> echo </span><span style="color: #DD0000">'Getting the match for each item.'</span><span style="color: #007700">;<br />} elseif (</span><span style="color: #0000BB">$mode </span><span style="color: #007700">& </span><span style="color: #0000BB">RegexIterator</span><span style="color: #007700">::</span><span style="color: #0000BB">ALL_MATCHES</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">'Getting all matches for each item.'</span><span style="color: #007700">;<br />} elseif (</span><span style="color: #0000BB">$mode </span><span style="color: #007700">& </span><span style="color: #0000BB">RegexIterator</span><span style="color: #007700">::</span><span style="color: #0000BB">MATCH</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">'Getting each item if it matches.'</span><span style="color: #007700">;<br />} elseif (</span><span style="color: #0000BB">$mode </span><span style="color: #007700">& </span><span style="color: #0000BB">RegexIterator</span><span style="color: #007700">::</span><span style="color: #0000BB">SPLIT</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">'Getting split pieces of each.'</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:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> Getting the match for each item. </pre></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-regexiterator.getmode-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="methodname"><a href="regexiterator.setmode.html" class="methodname" rel="rdfs-seeAlso">RegexIterator::setMode()</a> - Sets the 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.getflags.html">RegexIterator::getFlags</a></div> <div class="next" style="text-align: right; float: right;"><a href="regexiterator.getpregflags.html">RegexIterator::getPregFlags</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>