PHP DOMDocument：高效生成XML的节点操作技巧与最佳实践

<?php
$dom  = new DOMDocument();
$root = $dom->createElement('Root');

// 传统方式：为每个子节点单独调用 appendChild()
$product = $dom->createElement('product');
$root->appendChild($product);

$quantity = $dom->createElement('quantity');
$root->appendChild($quantity);

$measureUnit = $dom->createElement('measureUnit');
$root->appendChild($measureUnit);

// ... 如果有更多子节点，会继续重复调用

$dom->appendChild($root);
// $dom->save('/some/dir/some-name.xml'); // 保存XML文件
?>

<?php
$document = new DOMDocument('1.0', 'UTF-8');
$document->formatOutput = true; // 格式化输出，便于阅读

// 1. 嵌套 createElement 到 appendChild
// appendChild 返回被追加的节点，可以将其赋值给变量以供后续操作
$document->appendChild(
    $root = $document->createElement('root')
);

// 2. 链式操作：直接对 appendChild 返回的节点赋值 textContent
// 减少了创建临时变量的步骤
$root
  ->appendChild($document->createElement('product'))
  ->textContent = 'Example Product';

// 3. 混合使用：创建节点并追加，同时赋值
// 这种方式依然可以保持代码简洁，尤其当节点需要进一步配置属性时
$measureUnitNode = $document->createElement('measureUnit');
$measureUnitNode->textContent = 'cm';
$root->appendChild($measureUnitNode);

$quantityNode = $document->createElement('quantity');
$quantityNode->textContent = '42';
$root->appendChild($quantityNode);

echo $document->saveXML();
?>

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <product>Example Product</product>
  <measureUnit>cm</measureUnit>
  <quantity>42</quantity>
</root>

<?php
// 此功能要求 PHP 8.0 或更高版本
if (version_compare(PHP_VERSION, '8.0.0', '<')) {
    die("DOMNode::append() 方法需要 PHP 8.0 或更高版本。\n");
}

$document = new DOMDocument('1.0', 'UTF-8');
$document->formatOutput = true;

$document->appendChild(
    $root = $document->createElement('root')
);

// 使用 append() 方法一次性添加多个节点
// append() 接受可变数量的参数，可以是 DOMNode 对象或字符串
$root->append(
    $product = $document->createElement('product'),
    $measureUnit = $document->createElement('measureUnit'),
    $quantity = $document->createElement('quantity')
);

// 为新添加的节点设置内容
$product->textContent = 'Example Product';
$measureUnit->textContent = 'cm';
$quantity->textContent = '42';

// append() 也可以直接追加字符串作为文本节点
$root->append(
    $document->createElement('description'), // 创建一个空的 description 节点
    'This is a test description.' // 追加文本内容，将作为前一个节点的兄弟节点
);

echo $document->saveXML();
?>

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <product>Example Product</product>
  <measureUnit>cm</measureUnit>
  <quantity>42</quantity>
  <description/>This is a test description.
</root>

<?php
interface XMLAppendable {
    /**
     * 将当前对象表示的XML结构追加到指定的父DOM元素。
     * @param DOMElement $parent 要追加到的父元素
     */
    public function appendTo(DOMElement $parent): void;
}
?>

<?php
class YourXMLPart implements XMLAppendable {
    private string $_product;
    private string $_unit;
    private int $_quantity;

    public function __construct(string $product, string $unit, int $quantity) {
        $this->_product = $product;
        $this->_unit = $unit;
        $this->_quantity = $quantity;
    }

    public function appendTo(DOMElement $parent): void {
        // 获取父节点所属的 DOMDocument 实例，以便创建新节点
        $document = $parent->ownerDocument; 

        // 使用链式操作创建并追加子节点及其内容
        $parent
            ->appendChild($document->createElement('product'))
            ->textContent = $this->_product;
        $parent
            ->appendChild($document->createElement('measureUnit'))
            ->textContent = $this->_unit;
        $parent
            ->appendChild($document->createElement('quantity'))
            ->textContent = (string)$this->_quantity; // 确保数值被转换为字符串
    }
}
?>

<?php
// 确保 XMLAppendable 接口和 YourXMLPart 类已定义并可用

$document = new DOMDocument('1.0', 'UTF-8');
$document->formatOutput = true;

$document->appendChild(
    $root = $document->createElement('root')
);

// 创建并使用 XML 部分实例
$part1 = new YourXMLPart('Example Item A', 'kg', 10);
$part1->appendTo($root);

$part2 = new YourXMLPart('Example Item B', 'pcs', 5);
$part2->appendTo($root);

echo $document->saveXML();
?>

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <product>Example Item A</product>
  <measureUnit>kg</measureUnit>
  <quantity>10</quantity>
  <product>Example Item B</product>
  <measureUnit>pcs</measureUnit>
  <quantity>5</quantity>
</root>