xml_parse_into_struct

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

xml_parse_into_struct — 將 XML 數(shù)據(jù)解析到數(shù)組中

說明

xml_parse_into_struct(
    resource $parser,
    string $data,
    array &$values,
    array &$index = ?
): int

該函數(shù)將 XML 文件解析到兩個(gè)對應(yīng)的數(shù)組中，index 參數(shù)含有指向 values 數(shù)組中對應(yīng)值的指針。最后兩個(gè)數(shù)組參數(shù)可由指針傳遞給函數(shù)。

注意:

xml_parse_into_struct() 失敗返回 0，成功返回 1。這和 false 與 true 不同，使用例如 === 的運(yùn)算符時(shí)要注意。

以下范例顯示了由該函數(shù)生成的數(shù)組的內(nèi)部結(jié)構(gòu)。我們簡單地將一個(gè) note 嵌入到一個(gè) para 標(biāo)記中，解析后我們可以打印出生成的數(shù)組的結(jié)構(gòu)：

示例 #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);
?>

運(yùn)行以上代碼，我們得到的輸出將是： 

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 文檔很復(fù)雜，基于該文檔的事件處理（Event-driven）解析（基于 expat 擴(kuò)展庫）也會(huì)對應(yīng)的變得復(fù)雜。該函數(shù)生成的并非 DOM 風(fēng)格的對象，而是橫向的樹狀結(jié)構(gòu)。因此，我們能夠方便的建立表達(dá) XML 文件數(shù)據(jù)的對象。我們假設(shè)以下 XML 文件表示一個(gè)關(guān)于氨基酸信息的小型數(shù)據(jù)庫：

示例 #2 moldb.xml - 分子信息的小型數(shù)據(jù)庫

<?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>
以下是解析該文檔并生成相應(yīng)對象的代碼：

示例 #3 parsemoldb.php - 將 moldb.xml 解析到分子（molecular）對象的數(shù)組中

<?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 數(shù)據(jù)
    $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 結(jié)構(gòu)
    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);

?>
在執(zhí)行完 parsemoldb.php 后，變量 $db 將包含有一個(gè)由 AminoAcid 對象組成的數(shù)組，該腳本的輸出如下： 
** 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
        )

)