<!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>Get flags</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="regexiterator.construct.html">RegexIterator::__construct</a></div>
<div class="next" style="text-align: right; float: right;"><a href="regexiterator.getmode.html">RegexIterator::getMode</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.getflags" class="refentry">
<div class="refnamediv">
<h1 class="refname">RegexIterator::getFlags</h1>
<p class="verinfo">(PHP 5 >= 5.2.0)</p><p class="refpurpose"><span class="refname">RegexIterator::getFlags</span> — <span class="dc-title">Get flags</span></p>
</div>
<div class="refsect1 description" id="refsect1-regexiterator.getflags-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::getFlags</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Returns the flags, see <span class="methodname"><a href="regexiterator.setflags.html" class="methodname">RegexIterator::setFlags()</a></span>
for a list of available flags.
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-regexiterator.getflags-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the set flags.
</p>
</div>
<div class="refsect1 examples" id="refsect1-regexiterator.getflags-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="regexiterator.getflags.example.basic">
<p><strong>Example #1 <span class="methodname"><strong>RegexIterator::getFlags()</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">'/^test/'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$regexIterator</span><span style="color: #007700">-></span><span style="color: #0000BB">setFlags</span><span style="color: #007700">(</span><span style="color: #0000BB">RegexIterator</span><span style="color: #007700">::</span><span style="color: #0000BB">USE_KEY</span><span style="color: #007700">);<br /><br />if (</span><span style="color: #0000BB">$regexIterator</span><span style="color: #007700">-></span><span style="color: #0000BB">getFlags</span><span style="color: #007700">() & </span><span style="color: #0000BB">RegexIterator</span><span style="color: #007700">::</span><span style="color: #0000BB">USE_KEY</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">'Filtering based on the array keys.'</span><span style="color: #007700">;<br />} else {<br /> echo </span><span style="color: #DD0000">'Filtering based on the array values.'</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>
Filtering based on the array keys.
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-regexiterator.getflags-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="regexiterator.setflags.html" class="methodname" rel="rdfs-seeAlso">RegexIterator::setFlags()</a> - Sets the flags.</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.construct.html">RegexIterator::__construct</a></div>
<div class="next" style="text-align: right; float: right;"><a href="regexiterator.getmode.html">RegexIterator::getMode</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>
