From 94b15f455cb60e04c89cc298a5a9453150e16d6d Mon Sep 17 00:00:00 2001 From: "Timothy J. Warren" Date: Tue, 12 Mar 2019 09:43:17 -0400 Subject: [PATCH] Remove XML codec class --- src/API/XML.php | 280 ------------------------------------------------ 1 file changed, 280 deletions(-) delete mode 100644 src/API/XML.php diff --git a/src/API/XML.php b/src/API/XML.php deleted file mode 100644 index ed4126ba..00000000 --- a/src/API/XML.php +++ /dev/null @@ -1,280 +0,0 @@ - - * @copyright 2015 - 2018 Timothy J. Warren - * @license http://www.opensource.org/licenses/mit-license.html MIT License - * @version 4.1 - * @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient - */ - -namespace Aviat\AnimeClient\API; - -use DOMDocument, DOMNode, DOMNodeList, InvalidArgumentException; - -/** - * XML <=> PHP Array codec - */ -final class XML { - - /** - * XML representation of the data - * - * @var string - */ - private $xml; - - /** - * PHP array version of the data - * - * @var array - */ - private $data; - - /** - * XML constructor - * - * @param string $xml - * @param array $data - */ - public function __construct(string $xml = '', array $data = []) - { - $this->setXML($xml)->setData($data); - } - - /** - * Serialize the data to an xml string - * - * @return string - */ - public function __toString(): string - { - return static::toXML($this->getData()); - } - - /** - * Get the data parsed from the XML - * - * @return array - */ - public function getData(): array - { - return $this->data; - } - - /** - * Set the data to create xml from - * - * @param array $data - * @return self - */ - public function setData(array $data): self - { - $this->data = $data; - return $this; - } - - /** - * Get the xml created from the data - * - * @return string - */ - public function getXML(): string - { - return $this->xml; - } - - /** - * Set the xml to parse the data from - * - * @param string $xml - * @return self - */ - public function setXML(string $xml): self - { - $this->xml = $xml; - return $this; - } - - /** - * Parse an xml document string to a php array - * - * @param string $xml - * @return array - */ - public static function toArray(string $xml): array - { - $data = []; - - $xml = static::stripXMLWhitespace($xml); - - $dom = new DOMDocument(); - $hasLoaded = @$dom->loadXML($xml); - - if ( ! $hasLoaded) - { - throw new InvalidArgumentException('Failed to load XML'); - } - - $root = $dom->documentElement; - - $data[$root->tagName] = []; - - if ($root->hasChildNodes()) - { - static::childNodesToArray($data[$root->tagName], $root->childNodes); - } - - return $data; - } - - /** - * Transform the array into XML - * - * @param array $data - * @return string - */ - public static function toXML(array $data): string - { - $dom = new DOMDocument(); - $dom->encoding = 'UTF-8'; - - static::arrayPropertiesToXmlNodes($dom, $dom, $data); - - return $dom->saveXML(); - } - - /** - * Parse the xml document string to a php array - * - * @return array - */ - public function parse(): array - { - $xml = $this->getXML(); - $data = static::toArray($xml); - return $this->setData($data)->getData(); - } - - /** - * Transform the array into XML - * - * @return string - */ - public function createXML(): string - { - return static::toXML($this->getData()); - } - - /** - * Strip whitespace from raw xml to remove irrelevant text nodes - * - * @param string $xml - * @return string - */ - private static function stripXMLWhitespace(string $xml): string - { - // Get rid of unimportant text nodes by removing - // whitespace characters from between xml tags, - // except for the xml declaration tag, Which looks - // something like: - /* */ - return preg_replace('/([^?])>\s+<', $xml); - } - - /** - * Recursively create array structure based on xml structure - * - * @param array $root A reference to the current array location - * @param DOMNodeList $nodeList The current NodeList object - * @return void - */ - private static function childNodesToArray(array &$root, DOMNodelist $nodeList): void - { - $length = $nodeList->length; - for ($i = 0; $i < $length; $i++) - { - $el = $nodeList->item($i); - $current =& $root[$el->nodeName]; - - // It's a top level element! - if (( ! $el->hasChildNodes()) || is_a($el->childNodes->item(0), 'DomText')) - { - $current = $el->textContent; - continue; - } - - // An empty value at the current root - if ($current === NULL) - { - $current = []; - static::childNodesToArray($current, $el->childNodes); - continue; - } - - $keys = array_keys($current); - - // Wrap the array in a containing array - // if there are only string keys - if ( ! is_numeric($keys[0])) - { - // But if there is only one key, don't wrap it in - // an array, just recurse to parse the child nodes - if (count($current) === 1) - { - static::childNodesToArray($current, $el->childNodes); - continue; - } - $current = [$current]; - } - - $current[] = []; - $index = count($current) - 1; - - static::childNodesToArray($current[$index], $el->childNodes); - } - } - - /** - * Recursively create xml nodes from array properties - * - * @param DOMDocument $dom The current DOM object - * @param DOMNode $parent The parent element to append children to - * @param array $data The data for the current node - * @return void - */ - private static function arrayPropertiesToXmlNodes(DOMDocument $dom, DOMNode $parent, array $data): void - { - foreach($data as $key => $props) - { - // 'Flatten' the array as you create the xml - if (is_numeric($key)) - { - foreach($props as $key => $props) - { - break; - } - } - - $node = $dom->createElement($key); - - if (\is_array($props)) - { - static::arrayPropertiesToXmlNodes($dom, $node, $props); - } - else - { - $tNode = $dom->createTextNode((string)$props); - $node->appendChild($tNode); - } - - $parent->appendChild($node); - } - } -} \ No newline at end of file