]> git.mxchange.org Git - friendica.git/blobdiff - src/Util/XML.php
Merge pull request #4951 from MrPetovan/bug/4946-move-current-theme-to-app
[friendica.git] / src / Util / XML.php
index 7ecf85acd07f9ae2bc7f24de05daad94537c0b40..8dc540324368b23af4d917c9e05956de333ade1e 100644 (file)
@@ -1,11 +1,10 @@
 <?php
-
 /**
  * @file src/Util/XML.php
  */
 namespace Friendica\Util;
 
-use DomXPath;
+use DOMXPath;
 use SimpleXMLElement;
 
 /**
@@ -24,7 +23,7 @@ class XML
         *
         * @return string The created XML
         */
-       public static function from_array($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) {
@@ -34,7 +33,7 @@ class XML
 
                                if (is_array($value)) {
                                        $root = new SimpleXMLElement("<".$key."/>");
-                                       self::from_array($value, $root, $remove_header, $namespaces, false);
+                                       self::fromArray($value, $root, $remove_header, $namespaces, false);
                                } else {
                                        $root = new SimpleXMLElement("<".$key.">".xmlify($value)."</".$key.">");
                                }
@@ -53,6 +52,7 @@ class XML
                        }
                }
 
+               $element = null;
                foreach ($array as $key => $value) {
                        if (!isset($element) && isset($xml)) {
                                $element = $xml;
@@ -106,7 +106,7 @@ class XML
                                $element = $xml->addChild($key, xmlify($value), $namespace);
                        } elseif (is_array($value)) {
                                $element = $xml->addChild($key, null, $namespace);
-                               self::from_array($value, $element, $remove_header, $namespaces, false);
+                               self::fromArray($value, $element, $remove_header, $namespaces, false);
                        }
                }
        }
@@ -117,6 +117,7 @@ class XML
         * @param object $source      The XML source
         * @param object $target      The XML target
         * @param string $elementname Name of the XML element of the target
+        * @return void
         */
        public static function copy(&$source, &$target, $elementname)
        {
@@ -140,7 +141,7 @@ class XML
         *
         * @return object XML element object
         */
-       public static function create_element($doc, $element, $value = "", $attributes = array())
+       public static function createElement($doc, $element, $value = "", $attributes = [])
        {
                $element = $doc->createElement($element, xmlify($value));
 
@@ -160,10 +161,11 @@ class XML
         * @param string $element    XML element name
         * @param string $value      XML value
         * @param array  $attributes array containing the attributes
+        * @return void
         */
-       public static function add_element($doc, $parent, $element, $value = "", $attributes = array())
+       public static function addElement($doc, $parent, $element, $value = "", $attributes = [])
        {
-               $element = self::create_element($doc, $element, $value, $attributes);
+               $element = self::createElement($doc, $element, $value, $attributes);
                $parent->appendChild($element);
        }
 
@@ -175,40 +177,41 @@ class XML
         * @param integer $recursion_depth recursion counter for internal use - default 0
         *                                 internal use, recursion counter
         *
-        * @return array | sring The array from the xml element or the string
+        * @return array | string The array from the xml element or the string
         */
-       public static function element_to_array($xml_element, &$recursion_depth=0)
+       public static function elementToArray($xml_element, &$recursion_depth = 0)
        {
                // If we're getting too deep, bail out
                if ($recursion_depth > 512) {
                        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)));
                        }
 
                        foreach ($xml_element as $key => $value) {
                                $recursion_depth++;
-                               $result_array[strtolower($key)] = self::element_to_array($value, $recursion_depth);
+                               $result_array[strtolower($key)] = self::elementToArray($value, $recursion_depth);
                                $recursion_depth--;
                        }
 
                        if ($recursion_depth == 0) {
                                $temp_array = $result_array;
-                               $result_array = array(
+                               $result_array = [
                                        strtolower($xml_element_copy->getName()) => $temp_array,
-                               );
+                               ];
                        }
 
                        return ($result_array);
@@ -220,13 +223,13 @@ class XML
        /**
         * @brief Convert the given XML text to an array in the XML structure.
         *
-        * Xml::to_array() will convert the given XML text to an array in the XML structure.
+        * Xml::toArray() will convert the given XML text to an array in the XML structure.
         * Link: http://www.bin-co.com/php/scripts/xml2array/
         * Portions significantly re-written by mike@macgirvin.com for Friendica
         * (namespaces, lowercase tags, get_attribute default changed, more...)
         *
-        * Examples: $array =  Xml::to_array(file_get_contents('feed.xml'));
-        *              $array =  Xml::to_array(file_get_contents('feed.xml', true, 1, 'attribute'));
+        * Examples: $array =  Xml::toArray(file_get_contents('feed.xml'));
+        *              $array =  Xml::toArray(file_get_contents('feed.xml', true, 1, 'attribute'));
         *
         * @param object  $contents       The XML text
         * @param boolean $namespaces     True or false include namespace information
@@ -238,15 +241,15 @@ class XML
         *
         * @return array The parsed XML in an array form. Use print_r() to see the resulting array structure.
         */
-       public static function to_array($contents, $namespaces = true, $get_attributes = 1, $priority = 'attribute')
+       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::to_array: parser function missing');
-                       return array();
+                       logger('Xml::toArray: parser function missing');
+                       return [];
                }
 
 
@@ -260,8 +263,8 @@ class XML
                }
 
                if (! $parser) {
-                       logger('Xml::to_array: xml_parser_create: no resource');
-                       return array();
+                       logger('Xml::toArray: xml_parser_create: no resource');
+                       return [];
                }
 
                xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, "UTF-8");
@@ -272,7 +275,7 @@ class XML
                @xml_parser_free($parser);
 
                if (! $xml_values) {
-                       logger('Xml::to_array: libxml: parse error: ' . $contents, LOGGER_DATA);
+                       logger('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);
                        }
@@ -281,24 +284,24 @@ class XML
                }
 
                //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) {
-                       unset($attributes, $value); // Remove existing values, or there will be trouble
-
-                       // This command will extract these variables into the foreach scope
-                       // tag(string), type(string), level(int), attributes(array).
-                       extract($data); // We could use the array by itself, but this cooler.
+                       $tag        = $data['tag'];
+                       $type       = $data['type'];
+                       $level      = $data['level'];
+                       $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') {
@@ -343,7 +346,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
@@ -373,7 +376,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
@@ -402,13 +405,30 @@ class XML
         *
         * @param object $doc  XML document
         * @param string $node Node name
+        * @return void
         */
        public static function deleteNode(&$doc, $node)
        {
-               $xpath = new DomXPath($doc);
+               $xpath = new DOMXPath($doc);
                $list = $xpath->query("//".$node);
                foreach ($list as $child) {
                        $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('libxml: parse: error: ' . $s, LOGGER_DATA);
+                       foreach (libxml_get_errors() as $err) {
+                               logger('libxml: parse: ' . $err->code." at ".$err->line.":".$err->column." : ".$err->message, LOGGER_DATA);
+                       }
+                       libxml_clear_errors();
+               }
+               return $x;
+       }
 }