]> git.mxchange.org Git - friendica.git/blobdiff - src/Util/XML.php
Move to XML
[friendica.git] / src / Util / XML.php
index 70af4cad53d42a963b33a8f1636a4a28ee528c1c..9a3108ca9894c49fa2dcea38213b7b692ba2617e 100644 (file)
@@ -4,6 +4,7 @@
  */
 namespace Friendica\Util;
 
+use Friendica\Core\Logger;
 use DOMXPath;
 use SimpleXMLElement;
 
@@ -23,7 +24,7 @@ class XML
         *
         * @return string The created XML
         */
-       public static function fromArray($array, &$xml, $remove_header = false, $namespaces = array(), $root = true)
+       public static function fromArray($array, &$xml, $remove_header = false, $namespaces = [], $root = true)
        {
                if ($root) {
                        foreach ($array as $key => $value) {
@@ -52,6 +53,7 @@ class XML
                        }
                }
 
+               $element = null;
                foreach ($array as $key => $value) {
                        if (!isset($element) && isset($xml)) {
                                $element = $xml;
@@ -140,7 +142,7 @@ class XML
         *
         * @return object XML element object
         */
-       public static function createElement($doc, $element, $value = "", $attributes = array())
+       public static function createElement($doc, $element, $value = "", $attributes = [])
        {
                $element = $doc->createElement($element, xmlify($value));
 
@@ -162,7 +164,7 @@ class XML
         * @param array  $attributes array containing the attributes
         * @return void
         */
-       public static function addElement($doc, $parent, $element, $value = "", $attributes = array())
+       public static function addElement($doc, $parent, $element, $value = "", $attributes = [])
        {
                $element = self::createElement($doc, $element, $value, $attributes);
                $parent->appendChild($element);
@@ -185,16 +187,17 @@ class XML
                        return(null);
                }
 
+               $xml_element_copy = '';
                if (!is_string($xml_element)
                        && !is_array($xml_element)
                        && (get_class($xml_element) == 'SimpleXMLElement')
                ) {
-                               $xml_element_copy = $xml_element;
-                               $xml_element = get_object_vars($xml_element);
+                       $xml_element_copy = $xml_element;
+                       $xml_element = get_object_vars($xml_element);
                }
 
                if (is_array($xml_element)) {
-                       $result_array = array();
+                       $result_array = [];
                        if (count($xml_element) <= 0) {
                                return (trim(strval($xml_element_copy)));
                        }
@@ -207,9 +210,9 @@ class XML
 
                        if ($recursion_depth == 0) {
                                $temp_array = $result_array;
-                               $result_array = array(
+                               $result_array = [
                                        strtolower($xml_element_copy->getName()) => $temp_array,
-                               );
+                               ];
                        }
 
                        return ($result_array);
@@ -242,12 +245,12 @@ class XML
        public static function toArray($contents, $namespaces = true, $get_attributes = 1, $priority = 'attribute')
        {
                if (!$contents) {
-                       return array();
+                       return [];
                }
 
                if (!function_exists('xml_parser_create')) {
-                       logger('Xml::toArray: parser function missing');
-                       return array();
+                       Logger::log('Xml::toArray: parser function missing');
+                       return [];
                }
 
 
@@ -261,8 +264,8 @@ class XML
                }
 
                if (! $parser) {
-                       logger('Xml::toArray: xml_parser_create: no resource');
-                       return array();
+                       Logger::log('Xml::toArray: xml_parser_create: no resource');
+                       return [];
                }
 
                xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, "UTF-8");
@@ -273,24 +276,24 @@ class XML
                @xml_parser_free($parser);
 
                if (! $xml_values) {
-                       logger('Xml::toArray: libxml: parse error: ' . $contents, LOGGER_DATA);
+                       Logger::log('Xml::toArray: libxml: parse error: ' . $contents, Logger::DATA);
                        foreach (libxml_get_errors() as $err) {
-                               logger('libxml: parse: ' . $err->code . " at " . $err->line . ":" . $err->column . " : " . $err->message, LOGGER_DATA);
+                               Logger::log('libxml: parse: ' . $err->code . " at " . $err->line . ":" . $err->column . " : " . $err->message, Logger::DATA);
                        }
                        libxml_clear_errors();
                        return;
                }
 
                //Initializations
-               $xml_array = array();
-               $parents = array();
-               $opened_tags = array();
-               $arr = array();
+               $xml_array = [];
+               $parents = [];
+               $opened_tags = [];
+               $arr = [];
 
                $current = &$xml_array; // Reference
 
                // Go through the tags.
-               $repeated_tag_index = array(); // Multiple tags with same name will be turned into an array
+               $repeated_tag_index = []; // Multiple tags with same name will be turned into an array
                foreach ($xml_values as $data) {
                        $tag        = $data['tag'];
                        $type       = $data['type'];
@@ -298,8 +301,8 @@ class XML
                        $attributes = isset($data['attributes']) ? $data['attributes'] : null;
                        $value      = isset($data['value']) ? $data['value'] : null;
 
-                       $result = array();
-                       $attributes_data = array();
+                       $result = [];
+                       $attributes_data = [];
 
                        if (isset($value)) {
                                if ($priority == 'tag') {
@@ -344,7 +347,7 @@ class XML
                                                $current[$tag][$repeated_tag_index[$tag.'_'.$level]] = $result;
                                                $repeated_tag_index[$tag.'_'.$level]++;
                                        } else { // This section will make the value an array if multiple tags with the same name appear together
-                                               $current[$tag] = array($current[$tag], $result); // This will combine the existing item and the new item together to make an array
+                                               $current[$tag] = [$current[$tag], $result]; // This will combine the existing item and the new item together to make an array
                                                $repeated_tag_index[$tag.'_'.$level] = 2;
 
                                                if (isset($current[$tag.'_attr'])) { // The attribute of the last(0th) tag must be moved as well
@@ -374,7 +377,7 @@ class XML
                                                }
                                                $repeated_tag_index[$tag.'_'.$level]++;
                                        } else { // If it is not an array...
-                                               $current[$tag] = array($current[$tag], $result); //...Make it an array using using the existing value and the new value
+                                               $current[$tag] = [$current[$tag], $result]; //...Make it an array using using the existing value and the new value
                                                $repeated_tag_index[$tag.'_'.$level] = 1;
                                                if ($priority == 'tag' and $get_attributes) {
                                                        if (isset($current[$tag.'_attr'])) { // The attribute of the last(0th) tag must be moved as well
@@ -413,4 +416,89 @@ class XML
                        $child->parentNode->removeChild($child);
                }
        }
+
+       public static function parseString($s, $strict = true)
+       {
+               // the "strict" parameter is deactivated
+               libxml_use_internal_errors(true);
+
+               $x = @simplexml_load_string($s);
+               if (!$x) {
+                       Logger::log('libxml: parse: error: ' . $s, Logger::DATA);
+                       foreach (libxml_get_errors() as $err) {
+                               Logger::log('libxml: parse: ' . $err->code." at ".$err->line.":".$err->column." : ".$err->message, Logger::DATA);
+                       }
+                       libxml_clear_errors();
+               }
+               return $x;
+       }
+
+       public static function getFirstNodeValue($xpath, $element, $context = null)
+       {
+               $result = $xpath->evaluate($element, $context);
+               if (!is_object($result)) {
+                       return '';
+               }
+
+               $first_item = $result->item(0);
+               if (!is_object($first_item)) {
+                       return '';
+               }
+
+               return $first_item->nodeValue;
+       }
+
+       public static function getFirstAttributes($xpath, $element, $context = null)
+       {
+               $result = $xpath->query($element, $context);
+               if (!is_object($result)) {
+                       return false;
+               }
+
+               $first_item = $result->item(0);
+               if (!is_object($first_item)) {
+                       return false;
+               }
+
+               return $first_item->attributes;
+       }
+
+       /**
+        * escape text ($str) for XML transport
+        * @param string $str
+        * @return string Escaped text.
+        */
+       public static function xmlify($str)
+       {
+               $buffer = htmlspecialchars($str, ENT_QUOTES, "UTF-8");
+               $buffer = trim($buffer);
+
+               return $buffer;
+       }
+
+       /**
+        * undo an xmlify
+        * @param string $s xml escaped text
+        * @return string unescaped text
+        */
+       public static function unxmlify($s)
+       {
+               $ret = htmlspecialchars_decode($s, ENT_QUOTES);
+               return $ret;
+       }
+
+       /**
+        * apply xmlify() to all values of array $val, recursively
+        * @param array $val
+        * @return array
+        */
+       public static function arrayXmlify($val)
+       {
+               if (is_bool($val)) {
+                       return $val?"true":"false";
+               } elseif (is_array($val)) {
+                       return array_map('XML::arrayXmlify', $val);
+               }
+               return self::xmlify((string) $val);
+       }
 }