iterator-to-array.xml

<?xml version="1.0" encoding="utf-8" ?>
<!-- $Revision$ -->
<!-- EN-Revision: 70ac605e66b5ce0c03a345df92297f3e03f088ca Maintainer: shimooka Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.iterator-to-array" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>iterator_to_array</refname>
  <refpurpose>イテレータを配列にコピーする</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>iterator_to_array</methodname>
   <methodparam><type class="union"><type>Traversable</type><type>array</type></type><parameter>iterator</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>preserve_keys</parameter><initializer>&true;</initializer></methodparam>
  </methodsynopsis>
  <para>
   イテレータの要素を配列にコピーします。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>iterator</parameter></term>
     <listitem>
      <para>
       コピーしたいイテレータ。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>preserve_keys</parameter></term>
     <listitem>
      <para>
       イテレータの要素のキーをインデックスとして使用するかどうか。
      </para>
      <para>
       キーが <type>array</type> あるいは <type>object</type>
       の場合は、警告が発生します。
       キーが &null; の場合は空文字列に変換し、キーが <type>float</type>
       の場合は <type>int</type> 型になるよう切り詰めます。
       キーが <type>resource</type> の場合は警告を発し、リソース ID に変換します。
       また、キーが <type>bool</type> の場合は整数値に変換します。
      </para>
      <note>
       <para>
        このパラメータを省略したり &true; を指定したりした場合は、
        重複するキーは上書きされます。そのキーに対して最後にあらわれた値が
        <type>array</type> で返されることになります。
        このパラメータを &false; にすると、重複があってもすべての値を返します。
       </para>
      </note>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <parameter>iterator</parameter> の要素を含む配列を返します。
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.2.0</entry>
      <entry>
       <parameter>iterator</parameter> の型が
       <type>Traversable</type> から、
       <type class="union"><type>Traversable</type><type>array</type></type>
       に拡大されました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>iterator_to_array</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$iterator = new ArrayIterator(array('recipe'=>'pancakes', 'egg', 'milk', 'flour'));
var_dump(iterator_to_array($iterator, true));
var_dump(iterator_to_array($iterator, false));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
array(4) {
  ["recipe"]=>
  string(8) "pancakes"
  [0]=>
  string(3) "egg"
  [1]=>
  string(4) "milk"
  [2]=>
  string(5) "flour"
}
array(4) {
  [0]=>
  string(8) "pancakes"
  [1]=>
  string(3) "egg"
  [2]=>
  string(4) "milk"
  [3]=>
  string(5) "flour"
}
]]>
    </screen>
   </example>
  </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
-->