archived-doc-es/reference/array/functions/array-reduce.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 3c88ee68d175314e4d78d0d7e43d0dcae0526003 Maintainer: seros Status: ready -->
<!-- Reviewed: yes Maintainer: seros -->
<refentry xml:id="function.array-reduce" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>array_reduce</refname>
  <refpurpose>Reduce iterativamente un array a un solo valor usando una función llamada de retorno</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>array_reduce</methodname>
   <methodparam><type>array</type><parameter>array</parameter></methodparam>
   <methodparam><type>callable</type><parameter>callback</parameter></methodparam>
   <methodparam choice="opt"><type>mixed</type><parameter>initial</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>array_reduce</function> aplica iterativamente la función
   <parameter>callback</parameter> a los elementos de
   <parameter>array</parameter>, con el propósito de reducir el array a
   un solo valor.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>array</parameter></term>
     <listitem>
      <para>
       El array de entrada.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>callback</parameter></term>
     <listitem>
      <methodsynopsis>
       <type>mixed</type><methodname><replaceable>callback</replaceable></methodname>
       <methodparam><type>mixed</type><parameter>carry</parameter></methodparam>
       <methodparam><type>mixed</type><parameter>item</parameter></methodparam>
      </methodsynopsis>
      <variablelist>
       <varlistentry>
        <term><parameter>carry</parameter></term>
        <listitem>
         <para>
          Conserva el valor de retorno de la iteración anterior; en el caso de que
          sea la primera iteración, conservará el valor de
          <parameter>initial</parameter>.
         </para>
        </listitem>
       </varlistentry>
       <varlistentry>
        <term><parameter>item</parameter></term>
        <listitem>
         <para>
          Conserva el valor de la iteración actual.
         </para>
        </listitem>
       </varlistentry>
      </variablelist>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>initial</parameter></term>
     <listitem>
      <para>
       Si el parámetro opcional <parameter>initial</parameter> está disponible,
       será usado al comienzo del proceso, o como un resultado final en caso de
       que el array esté vacío.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve el valor resultante.
  </para>
  <para>
   Si el array está vacío y no se proporciona el parámetro <parameter>initial</parameter>,
   <function>array_reduce</function> devuelve &null;.
  </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.3.0</entry>
       <entry>
        Se cambió el parámetro <parameter>initial</parameter> para permitir <type>mixed</type>, anteriormente era <type>integer</type>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1> 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo de <function>array_reduce</function></title>
    <programlisting role="php">
<![CDATA[
<?php
function suma($carry, $item)
{
    $carry += $item;
    return $carry;
}

function producto($carry, $item)
{
    $carry *= $item;
    return $carry;
}

$a = array(1, 2, 3, 4, 5);
$x = array();

var_dump(array_reduce($a, "suma")); // int(15)
var_dump(array_reduce($a, "producto", 10)); // int(1200), ya que: 10*1*2*3*4*5
var_dump(array_reduce($x, "suma", "No hay datos a reducir")); // string(22) "No hay datos a reducir"
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>array_filter</function></member>
    <member><function>array_map</function></member>
    <member><function>array_unique</function></member>
    <member><function>array_count_values</function></member>
   </simplelist>
  </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
-->