assert-options.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: ada1d79de35239334b68d0120b011530e31244ff Maintainer: tmn Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.assert-options" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>assert_options</refname>
  <refpurpose>Устанавливает или получает флаги проверки утверждения</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
  &warn.deprecated.function-8-3-0;
 </refsynopsisdiv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>assert_options</methodname>
   <methodparam><type>int</type><parameter>option</parameter></methodparam>
   <methodparam choice="opt"><type>mixed</type><parameter>value</parameter></methodparam>
  </methodsynopsis>
  <para>
   Функция устанавливает опции, которые управляют проверкой утверждений
   функцией <function>assert</function>, или запрашивает текущие значения опций.
  </para>
  <note>
   <simpara>
    Разработчики не рекомендуют пользоваться функцией <function>assert_options</function>
    и взамен предлагают устанавливать директиву файла &php.ini;
    <link linkend="ini.zend.assertions">zend.assertions</link>
    функцией <function>ini_set</function>
    и получать директиву <link linkend="ini.assert.exception">assert.exception</link>
    функцией <function>ini_get</function>.
   </simpara>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>option</parameter></term>
     <listitem>
      <para>
       <table>
        <title>Настройки механизма проверки утверждений</title>
        <tgroup cols="4">
         <thead>
          <row>
           <entry>Настройка</entry>
           <entry>INI-параметр</entry>
           <entry>Значение по умолчанию</entry>
           <entry>Описание</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry>ASSERT_ACTIVE</entry>
           <entry>assert.active</entry>
           <entry>1</entry>
           <entry>
            Включает механизм проверки утверждений
           </entry>
          </row>
          <row>
           <entry>ASSERT_EXCEPTION</entry>
           <entry>assert.exception</entry>
           <entry>1</entry>
           <entry>
            Выбрасывает исключение <classname>AssertionError</classname>
            для каждого неудачного утверждения
           </entry>
          </row>
          <row>
           <entry>ASSERT_WARNING</entry>
           <entry>assert.warning</entry>
           <entry>1</entry>
           <entry>
            Выводит PHP-предупреждение для каждой неудачной проверки
           </entry>
          </row>
          <row>
           <entry>ASSERT_BAIL</entry>
           <entry>assert.bail</entry>
           <entry>0</entry>
           <entry>
            Завершает выполнение, если проверка не удалась
           </entry>
          </row>
          <row>
           <entry>ASSERT_QUIET_EVAL</entry>
           <entry>assert.quiet_eval</entry>
           <entry>0</entry>
           <entry>
            Отключает директиву error_reporting во время проверки утверждения.
            С PHP 8.0.0 опцию удалили
           </entry>
          </row>
          <row>
           <entry>ASSERT_CALLBACK</entry>
           <entry>assert.callback</entry>
           <entry>(&null;)</entry>
           <entry>
            Callback-функция, которая вызывается для утверждений,
            которые не прошли проверку
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       Необязательное новое значение опции.
      </para>
      <para>
       Требование к сигнатуре callback-функции, которую установили
       опцией <constant>ASSERT_CALLBACK</constant>
       или через директиву <link linkend="ini.assert.callback">assert.callback</link>:
       <methodsynopsis role="procedural">
        <type>void</type><methodname>assert_callback</methodname>
        <methodparam><type>string</type><parameter>file</parameter></methodparam>
        <methodparam><type>int</type><parameter>line</parameter></methodparam>
        <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>assertion</parameter></methodparam>
        <methodparam choice="opt"><type>string</type><parameter>description</parameter></methodparam>
       </methodsynopsis>
       <variablelist>
        <varlistentry>
         <term><parameter>file</parameter></term>
         <listitem>
          <simpara>
           Файл, в котором вызвали функцию <function>assert</function>.
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>line</parameter></term>
         <listitem>
          <simpara>
           Строка, в которой вызвали функцию <function>assert</function>.
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>assertion</parameter></term>
         <listitem>
          <simpara>
           До PHP 8.0.0, утверждение, которое передавали в функцию <function>assert</function>,
           но только если утверждение задавали как строку.
           При передаче утверждения в виде логического условия параметр будет пустой строкой.
           Начиная с PHP 8.0.0 значение параметра всегда равно &null;.
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>description</parameter></term>
         <listitem>
          <simpara>
           Описание, которое передали в функцию <function>assert</function>.
          </simpara>
         </listitem>
        </varlistentry>
       </variablelist>
       Передача пустой строки в параметр <parameter>value</parameter>
       сбрасывает callback-функцию проверки неудачных утверждений.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция возвращает исходное значение опции.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Функция выбрасывает исключение <classname>ValueError</classname>,
   если в параметр <parameter>option</parameter> передали недопустимую опцию.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.3.0</entry>
       <entry>
        Функция <function>assert_option</function> устарела.
       </entry>
      </row>
      <row>
       <entry>8.0.0</entry>
       <entry>
        Теперь функция выбрасывает исключение <classname>ValueError</classname>,
        если в параметр <parameter>option</parameter> передали недопустимую опцию;
        раньше возвращалось значение &false;.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример установки опций проверки утверждений функцией <function>assert_options</function></title>
    <programlisting role="php">
<![CDATA[
<?php

// Функция для обработки утверждений,
// которые не прошли проверку
function function assert_failure($file, $line, $assertion, $message)
{
    echo "Проверка утверждения $assertion в файле $file на строке $line не прошла проверку: $message";
}

// Тестовая функция
function test_assert($parameter)
{
    assert(is_bool($parameter));
}

// Настройки проверки
assert_options(ASSERT_ACTIVE,   true);
assert_options(ASSERT_BAIL,     true);
assert_options(ASSERT_WARNING,  false);
assert_options(ASSERT_CALLBACK, 'assert_failure');

// Заведомо ошибочное утверждение
test_assert(1);

// Этот код не выполнится, пока значение опции ASSERT_BAIL
// равно true
echo 'Никогда не выведется';

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

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>assert</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
-->