first commit

lib/pkp/classes/xml/XMLParserDOMHandler.php

@@ -0,0 +1,111 @@
+<?php
+
+/**
+ * @file classes/xml/XMLParserDOMHandler.php
+ *
+ * Copyright (c) 2014-2021 Simon Fraser University
+ * Copyright (c) 2000-2021 John Willinsky
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @class XMLParserDOMHandler
+ *
+ * @ingroup xml
+ *
+ * @see PKPXMLParser
+ *
+ * @brief Default handler for PKPXMLParser returning a simple DOM-style object.
+ * This handler parses an XML document into a tree structure of XMLNode objects.
+ *
+ */
+
+namespace PKP\xml;
+
+class XMLParserDOMHandler extends XMLParserHandler
+{
+    /** @var XMLNode reference to the root node */
+    public $rootNode;
+
+    /** @var XMLNode reference to the node currently being parsed */
+    public $currentNode;
+
+    /** @var string reference to the current data */
+    public $currentData;
+
+    /** @var XMLNode[] */
+    public $rootNodes = [];
+
+    /**
+     * Constructor.
+     */
+    public function __construct()
+    {
+        $this->rootNodes = [];
+        $this->currentNode = null;
+    }
+
+    public function destroy()
+    {
+        unset($this->currentNode, $this->currentData, $this->rootNode);
+    }
+
+    /**
+     * Callback function to act as the start element handler.
+     *
+     * @param PKPXMLParser $parser
+     * @param string $tag
+     * @param array $attributes
+     */
+    public function startElement($parser, $tag, $attributes)
+    {
+        $this->currentData = null;
+        $node = new XMLNode($tag);
+        $node->setAttributes($attributes);
+
+        if (isset($this->currentNode)) {
+            $this->currentNode->addChild($node);
+            $node->setParent($this->currentNode);
+        } else {
+            $this->rootNode = & $node;
+        }
+
+        $this->currentNode = & $node;
+    }
+
+    /**
+     * Callback function to act as the end element handler.
+     *
+     * @param PKPXMLParser $parser
+     * @param string $tag
+     */
+    public function endElement($parser, $tag)
+    {
+        $this->currentNode->setValue($this->currentData);
+        $this->currentNode = & $this->currentNode->getParent();
+        $this->currentData = null;
+    }
+
+    /**
+     * Callback function to act as the character data handler.
+     *
+     * @param PKPXMLParser $parser
+     * @param string $data
+     */
+    public function characterData($parser, $data)
+    {
+        $this->currentData .= $data;
+    }
+
+    /**
+     * Returns a reference to the root node of the tree representing the document.
+     *
+     * @return XMLNode
+     */
+    public function getResult()
+    {
+        return $this->rootNode;
+    }
+}
+
+if (!PKP_STRICT_MODE) {
+    class_alias('\PKP\xml\XMLParserDOMHandler', '\XMLParserDOMHandler');
+}