如何使用PHP DOMDocument创建动态XML文件

2010年08月31日 星期二 01:31

当处理基于XML应用程序时，开发者经常需要建立XML编码数据结构。例如，Web中基于用户输入的XML状态模板，服务器请求XML语句，以及基于运行时间参数的客户响应。

尽管XML数据结构的构建比较费时，但如果使用成熟的PHP DOM应用程序接口，一切都会变得简单明了。本文将向你介绍PHP DOM应用程序接口的主要功能，演示如何生成一个正确的XML完整文件并将其保存到磁盘中。

创建文档类型声明

一般而言，XML声明放在文档顶部。在PHP中声明十分简单：只需实例化一个DOM文档类的对象并赋予它一个版本号。查看程序清单A：

程序清单 A

<?php
// create doctype
$dom = new DOMDocument("1.0");

// display document in browser as plain text
// display document in browser as plain text
// for readability purposes
header("Content-Type: text/plain");

// save and display tree
echo $dom->saveXML();
?>

请注意DOM文档对象的saveXML()方法。稍后我再详细介绍这一方法，现在你只需要简单认识到它用于输出XML文档的当前快照到一个文件或浏览器。在本例，为增强可读性，我已经将ASCII码文本直接输出至浏览器。在实际应用中，可将以text/XML头文件发送到浏览器。

如在浏览器中查看输出，你可看到如下代码：

<?xml version="1.0"?>

添加元素和文本节点

XML真正强大的功能是来自其元素与封装的内容。幸运的是，一旦你初始化DOM文档，很多操作变得很简单。此过程包含如下两步骤：

•对想添加的每一元素或文本节点，通过元素名或文本内容调用DOM文档对象的createElement()或createTextNode()方法。这将创建对应于元素或文本节点的新对象。
•通过调用节点的appendChild()方法，并把其传递给上一步中创建的对象，并在XML文档树中将元素或文本节点添加到父节点。
以下范例将清楚地演示这2步骤，请查看程序清单B。

程序清单 B

<?php
// create doctype
$dom = new DOMDocument("1.0");

// display document in browser as plain text
// for readability purposes
header("Content-Type: text/plain");

// create root element
$root = $dom->createElement("toppings");
$dom->appendChild($root);

// create child element
$item = $dom->createElement("item");
$root->appendChild($item);

// create text node
$text = $dom->createTextNode("pepperoni");
$item->appendChild($text);

// save and display tree
echo $dom->saveXML();
?>

这 里，我首先创建一个名字为<toppings>的根元素，并使它归于XML头文件中。然后，我建立名为<item>的元素并使它 归于根元素。最后，我又创建一个值为“pepperoni”的文本节点并使它归于<item>元素。最终结果如下：

<?xml version="1.0"?>
<toppings>
?<item>pepperoni</item>
</toppings>

如果你想添加另外一个topping，只需创建另外一个<item>并添加不同的内容，如程序清单C所示。

程序清单C

<?php
// create doctype
$dom = new DOMDocument("1.0");

// display document in browser as plain text
// for readability purposes
header("Content-Type: text/plain");

// create root element
$root = $dom->createElement("toppings");
$dom->appendChild($root);

// create child element
$item = $dom->createElement("item");
$root->appendChild($item);

// create text node
$text = $dom->createTextNode("pepperoni");
$item->appendChild($text);

// create child element
$item = $dom->createElement("item");
$root->appendChild($item);

// create another text node
$text = $dom->createTextNode("tomato");
$item->appendChild($text);

// save and display tree
echo $dom->saveXML();
?>

以下是执行程序清单C后的输出：

<?xml version="1.0"?>
<toppings>
?<item>pepperoni</item>
?<item>tomato</item>
</toppings>

添加属性

通过使用属性，你也可以添加适合的信息到元素。对于PHP DOM API，添加属性需要两步：首先用DOM文档对象的createAttribute()方法创建拥有此属性名字的节点，然后将文档节点添加到拥有属性值的属性节点。详见程序清单D。

程序清单 D

<?php
// create doctype
$dom = new DOMDocument("1.0");

// display document in browser as plain text
// for readability purposes
header("Content-Type: text/plain");
// create root element
$root = $dom->createElement("toppings");
$dom->appendChild($root);

// create child element
$item = $dom->createElement("item");
$root->appendChild($item);

// create text node
$text = $dom->createTextNode("pepperoni");
$item->appendChild($text);

// create attribute node
$price = $dom->createAttribute("price");
$item->appendChild($price);

// create attribute value node
$priceValue = $dom->createTextNode("4");
$price->appendChild($priceValue);

// save and display tree
echo $dom->saveXML();
?>

输出如下所示：

<?xml version="1.0"?>
<toppings>
?<item price="4">pepperoni</item>
</toppings>

添加CDATA模块和过程向导

虽然不经常使用CDATA模块和过程向导，但是通过调用DOM文档对象的createCDATASection()和createProcessingInstruction()方法， PHP API 也能很好地支持CDATA和过程向导，请见程序清单E。

程序清单 E

<?php
// create doctype
// create doctype
$dom = new DOMDocument("1.0");

// display document in browser as plain text
// for readability purposes
header("Content-Type: text/plain");

// create root element
$root = $dom->createElement("toppings");
$dom->appendChild($root);

// create child element
$item = $dom->createElement("item");
$root->appendChild($item);

// create text node
$text = $dom->createTextNode("pepperoni");
$item->appendChild($text);

// create attribute node
$price = $dom->createAttribute("price");
$item->appendChild($price);

// create attribute value node
$priceValue = $dom->createTextNode("4");
$price->appendChild($priceValue);

// create CDATA section
$cdata = $dom->createCDATASection(" Customer requests that pizza be sliced into 16 square pieces ");
$root->appendChild($cdata);

// create PI
$pi = $dom->createProcessingInstruction("pizza", "bake()");
$root->appendChild($pi);

// save and display tree
echo $dom->saveXML();
?>

输出如下所示：

<?xml version="1.0"?>
<toppings>
<item price="4">pepperoni</item>
<![CDATA[
Customer requests that pizza be sliced into 16 square pieces
]]>
<?pizza bake()?>
</toppings>

保存结果

一旦已经实现你的目标，就可以将结果保存在一个文件或存储于PHP的变量。通过调用带有文件名的save()方法可以将结果保存在文件中，而通过调用saveXML()方法可存储于PHP的变量。请参考以下实例(程序清单F)：

程序清单 F

<?php
// create doctype
$dom = new DOMDocument("1.0");

// create root element
$root = $dom->createElement("toppings");
$dom->appendChild($root);
$dom->formatOutput=true;

// create child element
$item = $dom->createElement("item");
$root->appendChild($item);

// create text node
$text = $dom->createTextNode("pepperoni");
$item->appendChild($text);

// create attribute node
$price = $dom->createAttribute("price");
$item->appendChild($price);

// create attribute value node
$priceValue = $dom->createTextNode("4");
$price->appendChild($priceValue);

// create CDATA section
$cdata = $dom->createCDATASection(" Customer requests that pizza be

sliced into 16 square pieces ");
$root->appendChild($cdata);

// create PI
$pi = $dom->createProcessingInstruction("pizza", "bake()");
$root->appendChild($pi);

// save tree to file
$dom->save("order.xml");

// save tree to string
$order = $dom->save("order.xml");
?>