PHP Conference Japan 2024

xml_set_external_entity_ref_handler

(PHP 4, PHP 5, PHP 7, PHP 8)

xml_set_external_entity_ref_handler设置外部实体引用处理程序

描述

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

为 XML 解析器 parser 设置外部实体引用处理程序函数。

参数

parser

XML 解析器。

handler

如果传递了null,则处理程序将重置为其默认状态。

警告

空字符串也会重置处理程序,但是从 PHP 8.4.0 开始已弃用。

如果 handler 是一个 callable,则该可调用对象将被设置为处理程序。

如果 handler 是一个 string,它可以是使用 xml_set_object() 设置的对象的方法名称。

警告

从 PHP 8.4.0 开始已弃用。

警告

从 PHP 8.4.0 开始,在设置处理程序时会检查可调用对象是否有效,而不是在调用它时检查。这意味着必须在将方法字符串设置为回调之前调用 xml_set_object()。但是,由于此行为从 PHP 8.4.0 开始也已弃用,因此建议改用适当的 callable 来表示方法。

处理程序的签名必须为

handler(
    XMLParser $parser,
    string $open_entity_names,
    string|false $base,
    string $system_id,
    string|false $public_id
): bool
parser
调用处理程序的 XML 解析器。
open_entity_names
对该实体进行解析时打开的实体名称的空格分隔列表(包括引用的实体的名称)。
base
这是解析外部实体的系统标识符 (system_id) 的基础。
system_id
实体声明中指定的系统标识符。
public_id
实体声明中指定的公共标识符,如果没有指定则为空字符串;公共标识符中的空格将根据 XML 规范的要求进行规范化。

如果处理了实体,则处理程序应返回true,否则返回false。当返回false时,XML 解析器将停止解析,并且 xml_get_error_code() 将返回XML_ERROR_EXTERNAL_ENTITY_HANDLING

返回值

始终返回true

变更日志

版本 描述
8.4.0 将非 callable string 传递给 handler 现在已弃用,请对方法使用适当的可调用对象,或使用null重置处理程序。
8.4.0 现在在设置处理程序时检查 handler 作为 callable 的有效性,而不是在调用它时检查。
8.0.0 parser 现在期望一个 XMLParser 实例;以前,期望一个有效的 xml resource
7.3.0 如果扩展已针对 libxml 构建,则不再忽略 handler 的返回值。以前,返回值被忽略,并且解析从未停止。
添加注释

用户贡献的注释

此页面没有用户贡献的注释。
To Top