<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="regexiterator.setmode" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>RegexIterator::setMode</refname>
  <refpurpose>Sets the operation mode</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="RegexIterator">
   <modifier>public</modifier> <type>void</type><methodname>RegexIterator::setMode</methodname>
   <methodparam><type>int</type><parameter>mode</parameter></methodparam>
  </methodsynopsis>
  <para>
   Sets the operation mode.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       The operation mode.
      </para>
      <para>
       The available modes are listed below. The actual
       meanings of these modes are described in the
       <link linkend="regexiterator.constants">predefined constants</link>.
       <table>
        <title><classname>RegexIterator</classname> modes</title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>value</entry>
           <entry>constant</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry>0</entry>
           <entry>
            <link linkend="regexiterator.constants.match">RegexIterator::MATCH</link>
           </entry>
          </row>
          <row>
           <entry>1</entry>
           <entry>
            <link linkend="regexiterator.constants.get-match">RegexIterator::GET_MATCH</link>
           </entry>
          </row>
          <row>
           <entry>2</entry>
           <entry>
            <link linkend="regexiterator.constants.all-matches">RegexIterator::ALL_MATCHES</link>
           </entry>
          </row>
          <row>
           <entry>3</entry>
           <entry>
            <link linkend="regexiterator.constants.split">RegexIterator::SPLIT</link>
           </entry>
          </row>
          <row>
           <entry>4</entry>
           <entry>
            <link linkend="regexiterator.constants.replace">RegexIterator::REPLACE</link>
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example xml:id="regexiterator.setmode.example.basic">
    <title><methodname>RegexIterator::setMode</methodname> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$test = array ('str1' => 'test 1', 'test str2' => 'another test', 'str3' => 'test 123');

$arrayIterator = new ArrayIterator($test);
// Filter everything that starts with 'test ' followed by one or more numbers.
$regexIterator = new RegexIterator($arrayIterator, '/^test (\d+)/');
// Operation mode: Replace actual value with the matches
$regexIterator->setMode(RegexIterator::GET_MATCH);

foreach ($regexIterator as $key => $value) {
    // print out the matched number(s)
    echo $key . ' => ' . $value[1] . PHP_EOL;
}
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
str1 => 1
str3 => 123
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>RegexIterator::getMode</methodname></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
