php-doc-ru/reference/array/functions/array-reduce.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 5faa7a6747bca628b3bdcc9f93aec5603b65581f Maintainer: shein Status: ready -->
<!-- Reviewed: yes -->
<!-- $Revision$ -->
<refentry xml:id="function.array-reduce" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>array_reduce</refname>
  <refpurpose>Итеративно уменьшает массив к единственному значению, используя callback-функцию</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>array_reduce</methodname>
   <methodparam><type>array</type><parameter>input</parameter></methodparam>
   <methodparam><type>callable</type><parameter>function</parameter></methodparam>
   <methodparam choice="opt"><type>mixed</type><parameter>initial</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>array_reduce</function> итеративно применяет callback-функцию
   <parameter>function</parameter> к элементам массива
   <parameter>input</parameter> и, таким образом, сводит массив
   к единственному значению.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>input</parameter></term>
     <listitem>
      <para>
       Входной массив.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>function</parameter></term>
     <listitem>
      <para>
       Callback-функция.
      </para>
      <methodsynopsis>
       <type>mixed</type><methodname><replaceable>callback</replaceable></methodname>
       <methodparam><type>mixed</type><parameter role="reference">result</parameter></methodparam>
       <methodparam><type>mixed</type><parameter>item</parameter></methodparam>
      </methodsynopsis>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>initial</parameter></term>
     <listitem>
      <para>
       Если передан необязательный параметр <parameter>initial</parameter>,
       то он будет использован в начале процесса, или в качестве
       окончательного результата в случае пустого массива.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Возвращает получившееся значение.
  </para>
  <para>
   Если массив пуст и не передан параметр <parameter>initial</parameter>,
   <function>array_reduce</function> вернет &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>
        Параметр <parameter>initial</parameter> теперь позволяет 
        передать <type>mixed</type>, ранее передавался только 
        <type>integer</type>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример использования<function>array_reduce</function></title>
    <programlisting role="php">
<![CDATA[
<?php
function rsum($v, $w)
{
    $v += $w;
    return $v;
}

function rmul($v, $w)
{
    $v *= $w;
    return $v;
}

$a = array(1, 2, 3, 4, 5);
$x = array();
$b = array_reduce($a, "rsum");
$c = array_reduce($a, "rmul", 10);
$d = array_reduce($x, "rsum", "No data to reduce");
?>
]]>
    </programlisting>
    <para>
     В результате переменная <varname>$b</varname> содержит
     <literal>15</literal>, <varname>$c</varname> содержит
     <literal>1200</literal> (= 10*1*2*3*4*5*10), и
     <varname>$d</varname> содержит <literal>No data to reduce</literal>.
    </para>
   </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
-->