arrayiterator.xml

<?xml version="1.0" encoding="utf-8" ?>
<!-- $Revision$ -->
<!-- EN-Revision: 6a2ad3ecf9b77855446019ed2d74aa6f734d35a8 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<reference xml:id="class.arrayiterator" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
 <title>ArrayIterator クラス</title>
 <titleabbrev>ArrayIterator</titleabbrev>
 
 <partintro>
 
<!-- {{{ ArrayIterator intro -->
  <section xml:id="arrayiterator.intro">
   &reftitle.intro;
   <para>
    このイテレータは、配列やオブジェクトを反復処理する際に
    値やキーを修正したり、要素を削除することができます。
   </para>
   <para>
    同じ配列を何度も反復処理したい場合は、
    <classname>ArrayObject</classname> をインスタンス化し、
    内部に保持された配列を &foreach; で反復する際に暗黙に作られる
    <classname>ArrayIterator</classname> のインスタンスを使うか、
    <methodname>ArrayObject::getIterator</methodname>
    メソッドを手動でコールして作成することを推奨します。
   </para>
  </section>
<!-- }}} -->
 
  <section xml:id="arrayiterator.synopsis">
   &reftitle.classsynopsis;
 
<!-- {{{ Synopsis -->
   <classsynopsis class="class">
    <ooclass>
     <classname>ArrayIterator</classname>
    </ooclass>

    <oointerface>
     <modifier>implements</modifier>
     <interfacename>SeekableIterator</interfacename>
    </oointerface>

    <oointerface>
     <interfacename>ArrayAccess</interfacename>
    </oointerface>

    <oointerface>
     <interfacename>Serializable</interfacename>
    </oointerface>

    <oointerface>
     <interfacename>Countable</interfacename>
    </oointerface>

    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="arrayiterator.constants.std-prop-list">ArrayIterator::STD_PROP_LIST</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="arrayiterator.constants.array-as-props">ArrayIterator::ARRAY_AS_PROPS</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:constructorsynopsis[@role='ArrayIterator'])"/>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.arrayiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='ArrayIterator'])"/>
   </classsynopsis>
 
  </section>

  <section xml:id="arrayiterator.constants">
   &reftitle.constants;
   <section xml:id="arrayiterator.constants.flags">
    <title>ArrayIterator のフラグ</title>
    <variablelist>

     <varlistentry xml:id="arrayiterator.constants.std-prop-list">
      <term><constant>ArrayIterator::STD_PROP_LIST</constant></term>
      <listitem>
       <para>
       オブジェクトのプロパティが、
       リストとして(<function>var_dump</function>, &foreach; などから)アクセスされたときの通常の機能を持つ
       </para>
      </listitem>
     </varlistentry>

     <varlistentry xml:id="arrayiterator.constants.array-as-props">
      <term><constant>ArrayIterator::ARRAY_AS_PROPS</constant></term>
      <listitem>
       <para>エントリがプロパティとしてアクセスできる(読み書きともに)</para>
      </listitem>
     </varlistentry>
    </variablelist>
   </section>
  </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>
}}} -->
 
  <section role="changelog">
   &reftitle.changelog;
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      &changelog.class-constants-typed;
     </tbody>
    </tgroup>
   </informaltable>
  </section>

 </partintro>
 
 &reference.spl.entities.arrayiterator;
 
</reference>
<!-- 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
-->