doc-fr/reference/math/functions/min.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 26a93ee76caae16995bc663220131d685f3b5c0b Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.min" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>min</refname>
  <refpurpose>La plus petite valeur</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>min</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é avec les arguments nommés) :</simpara>
  <methodsynopsis>
   <type>mixed</type><methodname>min</methodname>
   <methodparam><type>array</type><parameter>value_array</parameter></methodparam>
  </methodsynopsis>
  <para>
   Si le premier et le seul paramètre est un tableau, <function>min</function>
   retournera la plus petite valeur contenue dans le tableau. Si le
   premier paramètre est un entier, une chaîne ou un nombre décimal,
   vous devez fournir au moins deux paramètres et <function>min</function>
   retournera la plus petite 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>
    Soyez prudent lorsque vous passez des arguments avec des types différents,
    car <function>min</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>
       Toute valeurs <link linkend="language.operators.comparison">comparable</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>min</function> retourne la valeur du paramètre
   considéré comme "inférieure" suivant la comparaison standard.
   Si plusieurs valeurs de types différents sont évaluées comme étant égales
   (i.e. <literal>0</literal> et <literal>'abc'</literal>), la première fournie
   à la fonction sera retournée.
  </para>

  <para>
   Si un tableau vide est passé, alors &false; sera retourné et une erreur 
   <constant>E_WARNING</constant> sera émise.
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>min</function></title>
    <programlisting role="php">
<![CDATA[
<?php
echo min(2, 3, 1, 6, 7);  // 1
echo min(array(2, 4, 5)); // 2

// La chaîne 'hello' lorsque comparée à un entier, est traité comme étant de valeur 0.
// Sachant que les deux valeurs sont égales, l'ordre fourni va déterminer le résultat
echo min(0, 'hello');     // 0
echo min('hello', 0);     // hello

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

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

// Plusieurs tableaux de même taille sont comparés depuis la gauche vers la droite,
// aussi, dans notre exemple : 2 == 2, mais 4 < 5
$val = min(array(2, 4, 8), array(2, 5, 1)); // array(2, 4, 8)

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

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

// D'un autre côté, 0 est traité comme valant FALSE, aussi, il est "plus petit que" TRUE
$val = min(0, TRUE); // 0
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>max</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
-->