php-doc-en/reference/spl/regexiterator/construct.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="regexiterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>RegexIterator::__construct</refname>
  <refpurpose>Create a new RegexIterator</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <constructorsynopsis>
   <modifier>public</modifier> <methodname>RegexIterator::__construct</methodname>
   <methodparam><type>Iterator</type><parameter>iterator</parameter></methodparam>
   <methodparam><type>string</type><parameter>regex</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer>self::MATCH</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>preg_flags</parameter><initializer>0</initializer></methodparam>
  </constructorsynopsis>

  <para>
   Create a new <classname>RegexIterator</classname> which filters an
   <interfacename>Iterator</interfacename> using a regular expression.
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>iterator</parameter></term>
     <listitem>
      <para>
       The iterator to apply this regex filter to.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>regex</parameter></term>
     <listitem>
      <para>
       The regular expression to match.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       Operation mode, see <methodname>RegexIterator::setMode</methodname> for a list
       of modes.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Special flags, see <methodname>RegexIterator::setFlags</methodname> for a list
       of available flags.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>preg_flags</parameter></term>
     <listitem>
      <para>
       The regular expression flags. These flags depend on the operation mode parameter:
      </para>
      <para>
      <table>
        <title><classname>RegexIterator</classname> preg_flags</title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>operation mode</entry>
           <entry>available flags</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><varname linkend="regexiterator.constants.all-matches">RegexIterator::ALL_MATCHES</varname></entry>
           <entry>
            See <function>preg_match_all</function>.
           </entry>
          </row>
          <row>
           <entry><varname linkend="regexiterator.constants.get-match">RegexIterator::GET_MATCH</varname></entry>
           <entry>
            See <function>preg_match</function>.
           </entry>
          </row>
          <row>
           <entry><varname linkend="regexiterator.constants.match">RegexIterator::MATCH</varname></entry>
           <entry>
            See <function>preg_match</function>.
           </entry>
          </row>
          <row>
           <entry><varname linkend="regexiterator.constants.replace">RegexIterator::REPLACE</varname></entry>
           <entry>
            none.
           </entry>
          </row>
          <row>
           <entry><varname linkend="regexiterator.constants.split">RegexIterator::SPLIT</varname></entry>
           <entry>
            See <function>preg_split</function>.
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
<refsect1 role="errors">
  &reftitle.errors;
  <para>
   Throws an <classname>InvalidArgumentException</classname> if the <parameter>regex</parameter> argument is invalid.
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>RegexIterator::__construct</function> example</title>
    <para>
      Creates a new RegexIterator that filters all strings that start with 'test'.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$arrayIterator = new ArrayIterator(array('test 1', 'another test', 'test 123'));
$regexIterator = new RegexIterator($arrayIterator, '/^test/');

foreach ($regexIterator as $value) {
    echo $value . "\n";
}
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
test 1
test 123
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>preg_match</function></member>
    <member><function>preg_match_all</function></member>
    <member><function>preg_replace</function></member>
    <member><function>preg_split</function></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
-->