有没有一种简单的方法来创建自定义PHP XML编写器功能？

Question

我正在开发一个输出XML的PHP​​ Web API（使用Laravel Lumen），但编写XML结构和属性已经失控，是否有一种简单的方法来创建缩短代码库的自定义函数？

我正在使用PHP的$xml = new \XMLWriter();并编写如下代码：

$xml->startElement('DataStructure');
$xml->writeAttribute('version', "1.0");

我想做的是：

$xml->startElement('DataStructure');
$this->api_version();

where

function api_version() {
    $xml->writeAttribute('version', "1.0");
}

Answer 1

您可以从XMLWriter继承以满足您的需求。您可以添加像addDatastructure()这样的方法，然后像这样使用它：

class ExtendedWriter extends XMLWriter {
    public function addDatastructure($version): self {
        $this->startElement('DataStructure');
        $this->writeAttribute('version', $version);

        return $this;
    }
}

// And use it like a so:
$writer = new ExtendedWriter;
$writer->addDatastructure($version);

您可以添加所需的任何功能。这使您的创建更少的代码，但也增加了可重用性。

Answer 2

这是另一个选项，允许添加更多数据结构，而无需向XMLWriter添加所有逻辑。

首先为数据结构类定义一个接口：

interface XMLWritable {
    public function writeTo(XMLWriter $writer); 
}

现在将一个方法添加到可以接受它的扩展XMLWriter中。另外，扩展XMLWriter的构造函数可以执行一些引导：

class MyXMLWriter extends XMLWriter {

    public function __construct(
      string $uri = 'php://output', string $version = '1.0', string $encoding = 'UTF-8'
    ) {
        $this->openURI($uri);
        $this->setIndent(true);
        $this->startDocument($version, $encoding);
    }

    public function write(XMLWritable $item): self {
        $item->writeTo($this);
        return $this;
    }
}

接下来，将接口实现为特定的数据类或序列化程序。您可以根据需要添加类。 XMLWriter不需要了解它们。

class ExampleItem implements XMLWritable {

    private $_content;

    public function __construct(string $content) {
        $this->_content = $content;
    }

    public function writeTo(XMLWriter $writer) {
        $writer->writeElement('example', $this->_content);
    }
}

使用它们看起来像这样：

$writer = new MyXMLWriter();
$writer->startElement('root');
$writer
  ->write(new ExampleItem('one'))
  ->write(new ExampleItem('two'));
$writer->endElement();