array-reduce.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 31cacb6f262f455c616094cfe6d09bc0d1df2748 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.array-reduce" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>array_reduce</refname>
  <refpurpose>Réduit itérativement un tableau</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> applique itérativement
   la fonction <parameter>callback</parameter> aux éléments du
   tableau <parameter>array</parameter>, de manière à réduire le
   tableau à une valeur simple.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>array</parameter></term>
     <listitem>
      <para>
       Le tableau d'entrée.
      </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>
          Contient la valeur retournée de l'itération précédente ; dans le cas de
          la première itération, ce sera la valeur du paramètre
          <parameter>initial</parameter>.
         </para>
        </listitem>
       </varlistentry>
       <varlistentry>
        <term><parameter>item</parameter></term>
        <listitem>
         <para>
          Contient la valeur de l'itération courante.
         </para>
        </listitem>
       </varlistentry>
      </variablelist>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>initial</parameter></term>
     <listitem>
      <para>
       Si l'argument optionnel <parameter>initial</parameter>
       est disponible, il sera utilisé pour initialiser le processus,
       ou bien comme valeur finale si le tableau est vide.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne la valeur résultante.
  </para>
  <para>
   Si le tableau est vide et le paramètre <parameter>initial</parameter>
   n'est pas passé, <function>array_reduce</function> retourne &null;.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &array.changelog.by-ref;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>array_reduce</function></title>
    <programlisting role="php">
<![CDATA[
<?php
function sum($carry, $item)
{
    $carry += $item;
    return $carry;
}

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

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

var_dump(array_reduce($a, "sum")); // int(15)
var_dump(array_reduce($a, "product", 10)); // int(1200), car : 10*1*2*3*4*5
var_dump(array_reduce($x, "sum", "No data to reduce")); // string(17) "No data to reduce"
?>
]]>
    </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
-->