Files
php-doc-ru/reference/xml/functions/xml-parser-get-option.xml
2024-10-25 09:41:08 +03:00

130 lines
4.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 9acfa18973f304f8f2d531f28dd12b12c2b84f8b Maintainer: tmn Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.xml-parser-get-option" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>xml_parser_get_option</refname>
<refpurpose>Получает значения настройки XML-анализатора</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>int</type><type>bool</type></type><methodname>xml_parser_get_option</methodname>
<methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
<methodparam><type>int</type><parameter>option</parameter></methodparam>
</methodsynopsis>
<para>
Получает значение настройки XML-анализатора.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>parser</parameter></term>
<listitem>
<simpara>
Ссылка на XML-анализатор, настройку которого требуется получить.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>option</parameter></term>
<listitem>
<simpara>
Какую настройку получить. Доступные настройки:
<constant>XML_OPTION_CASE_FOLDING</constant>,
<constant>XML_OPTION_PARSE_HUGE</constant>,
<constant>XML_OPTION_SKIP_TAGSTART</constant>, <constant>XML_OPTION_SKIP_WHITE</constant>
и <constant>XML_OPTION_TARGET_ENCODING</constant>. Они описаны
в документации к функции <function>xml_parser_set_option</function>.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает значение настройки.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Если в параметр <parameter>option</parameter> передано недопустимое значение,
будет выброшено исключение <classname>ValueError</classname>.
</para>
<para>
До PHP 8.0.0 передача недопустимого значение в параметр
<parameter>option</parameter>
генерировало ошибку уровня <constant>E_WARNING</constant>,
что заставляло функцию возвращать логическое &false;.
</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.3.0</entry>
<entry>
Теперь функция возвращает логическое значение для логических настроек.
</entry>
</row>
&xml.changelog.parser-param;
<row>
<entry>8.0.0</entry>
<entry>
Если значение параметра <parameter>option</parameter> недопустимо,
теперь выбрасывается исключение <classname>ValueError</classname>.
</entry>
</row>
<row>
<entry>7.1.24, 7.2.12, 7.3.0</entry>
<entry>
Теперь параметр <parameter>options</parameter> поддерживает значения <constant>XML_OPTION_SKIP_TAGSTART</constant>
и <constant>XML_OPTION_SKIP_WHITE</constant>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</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
-->