setflags.xml

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

<refentry xml:id="arrayiterator.setflags" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>ArrayIterator::setFlags</refname>
  <refpurpose>Set behaviour flags</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>void</type><methodname>ArrayIterator::setFlags</methodname>
   <methodparam><type>string</type><parameter>flags</parameter></methodparam>
  </methodsynopsis>
  <para>
   Set the flags that change the behavior of the ArrayIterator.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       The new ArrayIterator behavior.
       It takes on either a bitmask, or named constants. Using named
       constants is strongly encouraged to ensure compatibility for future
       versions.
      </para>
      <para>
       The available behavior flags are listed below. The actual
       meanings of these flags are described in the
       <link linkend="arrayiterator.constants">predefined constants</link>.
       <table>
        <title>ArrayIterator behavior flags</title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>value</entry>
           <entry>constant</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry>1</entry>
           <entry>
            <link linkend="arrayiterator.constants.std-prop-list">ArrayIterator::STD_PROP_LIST</link>
           </entry>
          </row>
          <row>
           <entry>2</entry>
           <entry>
            <link linkend="arrayiterator.constants.array-as-props">ArrayIterator::ARRAY_AS_PROPS</link>
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

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

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>ArrayIterator::getFlags</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
-->