archived-doc-ru/reference/math/functions/max.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 761d72245071f89a626903c9bcdc6aaff1252d54 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.max" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>max</refname>
  <refpurpose>Возвращает наибольшее значение</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>max</methodname>
   <methodparam><type>mixed</type><parameter>value</parameter></methodparam>
   <methodparam rep="repeat"><type>mixed</type><parameter>values</parameter></methodparam>
  </methodsynopsis>
  <simpara>Альтернативная сигнатура (не поддерживается с именованными аргументами):</simpara>
  <methodsynopsis>
   <type>mixed</type><methodname>max</methodname>
   <methodparam><type>array</type><parameter>value_array</parameter></methodparam>
  </methodsynopsis>
  <para>
   Функция <function>max</function> вернёт наибольшее значение массива,
   если первый и единственный параметр — массив. Функция <function>max</function> вернёт наибольший параметр,
   если передали хотя бы два параметра.
  </para>
  <note>
   <para>
    Функция сравнивает разнотипные значения
    <link linkend="language.operators.comparison">по стандартным правилами сравнения</link>.
    Нечисловую строку (<type>string</type>), например, функция сравнит с целым числом
    (<type>int</type>) так, как если бы значение строки равнялось <literal>0</literal>,
    но нечисловые строки (<type>string</type>) между собой сравниваются в алфавитно-цифровом
    порядке. Значение, которое вернёт функция, сохранит исходный тип без преобразования.
   </para>
  </note>
  <caution>
   <simpara>
    При передаче разнотипных аргументов соблюдают осторожность,
    поскольку при сравнении значений разных типов функция <function>max</function> возвращшает непредсказуемый результат.
   </simpara>
  </caution>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       Произвольное <link linkend="language.operators.comparison">сравнимое</link>
       значение.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>values</parameter></term>
     <listitem>
      <para>
       Любые <link linkend="language.operators.comparison">сравнимые</link>
       значения.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>value_array</parameter></term>
     <listitem>
      <para>
       Массив значений.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция <function>max</function> вернёт значение параметра,
   который посчитает «наибольшим» по стандартным правилам сравнения.
   Функция вернёт первое значение, если разнотипные значения оцениваются как равные (например,
   <literal>0</literal> и <literal>«abc»</literal>).
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Функция <function>max</function> выбрасывает исключение <classname>ValueError</classname>,
   если передали пустой массив.
  </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.0.0</entry>
      <entry>
       Функция <function>max</function> теперь выбрасывает исключение <classname>ValueError</classname>,
       если возникла ошибка;
       раньше возвращалось значение &false; и выдавалась ошибка уровня <constant>E_WARNING</constant>.
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       Поскольку <link linkend="migration80.incompatible.core.string-number-comparision">
       сравнения строк с числами</link> изменились,
       функция <function>max</function> больше не возвращает
       другое значение в зависимости от порядка аргументов для таких случаев.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример получения наибольшего значения функцией <function>max</function></title>
    <programlisting role="php">
<![CDATA[
<?php

echo max(2, 3, 1, 6, 7), PHP_EOL;  // 7
echo max(array(2, 4, 5)), PHP_EOL; // 5

// Здесь сравниваются 0 > -1, поэтому 'hello' больше
echo max('hello', -1), PHP_EOL;    // hello

// При сравнении массивов разной длины функция max вернёт более длинный
$val = max(array(2, 2, 2), array(1, 1, 1, 1)); // array(1, 1, 1, 1)
var_dump($val);

// При сравнении массивов одинаковой длины — функция max будет сравнивать их поэлементно
// слева направо, в этом примере 2 == 2, но 4 < 5
$val = max(array(2, 4, 8), array(2, 5, 1)); // array(2, 5, 1)
var_dump($val);

// Если передан массив и не массив, будет возвращён массив
$val = max('string', array(2, 5, 7), 42);   // array(2, 5, 7)
var_dump($val);

// Значение NULL или логическое значение, которое передали в каком-либо аргументе, сравнивается с другими
// значениями по правилу FALSE < TRUE независимо
// от типа других аргументов.
// В следующем примере значение -10 трактуется как значение TRUE
$val = max(-10, FALSE); // -10
var_dump($val);

// 0 трактуется как FALSE, значит, он «меньше» TRUE
$val = max(0, TRUE); // TRUE
var_dump($val);

?>
]]>
    </programlisting>
    </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>min</function></member>
    <member><function>count</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
-->