Описание

xml_set_unparsed_entity_decl_handler(XMLParser $parser, callable|string|null $handler): true

Задаёт функцию обработчик неразобранных объявлений сущностей для XML-анализатора parser.

Обработчик handler будет вызван, если XML-анализатор обнаружит NDATA-объявление внешней сущности вида:

<!ENTITY <parameter>name</parameter> {<parameter>publicId</parameter> | <parameter>systemId</parameter>}
        NDATA <parameter>notationName</parameter>

Смотрите » раздел 4.2.2 XML 1.0 спецификации, чтобы получить точное определение обозначений внешних сущностей.

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

parser

XML-парсер.

handler

При передаче значения null обработчик возвращается в состояние по умолчанию.

Внимание

Пустая строка тоже сбросит обработчик, однако начиная с PHP 8.4.0 передача в параметр пустой строки устарела.

Функция установит как обработчик функцию, на которую указывает callable-выражение, если в параметр handler передали значение, которое вызывается как функция.

Параметр handler принимает строку (string) с названием метода объекта, который установили функцией xml_set_object().

Внимание

Начиная с PHP 8.4.0 передача в параметр строки с названием метода устарела.

Внимание

Начиная с PHP 8.4.0 корректность callable-выражения проверяется при установке, а не при вызове обработчика. Поэтому вызвать функцию xml_set_object() потребуется до установки строки с названием метода, который вызывается как callback-функция. Однако, поскольку такое поведение тоже устарело с PHP 8.4.0, вместо передачи строки с названием метода рекомендуют указывать метод в правильном callable-выражении.

Сигнатура обработчика должна быть:

handler(
    XMLParser $parser,
    string $entity_name,
    string|false $base,
    string $system_id,
    string|false $public_id,
    string|false $notation_name
): void

parser: XML-парсер, которым вызывается обработчик.
entity_name: Имя сущности, которой требуется дать определение.
base: Это основа для разрешения системного идентификатора (system_id) внешней сущности.
system_id: Системный идентификатор внешней сущности.
public_id: Общедоступный идентификатор внешней сущности.
notation_name: Имя обозначения этой сущности (смотрите xml_set_notation_decl_handler()).

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

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

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

Версия	Описание
8.4.0	Передача в параметр `handler` строки (string), которую невозможно вызывать как callable-выражение, устарела; теперь рекомендуют передавать в параметр правильное callable-выражение для установки метода или `null` для сброса обработчика.
8.4.0	Корректность обработчика `handler` как callable-выражения теперь проверяется при установке обработчика, а не при вызове.
8.0.0	Параметр `parser` ожидает экземпляр класса XMLParser; раньше параметр ждал корректный `xml`-ресурс (resource).