utf8_decode

将用 UTF-8 方式编码的 ISO-8859-1 字符串转换成单字节的 ISO-8859-1 字符串。

描述

string utf8_decode ( string $data )

该函数将用 UTF-8 编码的数据解码为 ISO-8859-1 编码。

请参阅 utf8_encode 以查看关于 UTF-8 编码的解释。

utf8_encode

将 ISO-8859-1 编码的字符串转换为 UTF-8 编码

描述

string utf8_encode ( string $data )

该函数将 data 字符串转换为 UTF-8 编码,并返回编码后的字符串。UTF-8 是一种用于将宽字符值转换为字节流的 Unicode 的标准机制。UTF-8 对于纯 ASCII 字符来说是透明的,且是自同步的(也就是说这使得程序能够得知字符从字节流的何处开始),并可被普通字符串比较函数用以比较等操作。PHP 可将 UTF-8 编码为多达四个字节的字符,如:

字节(bytes)位(bits)表 示
170bbbbbbb
211110bbbbb 10bbbbbb
3161110bbbb 10bbbbbb 10bbbbbb
42111110bbb 10bbbbbb 10bbbbbb 10bbbbbb

每个 UTF-8 表示一个能被用以储存字符数据的位。

xml_error_string

获取 XML 解析器的错误字符串

说明

string xml_error_string ( int $code )

根据给定的 code 获得 XML 解析器错误字符串。

参数

code
xml_get_error_code 返回的错误代码。

返回值

返回与 code 描述的错误代码参数对应的文本描述字符串,若没有与之对应的描述,则返回 FALSE

参见

  • xml_get_error_code

xml_get_current_byte_index

获取 XML 解析器的当前字节索引

说明

int xml_get_current_byte_index ( resource $parser )

获取指定的 XML 解析器的当前字节索引(current byte index)。

参数

parser
指向要取得字节索引的 XML 解析器的引用。

返回值

如果 parser 没有指向一个合法的解析器,该函数将返回 FALSE,否则将返回解析器当前在其数据缓冲区中的字节索引(起始值为 0)。

注释

Warning

该函数将返回根据UTF-8编码的文本的字节索引,而不论输入是否是其他的编码。

参见

  • xml_get_current_column_index
  • xml_get_current_line_index

xml_get_current_column_number

获取 XML 解析器的当前列号

说明

int xml_get_current_column_number ( resource $parser )

获得指定 XML 解析器当前的列号。

参数

parser
一个指向要获取列号的 XML 解析器的指针。

返回值

如果 parser 参数没有指向一个合法的解析器,该函数将返回 FALSE,否则将返回指定解析器所在行(由函数 xml_get_current_line_number 给定)的当前列号。

参见

  • xml_get_current_byte_index
  • xml_get_current_line_index

xml_get_current_line_number

获取 XML 解析器的当前行号

说明

int xml_get_current_line_number ( resource $parser )

获取指定 XML 解析器当前的行号。

参数

parser
一个指向要获取当前行号的 XML 解析器的指针。

返回值

如果 parser 参数没有指向一个合法的解析器,该函数将返回 FALSE,否则将返回指定解析器在其缓存中的当前行号。

参见

  • xml_get_current_column_index
  • xml_get_current_byte_index

xml_get_error_code

获取 XML 解析器错误代码

说明

int xml_get_error_code ( resource $parser )

获取 XML 解析器错误代码。

参数

parser
一个指向要返回错误代码的 XML 解析器的指针

返回值

如果 parser 参数没有指向一个合法的解析器,该函数将返回 FALSE,否则将返回错误代码列表中的一个错误代码。

参见

  • xml_error_string

xml_parse_into_struct

将 XML 数据解析到数组中

说明

int xml_parse_into_struct ( resource $parser , string $data , array &$values [, array &$index ] )

该函数将 XML 文件解析到两个对应的数组中,index 参数含有指向 values 数组中对应值的指针。最后两个数组参数可由指针传递给函数。

Note:

xml_parse_into_struct 失败返回 0,成功返回 1。这和 FALSETRUE 不同,使用例如 === 的运算符时要注意。

以下范例显示了由该函数生成的数组的内部结构。我们简单地将一个 note 嵌入到一个 para 标记中,解析后我们可以打印出生成的数组的结构:

示例 #1 xml_parse_into_struct 示例

<?php
$simple = "<para><note>simple note</note></para>";
$p = xml_parser_create();
xml_parse_into_struct($p, $simple, $vals, $index);
xml_parser_free($p);
echo "Index array\n";
print_r($index);
echo "\nVals array\n";
print_r($vals);
?>

运行以上代码,我们得到的输出将是:

Index array
Array
(
    [PARA] => Array
        (
            [0] => 0
            [1] => 2
        )

    [NOTE] => Array
        (
            [0] => 1
        )

)

Vals array
Array
(
    [0] => Array
        (
            [tag] => PARA
            [type] => open
            [level] => 1
        )

    [1] => Array
        (
            [tag] => NOTE
            [type] => complete
            [level] => 2
            [value] => simple note
        )

    [2] => Array
        (
            [tag] => PARA
            [type] => close
            [level] => 1
        )

)

如果您的 XML 文档很复杂,基于该文档的事件处理(Event-driven)解析(基于 expat 扩展库)也会对应的变得复杂。该函数生成的并非 DOM 风格的对象,而是横向的树状结构。因此,我们能够方便的建立表达 XML 文件数据的对象。我们假设以下 XML 文件表示一个关于氨基酸信息的小型数据库:

示例 #2 moldb.xml - 分子信息的小型数据库

<?xml version="1.0"?>
<moldb>

    <molecule>
        <name>Alanine</name>
        <symbol>ala</symbol>
        <code>A</code>
        <type>hydrophobic</type>
    </molecule>

    <molecule>
        <name>Lysine</name>
        <symbol>lys</symbol>
        <code>K</code>
        <type>charged</type>
    </molecule>

</moldb>

以下是解析该文档并生成相应对象的代码:

示例 #3 parsemoldb.php - 将 moldb.xml 解析到分子(molecular)对象的数组中

<?php

class AminoAcid {
    var $name;  // aa 姓名
    var $symbol;    // 三字母符号
    var $code;  // 单字母代码
    var $type;  // hydrophobic, charged 或 neutral

    function AminoAcid ($aa)
    {
        foreach ($aa as $k=>$v)
            $this->$k = $aa[$k];
    }
}

function readDatabase($filename)
{
    // 读取 aminoacids 的 XML 数据
    $data = implode("",file($filename));
    $parser = xml_parser_create();
    xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
    xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 1);
    xml_parse_into_struct($parser, $data, $values, $tags);
    xml_parser_free($parser);

    // 遍历 XML 结构
    foreach ($tags as $key=>$val) {
        if ($key == "molecule") {
            $molranges = $val;
            // each contiguous pair of array entries are the
            // lower and upper range for each molecule definition
            for ($i=0; $i < count($molranges); $i+=2) {
                $offset = $molranges[$i] + 1;
                $len = $molranges[$i + 1] - $offset;
                $tdb[] = parseMol(array_slice($values, $offset, $len));
            }
        } else {
            continue;
        }
    }
    return $tdb;
}

function parseMol($mvalues)
{
    for ($i=0; $i < count($mvalues); $i++) {
        $mol[$mvalues[$i]["tag"]] = $mvalues[$i]["value"];
    }
    return new AminoAcid($mol);
}

$db = readDatabase("moldb.xml");
echo "** Database of AminoAcid objects:\n";
print_r($db);

?>

在执行完 parsemoldb.php 后,变量 $db 将包含有一个由 AminoAcid 对象组成的数组,该脚本的输出如下:

** Database of AminoAcid objects:
Array
(
    [0] => aminoacid Object
        (
            [name] => Alanine
            [symbol] => ala
            [code] => A
            [type] => hydrophobic
        )

    [1] => aminoacid Object
        (
            [name] => Lysine
            [symbol] => lys
            [code] => K
            [type] => charged
        )

)

xml_parse

开始解析一个 XML 文档

说明

int xml_parse ( resource $parser , string $data [, bool $is_final = false ] )

xml_parse 解析 XML 文档。已配置事件的处理器根据需要被无限次调用。

参数

parser
一个指向将要使用的 XML 解析器的指针

data
需要解析的数据集。您可以多次对新的数据调用 xml_parse 函数来分段解析一个文档;只要在解析最后一段数据时将 is_final 参数设置为 TRUE

is_final
如果被设置为 TRUE,则 data 为当前解析中最后一段数据。

返回值

成功时返回1,失败时返回0

若解析失败,可以使用如下函数获取错误信息: xml_get_error_code, xml_error_string, xml_get_current_line_number, xml_get_current_column_numberxml_get_current_byte_index

Note:

is_final 参数设置为 TRUE,项目的错误将会报告在数据的末尾。

xml_parser_create_ns

生成一个支持命名空间的 XML 解析器

描述

resource xml_parser_create_ns ([ string $encoding [, string $sep ]] )

函数 xml_parser_create_ns 建立一个新的支持 XML 命名空间的解析器并返回可被其它 XML 函数使用的资源句柄。

通过有命名空间支持的解析器,传递给各种各样句柄函数的标签参数将由命名空间和标签名组成。命名空间和标签名的分隔符由 seperator 参数制定的字符串决定,其默认值为“:”。

可选参数 encoding 在 PHP 4 中用来指定要被解析的 XML 输入的字符编码方式。PHP 5 开始,自动侦测输入的 XML 的编码,因此 encoding 参数仅用来指定解析后输出数据的编码。在 PHP 4 总,默认输出的编码与输入数据的编码是相同的。如果传递了空字符串,解析器会尝试搜索头 3 或 4 个字节以确定文档的编码。在 PHP 5.0.0 和 5.0.1 总,默认输出的字符编码是 ISO-8859-1,而 PHP 5.0.2 及以上版本是 UTF-8。解析器支持的编码有 ISO-8859-1, UTF-8US-ASCII

请参阅函数 xml_parser_createxml_parser_free

xml_parser_create

建立一个 XML 解析器

描述

resource xml_parser_create ([ string $encoding ] )

函数 xml_parser_create 建立一个新的 XML 解析器并返回可被其它 XML 函数使用的资源句柄。

可选参数 encoding 在 PHP 4 中用来指定要被解析的 XML 输入的字符编码方式。PHP 5 开始,自动侦测输入的 XML 的编码,因此 encoding 参数仅用来指定解析后输出数据的编码。在 PHP 4 总,默认输出的编码与输入数据的编码是相同的。如果传递了空字符串,解析器会尝试搜索头 3 或 4 个字节以确定文档的编码。在 PHP 5.0.0 和 5.0.1 总,默认输出的字符编码是 ISO-8859-1,而 PHP 5.0.2 及以上版本是 UTF-8。解析器支持的编码有 ISO-8859-1, UTF-8US-ASCII

请参阅函数 xml_parser_create_nsxml_parser_free

xml_parser_free

释放指定的 XML 解析器

描述

bool xml_parser_free ( resource $parser )

parser
指向要释放的 XML 解析器的指针。

如果 parser 参数没有指向一个合法的解析器,该函数将返回 FALSE,否则将释放指定的解析器并返回 TRUE

xml_parser_get_option

从 XML 解析器获取选项设置信息

描述

mixed xml_parser_get_option ( resource $parser , int $option )

parser
指向要获取设置信息的 XML 解析器的指针。

option
要获取的设置选项名称。可以使用 XML_OPTION_CASE_FOLDINGXML_OPTION_TARGET_ENCODING 常量。其说明见 xml_parser_set_option

如果 parser 参数没有指向一个合法的解析器或者 option 参数无效,该函数将返回 FALSE(同时产生 E_WARNING 警告)。否则将返回指定设置选项的值。

xml_parser_set_option

为指定 XML 解析进行选项设置

说明

bool xml_parser_set_option ( resource $parser , int $option , mixed $value )

parser
指向要设置选项信息的 XML 解析器的指针。

option
要设置的选项名称。请参考下文。

value
要给选项设置的新值。

如果 parser 参数没有指向一个合法的解析器或者指定的选项无法设置,该函数将返回 FALSE,否则将会把选项设置为指定的值并返回 TRUE

可被设置的选项如下:

选项常量数据类型描述
XML_OPTION_CASE_FOLDINGinteger控制在该 XML 解析器中 大小写折叠(case-folding) 是否有效。其默认值为有效。
XML_OPTION_SKIP_TAGSTARTinteger指明在一个标记名前应略过几个字符。
XML_OPTION_SKIP_WHITEinteger是否略过由白空字符组成的值。
XML_OPTION_TARGET_ENCODINGstring设置该 XML 解析器所使用的目标编码(target encoding)方式。其默认值和由 xml_parser_create 函数设置的源编码(source encoding)方式相同。支持的目标编码方式有 ISO-8859-1US-ASCIIUTF-8

xml_set_character_data_handler

建立字符数据处理器

说明

bool xml_set_character_data_handler ( resource $parser , callable $handler )

parser 变量指向的 XML 解析器指定字符数据处理函数。

参数

parser
XML 解析器的引用,用于建立字符数据处理器。

handler
handler 为表示一个函数名称的字符串,该函数必须在为 parser 指定的解析器调用 xml_parse 函数时已存在。

handler 参数命名的函数名必须接受两个参数:

handler ( resource $parser , string $data )

parser
第一个参数 parser 为指向要调用处理器的 XML 解析器的指针。

data
第二个参数 data 为包含有字符数据的字符串。

Character data handler is called for every piece of a text in the XML document. It can be called multiple times inside each fragment (e.g. for non-ASCII strings).

如果处理器函数名被设置为空字符串或者 FALSE,则该有问题的处理器将被屏蔽。

Note: class="simpara">除了函数名,含有对象引用的数组和方法名也可以作为参数。

返回值

成功时返回 TRUE, 或者在失败时返回 FALSE

xml_set_default_handler

建立默认处理器

说明

bool xml_set_default_handler ( resource $parser , callable $handler )

parser 指定的 XML 处理器建立默认处理函数。

参数

parser
XML 解析器的引用,用于建立默认处理器函数。

handler
handler 为表示一个函数名称的字符串,该函数必须在为 parser 指定的解析器调用 xml_parse 函数时已存在。

handler 参数命名的函数名必须接受两个参数:

handler ( resource $parser , string $data )

parser
第一个参数 parser 为指向要调用处理器的 XML 解析器的指针。

data
第二个参数 data 为包含有字符数据的字符串。其内容可以是 XML 声明、文档类型声明、实体名或者其它没有已存在处理器的地数据。

如果处理器函数名被设置为空字符串或者 FALSE,则该有问题的处理器将被屏蔽。

Note: class="simpara">除了函数名,含有对象引用的数组和方法名也可以作为参数。

返回值

成功时返回 TRUE, 或者在失败时返回 FALSE

xml_set_element_handler

建立起始和终止元素处理器

说明

bool xml_set_element_handler ( resource $parser , callable $start_element_handler , callable $end_element_handler )

parser 参数指定的 XML 解析器建立元素处理器函数。参数 start_element_handlerend_element_handler 为表示函数名称的字符串,这些函数必须在为 parser 指定的解析器调用 xml_parse 函数时已存在。

参数

parser
XML 解析器的引用,用于建立起始和终止元素处理器。

start_element_handler
start_element_handler 参数命名的函数名必须接受三个参数:

start_element_handler ( resource $parser , string $name , array $attribs )

parser
第一个参数 parser 为指向要调用处理器的 XML 解析器的指针。

name
第二个参数 name 为该处理器为之被调用的元素名。如果大小写折叠(case-folding)对该解析器有效,元素名将用大写字母表示。

attribs
第三个参数 attribs 为一个包含有对应元素的属性的数组(如果该元素有属性)。数组元素的下标为属性名,元素的值即为属性的值。属性名将以和元素名同样的标准进行大小写折叠(case-folded),其值进行大小写折叠。 属性的原始顺序将会被参数保留,用 each 函数遍历 attribs 时,该数组下表的顺序和属性的顺序相同。

Note: class="simpara">除了函数名,含有对象引用的数组和方法名也可以作为参数。

end_element_handler
end_element_handler 参数命名的函数名必须接受两个参数:

end_element_handler ( resource $parser , string $name )

parser
第一个参数 parser 为指向要调用处理器的 XML 解析器的指针。

name
第二个参数 name 为该处理器为之被调用的元素名。如果大小写折叠(case-folding)对该解析器有效,元素名将用大写字母表示。

如果处理器函数名被设置为空字符串或者 FALSE,则该有问题的处理器将被屏蔽。

返回值

成功时返回 TRUE, 或者在失败时返回 FALSE

xml_set_end_namespace_decl_handler

建立终止命名空间声明处理器

说明

bool xml_set_end_namespace_decl_handler ( resource $parser , callable $handler )

Set a handler to be called when leaving the scope of a namespace declaration. This will be called, for each namespace declaration, after the handler for the end tag of the element in which the namespace was declared.

参数

parser
A reference to the XML parser.

handler
handler is a string containing the name of a function that must exist when xml_parse is called for parser.

The function named by handler must accept two parameters, and should return an integer value. If the value returned from the handler is FALSE (which it will be if no value is returned), the XML parser will stop parsing and xml_get_error_code will return XML_ERROR_EXTERNAL_ENTITY_HANDLING.

handler ( resource $parser , string $prefix )

parser
The first parameter, parser, is a reference to the XML parser calling the handler.

prefix
The prefix is a string used to reference the namespace within an XML object.

If a handler function is set to an empty string, or FALSE, the handler in question is disabled.

Note: class="simpara">除了函数名,含有对象引用的数组和方法名也可以作为参数。

返回值

成功时返回 TRUE, 或者在失败时返回 FALSE

注释

Note:

This event is not supported under LibXML.

参见

  • xml_set_start_namespace_decl_handler

xml_set_external_entity_ref_handler

建立外部实体指向处理器

说明

bool xml_set_external_entity_ref_handler ( resource $parser , callable $handler )

parser 参数指定的 XML 解析器建立外部实体指向处理器函数。

参数

parser
XML 解析器的引用,用于建立外部实体指向处理器。

handler
参数 handler 为表示函数名称的字符串,函数必须在为 parser 指定的解析器调用 xml_parse 函数时已存在。

handler 参数命名的函数名必须接受五个参数,并应该返回一个整型值。如果处理器的返回值为 FALSE(这也是函数没有确定返回值时的返回值),XML 解析器将停止解析, xml_get_error_code 函数将返回 XML_ERROR_EXTERNAL_ENTITY_HANDLING

handler ( resource $parser , string $open_entity_names , string $base , string $system_id , string $public_id )

parser
第一个参数 parser 为指向要调用处理器的 XML 解析器的指针。

open_entity_names
第二个参数 open_entity_names 是为该实体的解析开放的实体名列表(包括被指向的实体名),这些实体名由空格隔开。

base
这个参数是解析外部实体的系统标识符(system_id)的基础。当前该参数通常都被设置为空字符串。

system_id
第四个参数 system_id 是在实体定义声明中指定的系统标识符。

public_id
第五个参数 public_id 是在实体定义声明中指定的公共标识符,如果未指定任何标识符,则该字符串为空。公共标识符中的空格将按照 XML 的要求被正常化。

如果处理器函数名被设置为空字符串或者 FALSE,则该有问题的处理器将被屏蔽。

Note: class="simpara">除了函数名,含有对象引用的数组和方法名也可以作为参数。

返回值

成功时返回 TRUE, 或者在失败时返回 FALSE

xml_set_notation_decl_handler

建立注释声明处理器

说明

bool xml_set_notation_decl_handler ( resource $parser , callable $handler )

parser 参数指定的 XML 解析器建立注释声明处理器函数。

注释声明是文档 DTD 的一部分,并有如下格式:

<!NOTATION <parameter>name</parameter>
{<parameter>system_id</parameter> | <parameter>public_id</parameter>}?>

。请参考 » XML 1.0 参考的第 4.7 节以了解注释声明的定义。

参数

parser
XML 解析器的引用,用于设置声明处理器函数。

handler
handler 为表示函数名称的字符串,函数必须在为 parser 指定的解析器调用 xml_parse 函数时已存在。

handler 参数命名的函数名必须接受五个参数:

handler ( resource $parser , string $notation_name , string $base , string $system_id , string $public_id )

parser
第一个参数 parser 为指向要调用处理器的 XML 解析器的指针。

notation_name
该参数为以上注释格式定义中的 name 参数。

base
这个参数是解析注释声明的系统标识符(system_id)的基础。当前该参数通常都被设置为空字符串。

system_id
外部注释声明的系统标识符。

public_id
外部注释声明的公共标识符。

如果处理器函数名被设置为空字符串或者 FALSE,则该有问题的处理器将被屏蔽。

Note: class="simpara">除了函数名,含有对象引用的数组和方法名也可以作为参数。

返回值

成功时返回 TRUE, 或者在失败时返回 FALSE

xml_set_object

在对象中使用 XML 解析器

描述

pool xml_set_object ( resource $parser , object &$object )

该函数使得 parser 指定的解析器可以被用在 object 对象中。所有的回叫函数(callback function)都可以由 xml_set_element_handler 等函数来设置,它们被假定为 object 对象的方法。

示例 #1 xml_set_object 示例

<?php
class xml  {
    var $parser;

    function xml() 
    {
        $this->parser = xml_parser_create();

        xml_set_object($this->parser, $this);
        xml_set_element_handler($this->parser, "tag_open", "tag_close");
        xml_set_character_data_handler($this->parser, "cdata");
    }

     function parse($data) 
    {
        xml_parse($this->parser, $data);
    }

    function tag_open($parser, $tag, $attributes) 
    {
        var_dump($parser, $tag, $attributes); 
    }

    function cdata($parser, $cdata) 
    {
        var_dump($parser, $cdata);
    }

    function tag_close($parser, $tag) 
    {
        var_dump($parser, $tag);
    }

} // end of class xml

$xml_parser = new xml();
$xml_parser->parse("<A ID='hallo'>PHP</A>");
?>

xml_set_processing_instruction_handler

建立处理指令(PI)处理器

说明

bool xml_set_processing_instruction_handler ( resource $parser , callable $handler )

parser 参数指定的 XML 解析器建立处理指令(PI)处理器函数。

处理指令有如下格式:

<?

target data

?>

您可以将 PHP 代码放置在类似的标识符中,但要注意一个限制:在 XML 处理指令(PI)中,PI 的终止符(?>)不能被引号引用,因此该字符序列不应该在您用 PI 嵌入到 XML 文档中的 PHP 代码中出现。否则,剩下的 PHP 代码,包括“真正”的 PI 终止符将被当作字符数据处理。

参数

parser
XML 解析器的引用,用于建立处理指令(PI)处理器。

handler
参数 handler 为表示函数名称的字符串,函数必须在为 parser 指定的解析器调用 xml_parse 函数时已存在。

handler 参数命名的函数名必须接受三个参数:

handler ( resource $parser , string $target , string $data )

parser
第一个参数 parser 为指向要调用处理器的 XML 解析器的指针。

target
第二个参数 target 为 PI 对象(PI target)。

data
第三个参数 data 包含了 PI 数据。

如果处理器函数名被设置为空字符串或者 FALSE,则该有问题的处理器将被屏蔽。

Note: class="simpara">除了函数名,含有对象引用的数组和方法名也可以作为参数。

返回值

成功时返回 TRUE, 或者在失败时返回 FALSE

xml_set_start_namespace_decl_handler

建立起始命名空间声明处理器

说明

bool xml_set_start_namespace_decl_handler ( resource $parser , callable $handler )

Set a handler to be called when a namespace is declared. Namespace declarations occur inside start tags. But the namespace declaration start handler is called before the start tag handler for each namespace declared in that start tag.

参数

parser
A reference to the XML parser.

handler
handler is a string containing the name of a function that must exist when xml_parse is called for parser.

The function named by handler must accept three parameters, and should return an integer value. If the value returned from the handler is FALSE (which it will be if no value is returned), the XML parser will stop parsing and xml_get_error_code will return XML_ERROR_EXTERNAL_ENTITY_HANDLING.

handler ( resource $parser , string $prefix , string $uri )

parser
The first parameter, parser, is a reference to the XML parser calling the handler.

prefix
The prefix is a string used to reference the namespace within an XML object.

uri
Uniform Resource Identifier (URI) of namespace.

If a handler function is set to an empty string, or FALSE, the handler in question is disabled.

Note: class="simpara">除了函数名,含有对象引用的数组和方法名也可以作为参数。

返回值

成功时返回 TRUE, 或者在失败时返回 FALSE

参见

  • xml_set_end_namespace_decl_handler

xml_set_unparsed_entity_decl_handler

建立未解析实体定义声明处理器

说明

bool xml_set_unparsed_entity_decl_handler ( resource $parser , callable $handler )

parser 参数指定的 XML 解析器建立未解析实体定义声明处理器函数。

当 XML 解析器遇到如下含有 NDATA 声明的外部实体定义声明时,该 handler 处理器将被调用:

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

请参阅 » XML 1.0 参考的第 4.2.2 节以获取有关已声明外部实体注释定义的信息。

参数

parser
XML 解析器的引用,用于建立未解析实体定义声明处理器。

handler
参数handler 为表示函数名称的字符串,这个函数必须在为 parser 指定的解析器调用 xml_parse 函数时已存在。

handler 参数命名的函数名必须接受六个参数:

handler ( resource $parser , string $entity_name , string $base , string $system_id , string $public_id , string $notation_name )

parser
第一个参数 parser 为指向要调用处理器的 XML 解析器的指针。

entity_name
将被定义的实体名。

base
这个参数是解析外部实体的系统标识符(system_id)的基础。当前该参数通常都被设置为空字符串。

system_id
外部实体的系统标识符。

public_id
外部实体的公共标识符。

notation_name
该实体的注释名(请参阅 xml_set_notation_decl_handler)。

如果处理器函数名被设置为空字符串或者 FALSE,则该有问题的处理器将被屏蔽。

Note: class="simpara">除了函数名,含有对象引用的数组和方法名也可以作为参数。

返回值

成功时返回 TRUE, 或者在失败时返回 FALSE

目录