iterator-to-array.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 70ac605e66b5ce0c03a345df92297f3e03f088ca Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<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>) бросают предупреждение и преобразуются
       в их идентификаторы ресурса, а логические (<type>bool</type>)
       ключи преобразуются в целые числа.
      </para>
      <note>
       <para>
        Если параметр не задан, либо задан как &true;, дублирующиеся ключи будут
        перезаписаны. Последнее значение с заданным ключом будет в результирующем
        массиве. Установите этот параметр равным &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
-->