Установка значения настройки XML-анализатора

Описание

xml_parser_set_option(XMLParser $parser, int $option, string|int|bool $value): bool

Устанавливает значение настройки XML-анализатора.

Список параметров

parser

Ссылка на XML-анализатор.

option

Какую настройку требуется установить. Смотрите ниже.

Доступны следующие настройки:

**Настройки XML-анализатора**
Константа	Тип данных	Описание
`XML_OPTION_CASE_FOLDING`	bool	Требуется ли включить case-folding для этого анализатора. Включено по умолчанию.
`XML_OPTION_SKIP_TAGSTART`	integer	Задаёт количество символов с начала имени тега, которые следует пропустить.
`XML_OPTION_SKIP_WHITE`	bool	Требуется ли пропускать значения, состоящие из пробелов.
`XML_OPTION_TARGET_ENCODING`	string	Устанавливает кодировку, которая будет использоваться XML анализатором. По умолчанию используется кодировка заданная при вызове функции xml_parser_create(). Поддерживаются кодировки `ISO-8859-1`, `US-ASCII` и `UTF-8`.

value

Новое значение настройки.

Возвращаемые значения

Возвращает true в случае успешного выполнения или false в случае возникновения ошибки.

Ошибки

Если в параметр option передано недопустимое значение, выбрасывается исключение ValueError.

До PHP 8.0.0 функция возвращала значение false, когда отправка в параметр option недопустимого значения приводила к ошибке уровня E_WARNING, что и заставляло функцию возвращать логическое значение false.

Список изменений

Версия	Описание
8.3.0	Теперь параметр `value` также принимает логические значения. Настройки `XML_OPTION_CASE_FOLDING` и `XML_OPTION_SKIP_WHITE` теперь логические.
8.0.0	Параметр `parser` ожидает экземпляр класса XMLParser; раньше параметр ждал корректный `xml`-ресурс (resource).
8.0.0	Теперь выбрасывается исключение ValueError, если значение параметра `option` недопустимо.