<?xml version="1.0" encoding="utf-8"?>

<refentry xml:id="function.constant" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>constant</refname>

<refpurpose>Возвращает значение константы</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>mixed</type><methodname>constant</methodname>

<methodparam><type>string</type><parameter>name</parameter></methodparam>

</methodsynopsis>

<simpara>

Функция возвращает значение константы, на имя которой

указывает параметр <parameter>name</parameter>.

</simpara>

<simpara>

Функция <function>constant</function> полезна, когда требуется

получить значение константы, но имя константы неизвестно —

когда название константы хранится в переменной или возвращается функцией.

</simpara>

<simpara>

Функция также работает с <link linkend="language.oop5.constants">константами классов</link>

и <link linkend="language.types.enumerations">вариантами перечисления</link>.

</simpara>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>name</parameter></term>

<listitem>

<para>

Имя константы.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Функция возвращает значение константы.

</para>

</refsect1>

<refsect1 role="errors">

&reftitle.errors;

<para>

Функции выбросит исключение <classname>Error</classname>,

если константу с именем, которое содержит параметр, не определили.

До PHP 8.0.0 выдавалась ошибка уровня <constant>E_WARNING</constant>.

</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>constant</function> выбрасывает

исключение <classname>Error</classname>, если константу не определили;

раньше выдавалась ошибка уровня <constant>E_WARNING</constant>

и возвращалось значение &null;.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Пример использования функции <function>constant</function> с константами</title>

<programlisting role="php">

</programlisting>

</example>

<example>

<title>

Пример использования функции <function>constant</function>

с вариантами перечисления (начиная с PHP 8.1.0)

</title>

<programlisting role="php">

</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>Смотрите раздел <link linkend="language.constants">Константы</link></member>

</simplelist>

</para>

</refsect1>

</refentry>