php-doc-en/reference/spl/arrayiterator.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.arrayiterator" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
 <title>The ArrayIterator class</title>
 <titleabbrev>ArrayIterator</titleabbrev>
 
 <partintro>
 
<!-- {{{ ArrayIterator intro -->
  <section xml:id="arrayiterator.intro">
   &reftitle.intro;
   <para>
    This iterator allows to unset and modify values and keys while iterating
    over Arrays and Objects.
   </para>
   <para>
    When you want to iterate over the same array multiple times you need to
    instantiate ArrayObject and let it create ArrayIterator instances that
    refer to it either by using &foreach; or by calling its getIterator()
    method manually. 
   </para>
  </section>
<!-- }}} -->
 
  <section xml:id="arrayiterator.synopsis">
   &reftitle.classsynopsis;
 
<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass><classname>ArrayIterator</classname></ooclass>
 
<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname>ArrayIterator</classname>
     </ooclass>

     <oointerface>
      <interfacename>ArrayAccess</interfacename>
     </oointerface>
 
     <oointerface>
      <interfacename>SeekableIterator</interfacename>
     </oointerface>
 
     <oointerface>
      <interfacename>Countable</interfacename>
     </oointerface>

     <oointerface>
      <interfacename>Serializable</interfacename>
     </oointerface>
 
    </classsynopsisinfo>
<!-- }}} -->
 
    <!-- {{{ If the property is documented below (xml:id=arrayiterator.props) use this
    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>string</type>
     <varname linkend="arrayiterator.props.name">name</varname>
    </fieldsynopsis>
    }}} -->
 
    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.arrayiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
   </classsynopsis>
 
  </section>
 
<!-- {{{ ArrayIterator properties
  <section xml:id="arrayiterator.props">
   &reftitle.properties;
   <variablelist>
    <varlistentry xml:id="arrayiterator.props.name">
     <term><varname>name</varname></term>
     <listitem>
      <para>Prop description</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
}}} -->
 
 </partintro>
 
 &reference.spl.entities.arrayiterator;
 
</phpdoc:classref>
 
<!-- 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
-->