mirror/webgui
1
0
Fork 0
mirror of https://github.com/unraid/webgui.git synced 2026-04-23 18:48:49 -05:00
Code Issues Packages Projects Releases Wiki Activity

Updated Custom.php conversion (replace deprecated function)

Browse Source
This commit is contained in:
bergware
2018-08-14 21:32:14 +02:00
parent 2d14587ead
commit 906cee896e
1 changed files with 73 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/dynamix/include/Custom.php
+73 -63
View File
@@ -12,11 +12,12 @@
* Modified for unRAID of Array2XML Published February 9, 2016 by Jeetendra Singh
* Modified for unRAID of xmlToArray Published August 23, 2012 by Tamlyn Rhodes
*/
class custom {
class custom {
private static $xml = null;
private static $encoding = 'UTF-8';
/*
* Initialize the root XML node [optional]
* custom::init - initialize the root XML node [optional]
* @param $version
* @param $encoding
* @param $format_output
@@ -26,30 +27,39 @@
self::$xml->formatOutput = $format_output;
self::$encoding = $encoding;
}
/*
* 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 DomDocument
* custom::createXML - convert Array to XML
* @param string $root - name of the root node
* @param array $arr - array object to be converterd
* @return XML object
*/
public static function &createXML($node_name, $arr=array()) {
public static function &createXML($root, $arr=array()) {
$xml = self::getXMLRoot();
$xml->appendChild(self::convert($node_name, $arr));
self::$xml = null; // clear the xml node in the class for 2nd time use.
$xml->appendChild(self::Array2XML($root, $arr));
self::$xml = null; // clear the xml node in the class for 2nd time use
return $xml;
}
/*
* 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
* custom::createArray - convert XML to Array
* @param string $root - name of the root node
* @param array $xmlstring - xml string to be converterd
* @return Array object
*/
private static function &convert($node_name, $arr=array()) {
//print_arr($node_name);
public static function &createArray($root, $xmlstring) {
$xml = simplexml_load_string($xmlstring);
return self::XML2Array($xml)[$root];
}
/*
* Recursive conversion Array to XML
*/
private static function &Array2XML($node_name, $arr=array()) {
$xml = self::getXMLRoot();
$node = $xml->createElement($node_name);
if (is_array($arr)) {
// get the attributes first.;
// get the attributes first
if (isset($arr['@attributes'])) {
foreach ($arr['@attributes'] as $key => $value) {
if (!self::isValidTagName($key)) {
@@ -57,23 +67,23 @@
}
$node->setAttribute($key, self::bool2str($value));
}
unset($arr['@attributes']); //remove the key from the array once done.
unset($arr['@attributes']); //remove the key from the array once done
}
// 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'])) {
$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.
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;
} elseif (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.
// return from recursion, as a note with cdata cannot have child nodes
return $node;
}
}
//create subnodes using recursion
// create subnodes using recursion
if (is_array($arr)) {
// recurse to get the node for that key
foreach ($arr as $key=>$value) {
@@ -85,67 +95,39 @@
// 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) {
$node->appendChild(self::convert($key, $v));
$node->appendChild(self::Array2XML($key, $v));
}
} else {
// ONLY ONE NODE OF ITS KIND
$node->appendChild(self::convert($key, $value));
$node->appendChild(self::Array2XML($key, $value));
}
unset($arr[$key]); //remove the key from the array once done.
unset($arr[$key]); //remove the key from the array once done
}
}
// 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.
// we check if it has any text value, if yes, append it
if (!is_array($arr)) {
$node->appendChild($xml->createTextNode(self::bool2str($arr)));
}
return $node;
}
/*
* Get the root XML node, if there isn't one, create it.
*/
private static function getXMLRoot() {
if (empty(self::$xml)) {
self::init();
}
return self::$xml;
}
/*
* Get string representation of boolean value
*/
private static function bool2str($v) {
//convert boolean to text value.
$v = $v === true ? 'true' : $v;
$v = $v === false ? 'false' : $v;
return $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) {
$pattern = '/^[a-z_]+[a-z0-9\:\-\.\_]*[^:]*$/i';
return preg_match($pattern, $tag, $matches) && $matches[0] == $tag;
}
/*
* Convert xml string into array.
*/
public static function &createArray($root, $xmlstring) {
$xml = simplexml_load_string($xmlstring);
return self::XML2Array($xml)[$root];
}
/*
* Custom converter to process both values and attributes in XML nodes
* Recursive conversion XML to Array
*/
private static function &XML2Array($xml) {
// get the attributes first
$attributes = [];
foreach ($xml->attributes() as $attributeName => $attribute) {
$attributes['@attributes'][$attributeName] = (string)$attribute;
}
$tags = [];
// walk thru child nodes recursively
foreach ($xml->children() as $child) {
$array = self::XML2Array($child);
list($node, $data) = each($array);
$arr = self::XML2Array($child);
$node =key($arr);
$data = current($arr);
// store as single or multi array
if (!isset($tags[$node])) {
$tags[$node] = $data;
} elseif (is_array($tags[$node]) && array_keys($tags[$node])===range(0, count($tags[$node])-1)) {
@@ -157,8 +139,36 @@
$textContent = [];
$plainText = trim((string)$xml);
if ($plainText !== '') $textContent['@value'] = $plainText;
$properties = $attributes || $tags || ($plainText==='') ? array_merge($attributes, $tags, $textContent) : $plainText;
return array($xml->getName() => $properties);
// combine elements together
$data = $attributes || $tags || ($plainText==='') ? array_merge($attributes, $tags, $textContent) : $plainText;
return array($xml->getName() => $data);
}
/*
* Get the root XML node, if there isn't one, create it
*/
private static function getXMLRoot() {
if (empty(self::$xml)) self::init();
return self::$xml;
}
/*
* Get string representation of boolean value
*/
private static function bool2str($v) {
//convert boolean to text value.
$v = $v === true ? 'true' : $v;
$v = $v === false ? 'false' : $v;
return $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) {
$pattern = '/^[a-z_]+[a-z0-9\:\-\.\_]*[^:]*$/i';
return preg_match($pattern, $tag, $matches) && $matches[0] == $tag;
}
}
?>