iterator-to-array.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b8758b0605e80c4e3610137b7502a6abeea5c69b Maintainer: seros Status: ready -->
<!-- Reviewed: yes Maintainer: seros -->
<refentry xml:id="function.iterator-to-array" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>iterator_to_array</refname>
  <refpurpose>Copiar el iterador a un array</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>iterator_to_array</methodname>
   <methodparam><type>Traversable</type><parameter>iterator</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>use_keys</parameter><initializer>&true;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Copia los elementos de un iterador a un array.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>iterator</parameter></term>
     <listitem>
      <para>
       El iterador a copiar.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>use_keys</parameter></term>
     <listitem>
      <para>
       Si usar las claves del elemento iterador como índice.
      </para>
      <para>
       En PHP 5.5 y posterior, si una clave es un <type>array</type> u
       <type>object</type>, se generará una advertencia. Las claves &null; serán
       convertidas a un string vacío, las claves <type>float</type> serán
       truncadas a su equivalente <type>integer</type>,
       las claves <type>resource</type> generarán una advertencia y serán convertidas a
       sus ID de recurso, y las claves <type>boolean</type> serán convertidas a
       enteros.
      </para>
      <note>
       <para>
        Si no se establece este parámetro o se establece a &true;, las claves duplicadas serán
        sobrescritas. El último valor con una clave dada estará en el <type>array</type>
        devuelto. Para obtener todos los valores en cualquier caso, se ha de establecer
        este parámetro a &false;.
       </para>
      </note>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Un <type>array</type> que contiene los elementos del <parameter>iterator</parameter>.
  </para>
 </refsect1>
 
 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>5.5.0</entry>
       <entry>
        <function>iterator_to_array</function> da soporte a tipos de claves
        diferentes a <type>integer</type> y <type>string</type> cuando el
        parámetro <parameter>use_keys</parameter> está habilitado.
       </entry>
      </row>
      <row>
       <entry>5.2.1</entry>
       <entry>
        Añadido el parámetro <parameter>use_keys</parameter>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo de <function>iterator_to_array</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$iterator = new ArrayIterator(array('recipe'=>'panqueques', 'huevo', 'leche', 'harina'));
var_dump(iterator_to_array($iterator, true));
var_dump(iterator_to_array($iterator, false));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
array(4) {
  ["recipe"]=>
  string(10) "panqueques"
  [0]=>
  string(5) "huevo"
  [1]=>
  string(5) "leche"
  [2]=>
  string(6) "harina"
}
array(4) {
  [0]=>
  string(10) "panqueques"
  [1]=>
  string(5) "huevo"
  [2]=>
  string(5) "leche"
  [3]=>
  string(6) "harina"
}
]]>
    </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
-->