doc-fr/reference/misc/functions/constant.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 6c3091b54b66181db5f81ef5afe1d2e8b6efdeac Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.constant" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>constant</refname>
  <refpurpose>Retourne la valeur d'une constante</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>constant</methodname>
   <methodparam><type>string</type><parameter>name</parameter></methodparam>
  </methodsynopsis>
  <simpara>
   Retourne la valeur de la constante <parameter>name</parameter>.
  </simpara>
  <simpara>
   <function>constant</function> est pratique lorsque vous devez lire la
   valeur d'une constante, mais que vous ne connaissez son nom que durant
   l'exécution du script. Par exemple, ce nom peut être le résultat
   d'une fonction.
  </simpara>
  <simpara>
   Cette fonction fonctionne également avec les
   <link linkend="language.oop5.constants">constantes de classe</link> et <link
   linkend="language.types.enumerations">types enum</link>
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>name</parameter></term>
     <listitem>
      <para>
       Le nom de la constante.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne la valeur de la constante.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Si la constante n'est pas définie, une exception <classname>Error</classname> est levée.
   Antérieur à PHP 8.0.0, une erreur de niveau <constant>E_WARNING</constant> était émise dans ce cas.
  </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>
       Si la constante n'est pas définit, <function>constant</function> lance
       désormais une exception <classname>Error</classname> ; auparavant une
       <constant>E_WARNING</constant> était émise, et &null; était retourné.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>


 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Utilisation de la fonction <function>constant</function> avec des constantes</title>
    <programlisting role="php">
<![CDATA[
<?php

define("MAXSIZE", 100);

echo MAXSIZE;
echo constant("MAXSIZE"); // identique à la ligne précédente


interface bar {
    const test = 'foobar!';
}

class foo {
    const test = 'foobar!';
}

$const = 'test';

var_dump(constant('bar::'. $const)); // string(7) "foobar!"
var_dump(constant('foo::'. $const)); // string(7) "foobar!"

?>
]]>
    </programlisting>
   </example>
   <example>
    <title>Utilisation de la fonction <function>constant</function> avec des types enum (à partir de PHP 8.1.0)</title>
    <programlisting role="php">
<![CDATA[
<?php

enum Suit
{
    case Hearts;
    case Diamonds;
    case Clubs;
    case Spades;
}

$case = 'Hearts';

var_dump(constant('Suit::'. $case)); // enum(Suit::Hearts)

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>define</function></member>
    <member><function>defined</function></member>
    <member><function>get_defined_constants</function></member>
    <member>La section sur les <link linkend="language.constants">constantes</link></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
-->