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

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 761d72245071f89a626903c9bcdc6aaff1252d54 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.max" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
  <refname>max</refname>
  <refpurpose>La plus grande valeur</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>Signature alternative (non supportée avec les arguments nommés) :</simpara>
  <methodsynopsis>
   <type>mixed</type><methodname>max</methodname>
   <methodparam><type>array</type><parameter>value_array</parameter></methodparam>
  </methodsynopsis>
  <para>
   Si le premier et unique paramètre est un tableau, <function>max</function>
   retourne la valeur la plus haute du tableau. Si au moins deux paramètres
   sont fournis, <function>max</function> retourne la plus grosse de
   ces valeurs.
  </para>
  <note>
   <para>
    Les valeurs de différents types seront comparées en utilisant
    les <link linkend="language.operators.comparison">règles de
    comparaison standard</link>. Actuellement, une chaîne non numérique
    sera comparée à un &integer;, comme s'il s'agissait de la valeur
    <literal>0</literal>, mais plusieurs &string; non-numérique seront comparées de façon
    alphanumérique. La valeur actuelle retournée sera du même type que
    l'original et aucune conversion de type ne sera appliquée.
   </para>
  </note>
  <caution>
   <simpara>
    Il faut être prudent lorsqu'on passe des arguments avec des types différents,
    car <function>max</function> peut produire des résultats imprévisibles.
   </simpara>
  </caution>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       Toute valeur <link linkend="language.operators.comparison">comparable</link>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>values</parameter></term>
     <listitem>
      <para>
       Toutes valeurs <link linkend="language.operators.comparison">comparables</link>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>value_array</parameter></term>
     <listitem>
      <para>
       Un tableau contenant les valeurs.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>    
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   La fonction <function>max</function> retourne la valeur du paramètre
   considéré comme "supérieure" suivant la comparaison standard.
   Si plusieurs valeurs de types différents sont évaluées comme étant égales
   (c.-à-d. <literal>0</literal> et <literal>'abc'</literal>), la première fournie
   à la fonction sera retournée.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Si un tableau vide est passé, la fonction <function>max</function> lance une <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> lance désormais une <classname>ValueError</classname> en cas d'échec ;
       précédemment, &false; était renvoyé et une erreur <constant>E_WARNING</constant> était émise.
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       Comme les <link linkend="migration80.incompatible.core.string-number-comparision">
       comparaisons entre les chaînes et les nombres</link> ont été changées,
       <function>max</function> ne retourne plus une valeur différente
       basée sur l'ordre des arguments dans ces cas là.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <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

// Ici, nous comparons -1 < 0, aussi 'hello' est la plus grande valeur
echo max('hello', -1), PHP_EOL;    // hello

// Avec plusieurs tableaux de tailles différentes, max retourne
// le plus long
$val = max(array(2, 2, 2), array(1, 1, 1, 1)); // array(1, 1, 1, 1)
var_dump($val);

// Plusieurs tableaux de même longueur sont comparés de la gauche vers la droite
// aussi, dans notre exemple : 2 == 2, but 5 > 4
$val = max(array(2, 4, 8), array(2, 5, 1)); // array(2, 5, 1)
var_dump($val);

// Si un tableau et un non-tableau sont fournis, le tableau sera toujours
// retourné, sachant que les comparaisons traitent les tableaux comme
// étant plus grand que n'importe quelle valeur
$val = max('string', array(2, 5, 7), 42);   // array(2, 5, 7)
var_dump($val);

// Si un argument vaut NULL ou est un booléen, il sera comparé avec les autres
// valeurs en utilisant la règle FALSE < TRUE suivant les autres types concernés
// Dans l'exemple ci-dessous, -10 est traité comme valant TRUE dans la comparaison
$val = max(-10, FALSE); // -10
var_dump($val);

// D'un autre côté, 0 est traité comme valant FALSE, aussi, il est "plus petit que" 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
-->