From 08ee5a41eed69498a67d5c3e77da64446e88506b Mon Sep 17 00:00:00 2001 From: Herjan Date: Wed, 28 Oct 2015 09:32:03 +0100 Subject: [PATCH 1/5] Code style changes (tabs / spaces fix); Typo fix; --- LSS/Array2XML.php | 86 +++++++++++++++++++++++++---------------------- 1 file changed, 46 insertions(+), 40 deletions(-) diff --git a/LSS/Array2XML.php b/LSS/Array2XML.php index 4b91f47..ff532c3 100644 --- a/LSS/Array2XML.php +++ b/LSS/Array2XML.php @@ -2,23 +2,24 @@ /** * OpenLSS - Lighter Smarter Simpler * - * This file is part of OpenLSS. + * This file is part of OpenLSS. * - * OpenLSS is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License as - * published by the Free Software Foundation, either version 3 of - * the License, or (at your option) any later version. + * OpenLSS is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation, either version 3 of + * the License, or (at your option) any later version. * - * OpenLSS is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License for more details. + * OpenLSS is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. * - * You should have received a copy of the - * GNU Lesser General Public License along with OpenLSS. - * If not, see . -*/ + * You should have received a copy of the + * GNU Lesser General Public License along with OpenLSS. + * If not, see . + */ namespace LSS; + use \DomDocument; use \Exception; @@ -53,11 +54,10 @@ * $xml = Array2XML::createXML('root_node_name', $php_array); * echo $xml->saveXML(); */ - class Array2XML { private static $xml = null; - private static $encoding = 'UTF-8'; + private static $encoding = 'UTF-8'; /** * Initialize the root XML node [optional] @@ -68,7 +68,7 @@ class Array2XML { public static function init($version = '1.0', $encoding = 'UTF-8', $format_output = true) { self::$xml = new DomDocument($version, $encoding); self::$xml->formatOutput = $format_output; - self::$encoding = $encoding; + self::$encoding = $encoding; } /** @@ -77,7 +77,7 @@ public static function init($version = '1.0', $encoding = 'UTF-8', $format_outpu * @param array $arr - aray to be converterd * @return DomDocument */ - public static function &createXML($node_name, $arr=array()) { + public static function &createXML($node_name, $arr = array()) { $xml = self::getXMLRoot(); $xml->appendChild(self::convert($node_name, $arr)); @@ -86,23 +86,29 @@ public static function &createXML($node_name, $arr=array()) { } /** - * Convert an Array to XML - * @param string $node_name - name of the root node to be converted - * @param array $arr - aray to be converterd - * @return DOMNode + * Convert an Array to XML. + * + * @param string $node_name + * Name of the root node to be converted. + * @param array $arr + * Array to be converted. + * + * @throws \Exception + * + * @return \DOMNode */ - private static function &convert($node_name, $arr=array()) { + private static function &convert($node_name, $arr = array()) { //print_arr($node_name); $xml = self::getXMLRoot(); $node = $xml->createElement($node_name); - if(is_array($arr)){ + if (is_array($arr)) { // get the attributes first.; - if(isset($arr['@attributes'])) { - foreach($arr['@attributes'] as $key => $value) { - if(!self::isValidTagName($key)) { - throw new Exception('[Array2XML] Illegal character in attribute name. attribute: '.$key.' in node: '.$node_name); + if (isset($arr['@attributes'])) { + foreach ($arr['@attributes'] as $key => $value) { + if (!self::isValidTagName($key)) { + throw new Exception('[Array2XML] Illegal character in attribute name. attribute: ' . $key . ' in node: ' . $node_name); } $node->setAttribute($key, self::bool2str($value)); } @@ -111,12 +117,12 @@ private static function &convert($node_name, $arr=array()) { // check if it has a value stored in @value, if yes store the value and return // else check if its directly stored as string - if(isset($arr['@value'])) { + if (isset($arr['@value'])) { $node->appendChild($xml->createTextNode(self::bool2str($arr['@value']))); unset($arr['@value']); //remove the key from the array once done. //return from recursion, as a note with value cannot have child nodes. return $node; - } else if(isset($arr['@cdata'])) { + } else if (isset($arr['@cdata'])) { $node->appendChild($xml->createCDATASection(self::bool2str($arr['@cdata']))); unset($arr['@cdata']); //remove the key from the array once done. //return from recursion, as a note with cdata cannot have child nodes. @@ -125,17 +131,17 @@ private static function &convert($node_name, $arr=array()) { } //create subnodes using recursion - if(is_array($arr)){ + if (is_array($arr)) { // recurse to get the node for that key - foreach($arr as $key=>$value){ - if(!self::isValidTagName($key)) { - throw new Exception('[Array2XML] Illegal character in tag name. tag: '.$key.' in node: '.$node_name); + foreach ($arr as $key => $value) { + if (!self::isValidTagName($key)) { + throw new Exception('[Array2XML] Illegal character in tag name. tag: ' . $key . ' in node: ' . $node_name); } - if(is_array($value) && is_numeric(key($value))) { + if (is_array($value) && is_numeric(key($value))) { // MORE THAN ONE NODE OF ITS KIND; // if the new array is numeric index, means it is array of nodes of the same kind // it should follow the parent key name - foreach($value as $k=>$v){ + foreach ($value as $k => $v) { $node->appendChild(self::convert($key, $v)); } } else { @@ -148,7 +154,7 @@ private static function &convert($node_name, $arr=array()) { // after we are done with all the keys in the array (if it is one) // we check if it has any text value, if yes, append it. - if(!is_array($arr)) { + if (!is_array($arr)) { $node->appendChild($xml->createTextNode(self::bool2str($arr))); } @@ -158,8 +164,8 @@ private static function &convert($node_name, $arr=array()) { /* * Get the root XML node, if there isn't one, create it. */ - private static function getXMLRoot(){ - if(empty(self::$xml)) { + private static function getXMLRoot() { + if (empty(self::$xml)) { self::init(); } return self::$xml; @@ -168,7 +174,7 @@ private static function getXMLRoot(){ /* * Get string representation of boolean value */ - private static function bool2str($v){ + private static function bool2str($v) { //convert boolean to text value. $v = $v === true ? 'true' : $v; $v = $v === false ? 'false' : $v; @@ -179,7 +185,7 @@ private static function bool2str($v){ * Check if the tag name or attribute name contains illegal characters * Ref: http://www.w3.org/TR/xml/#sec-common-syn */ - private static function isValidTagName($tag){ + private static function isValidTagName($tag) { $pattern = '/^[a-z_]+[a-z0-9\:\-\.\_]*[^:]*$/i'; return preg_match($pattern, $tag, $matches) && $matches[0] == $tag; } From 7f804fdca86e88d404b139cd948f032da228c81f Mon Sep 17 00:00:00 2001 From: Herjan Date: Wed, 28 Oct 2015 09:35:12 +0100 Subject: [PATCH 2/5] Allow insertion of DOMObjects provided by the array. --- LSS/Array2XML.php | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/LSS/Array2XML.php b/LSS/Array2XML.php index ff532c3..960fc16 100644 --- a/LSS/Array2XML.php +++ b/LSS/Array2XML.php @@ -56,6 +56,9 @@ */ class Array2XML { + /** + * @var DOMDocument + */ private static $xml = null; private static $encoding = 'UTF-8'; @@ -128,6 +131,11 @@ private static function &convert($node_name, $arr = array()) { //return from recursion, as a note with cdata cannot have child nodes. return $node; } + else if (isset($arr['@dom'])) { + $node->appendChild($arr['@dom']); + unset($arr['@dom']); + return $node; + } } //create subnodes using recursion From bb661a1cf43cf510424c51bada87cd7c5bb63570 Mon Sep 17 00:00:00 2001 From: Herjan Date: Wed, 28 Oct 2015 09:53:40 +0100 Subject: [PATCH 3/5] Renamed to @xml; Now using DocumentFragment to insert and XML string as child; --- LSS/Array2XML.php | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/LSS/Array2XML.php b/LSS/Array2XML.php index 960fc16..01d28a1 100644 --- a/LSS/Array2XML.php +++ b/LSS/Array2XML.php @@ -131,8 +131,10 @@ private static function &convert($node_name, $arr = array()) { //return from recursion, as a note with cdata cannot have child nodes. return $node; } - else if (isset($arr['@dom'])) { - $node->appendChild($arr['@dom']); + else if (isset($arr['@xml'])) { + $fragment = $xml->createDocumentFragment(); + $fragment->appendXML($arr['@xml']); + $node->appendChild($fragment); unset($arr['@dom']); return $node; } From a1fa4aa83b9547adb06b6306c6f02d905b7cad29 Mon Sep 17 00:00:00 2001 From: Herjan Date: Wed, 28 Oct 2015 10:36:06 +0100 Subject: [PATCH 4/5] Added documentation for the @xml change --- LSS/Array2XML.php | 2 ++ README.md | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 34 insertions(+) diff --git a/LSS/Array2XML.php b/LSS/Array2XML.php index 01d28a1..7dc4fe9 100644 --- a/LSS/Array2XML.php +++ b/LSS/Array2XML.php @@ -49,6 +49,8 @@ * - Reverted to version 0.5 * Version: 0.8 (02 May 2012) * - Removed htmlspecialchars() before adding to text node or attributes. + * Version: 0.11 (28 October 2015) + * - Fixed typos; Added support for plain insertion of XML trough @xml. * * Usage: * $xml = Array2XML::createXML('root_node_name', $php_array); diff --git a/README.md b/README.md index 7abe66d..fcebd15 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,38 @@ $array = XML2Array::createArray($xml); print_r($array); ``` +Array2XML +---- + +@xml example: +```php +// Build the array that should be transformed into a XML object. +$array = [ + 'title' => 'A title', + 'body' => [ + '@xml' => '

The content for the news item

', + ], +]; + +// Use the Array2XML object to transform it. +$xml = Array2XML::createXML('news', $array); +echo $xml->saveXML(); +``` +This will result in the following. +```xml + + + A title + + + +

The content for the news item

+ + + + +``` + Reference ---- More complete references can be found here From 58a84a54fbe08c286a67528c719d643c1256410d Mon Sep 17 00:00:00 2001 From: Herjan Date: Wed, 28 Oct 2015 14:06:57 +0100 Subject: [PATCH 5/5] Unset wrong key, old name for same functionality --- LSS/Array2XML.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LSS/Array2XML.php b/LSS/Array2XML.php index 7dc4fe9..581f313 100644 --- a/LSS/Array2XML.php +++ b/LSS/Array2XML.php @@ -137,7 +137,7 @@ private static function &convert($node_name, $arr = array()) { $fragment = $xml->createDocumentFragment(); $fragment->appendXML($arr['@xml']); $node->appendChild($fragment); - unset($arr['@dom']); + unset($arr['@xml']); return $node; } }