X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FUtil%2FXML.php;h=e1910ce47d8256ee1bedbadbc11cc95ddc46eb77;hb=d4a5a8051ad34a7be72238967afb3e6b140afdc8;hp=7d1827763356305350d564ff6deeb3df24bd00b8;hpb=e3aed8099c1605e1b15b70f74b94540f4512c829;p=friendica.git

diff --git a/src/Util/XML.php b/src/Util/XML.php
index 7d18277633..e1910ce47d 100644
--- a/src/Util/XML.php
+++ b/src/Util/XML.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2010-2022, the Friendica project
+ * @copyright Copyright (C) 2010-2023, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -26,7 +26,6 @@ use DOMElement;
 use DOMNode;
 use DOMXPath;
 use Friendica\Core\Logger;
-use Friendica\Core\System;
 use SimpleXMLElement;
 
 /**
@@ -37,14 +36,15 @@ class XML
 	/**
 	 * Creates an XML structure out of a given array
 	 *
-	 * @param array  $array         The array of the XML structure that will be generated
-	 * @param object $xml           The createdXML will be returned by reference
-	 * @param bool   $remove_header Should the XML header be removed or not?
-	 * @param array  $namespaces    List of namespaces
-	 * @param bool   $root          interally used parameter. Mustn't be used from outside.
-	 * @return void
+	 * @param array       $array         The array of the XML structure that will be generated
+	 * @param object|null $xml           The created XML will be returned by reference
+	 * @param bool        $remove_header Should the XML header be removed or not?
+	 * @param array       $namespaces    List of namespaces
+	 * @param bool        $root          interally used parameter. Mustn't be used from outside.
+	 * @return string
+	 * @throws \Exception
 	 */
-	public static function fromArray(array $array, &$xml, bool $remove_header = false, array $namespaces = [], bool $root = true)
+	public static function fromArray(array $array, object &$xml = null, bool $remove_header = false, array $namespaces = [], bool $root = true): string
 	{
 		if ($root) {
 			foreach ($array as $key => $value) {
@@ -117,7 +117,7 @@ class XML
 						$namespace = null;
 					}
 
-					$element->addAttribute($attr_key, $attr_value, $namespace);
+					$element->addAttribute($attr_key, $attr_value ?? '', $namespace);
 				}
 
 				continue;
@@ -125,22 +125,23 @@ class XML
 
 			if (!is_array($value)) {
 				$element = $xml->addChild($key, self::escape($value ?? ''), $namespace);
-			} elseif (is_array($value)) {
+			} else {
 				$element = $xml->addChild($key, null, $namespace);
 				self::fromArray($value, $element, $remove_header, $namespaces, false);
 			}
 		}
+		return '';
 	}
 
 	/**
 	 * Copies an XML object
 	 *
-	 * @param object $source      The XML source
-	 * @param object $target      The XML target
-	 * @param string $elementname Name of the XML element of the target
+	 * @param object|string $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, string $elementname)
+	public static function copy(&$source, &$target, $elementname)
 	{
 		if (count($source->children()) == 0) {
 			$target->addChild($elementname, self::escape($source));
@@ -177,22 +178,21 @@ class XML
 	/**
 	 * Create an XML and append it to the parent object
 	 *
-	 * @param DOMDocument $doc   XML root
-	 * @param object $parent     parent object
-	 * @param string $element    XML element name
-	 * @param string $value      XML value
-	 * @param array  $attributes array containing the attributes
+	 * @param DOMDocument $doc        XML root
+	 * @param DOMElement  $parent     parent object
+	 * @param string      $element    XML element name
+	 * @param string      $value      XML value
+	 * @param array       $attributes Array containing the attributes
 	 * @return void
 	 */
-	public static function addElement(DOMDocument $doc, $parent, string $element, string $value = '', array $attributes = [])
+	public static function addElement(DOMDocument $doc, DOMElement &$parent, string $element, string $value = null, array $attributes = [])
 	{
-		$element = self::createElement($doc, $element, $value, $attributes);
+		$element = self::createElement($doc, $element, $value ?? '', $attributes);
 		$parent->appendChild($element);
 	}
 
 	/**
-	 * Convert an XML document to a normalised, case-corrected array
-	 *   used by webfinger
+	 * Convert an XML document to a normalised, case-corrected array used by webfinger
 	 *
 	 * @param object  $xml_element     The XML document
 	 * @param integer $recursion_depth recursion counter for internal use - default 0
@@ -204,7 +204,7 @@ class XML
 	{
 		// If we're getting too deep, bail out
 		if ($recursion_depth > 512) {
-			return(null);
+			return null;
 		}
 
 		$xml_element_copy = '';
@@ -258,7 +258,7 @@ class XML
 	 * @param integer $get_attributes   1 or 0. If this is 1 the function will get the attributes as well as the tag values -
 	 *                                  this results in a different array structure in the return value.
 	 * @param string  $priority         Can be 'tag' or 'attribute'. This will change the way the resulting
-	 *                                  array sturcture. For 'tag', the tags are given more importance.
+	 *                                  array structure. For 'tag', the tags are given more importance.
 	 *
 	 * @return array The parsed XML in an array form. Use print_r() to see the resulting array structure.
 	 * @throws \Exception
@@ -270,10 +270,11 @@ class XML
 		}
 
 		if (!function_exists('xml_parser_create')) {
-			Logger::notice('Xml::toArray: parser function missing');
+			Logger::error('Xml::toArray: parser function missing');
 			return [];
 		}
 
+		$parent = [];
 
 		libxml_use_internal_errors(true);
 		libxml_clear_errors();
@@ -284,12 +285,12 @@ class XML
 			$parser = @xml_parser_create();
 		}
 
-		if (! $parser) {
-			Logger::notice('Xml::toArray: xml_parser_create: no resource');
+		if (!$parser) {
+			Logger::warning('Xml::toArray: xml_parser_create: no resource');
 			return [];
 		}
 
-		xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, "UTF-8");
+		xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, 'UTF-8');
 		// http://minutillo.com/steve/weblog/2004/6/17/php-xml-and-character-encodings-a-tale-of-sadness-rage-and-data-loss
 		xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
 		xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 1);
@@ -299,7 +300,7 @@ class XML
 		if (! $xml_values) {
 			Logger::debug('Xml::toArray: libxml: parse error: ' . $contents);
 			foreach (libxml_get_errors() as $err) {
-				Logger::debug('libxml: parse: ' . $err->code . " at " . $err->line . ":" . $err->column . " : " . $err->message);
+				Logger::debug('libxml: parse: ' . $err->code . ' at ' . $err->line . ':' . $err->column . ' : ' . $err->message);
 			}
 			libxml_clear_errors();
 			return [];
@@ -349,38 +350,38 @@ class XML
 			}
 			$tag = strtolower($tag);
 
-			if ($type == "open") {   // The starting of the tag '<tag>'
+			if ($type == 'open') {   // The starting of the tag '<tag>'
 				$parent[$level-1] = &$current;
 				if (!is_array($current) || (!in_array($tag, array_keys($current)))) { // Insert New tag
 					$current[$tag] = $result;
 					if ($attributes_data) {
 						$current[$tag. '_attr'] = $attributes_data;
 					}
-					$repeated_tag_index[$tag.'_'.$level] = 1;
+					$repeated_tag_index[$tag . '_' . $level] = 1;
 
 					$current = &$current[$tag];
 				} else { // There was another element with the same tag name
 
 					if (isset($current[$tag][0])) { // If there is a 0th element it is already an array
-						$current[$tag][$repeated_tag_index[$tag.'_'.$level]] = $result;
-						$repeated_tag_index[$tag.'_'.$level]++;
+						$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] = [$current[$tag], $result]; // This will combine the existing item and the new item together to make an array
-						$repeated_tag_index[$tag.'_'.$level] = 2;
+						$repeated_tag_index[$tag . '_' . $level] = 2;
 
 						if (isset($current[$tag.'_attr'])) { // The attribute of the last(0th) tag must be moved as well
 							$current[$tag]['0_attr'] = $current[$tag.'_attr'];
 							unset($current[$tag.'_attr']);
 						}
 					}
-					$last_item_index = $repeated_tag_index[$tag.'_'.$level]-1;
+					$last_item_index = $repeated_tag_index[$tag . '_' . $level]-1;
 					$current = &$current[$tag][$last_item_index];
 				}
-			} elseif ($type == "complete") { // Tags that ends in 1 line '<tag />'
+			} elseif ($type == 'complete') { // Tags that ends in 1 line '<tag />'
 				//See if the key is already taken.
 				if (!isset($current[$tag])) { //New Key
 					$current[$tag] = $result;
-					$repeated_tag_index[$tag.'_'.$level] = 1;
+					$repeated_tag_index[$tag . '_' . $level] = 1;
 					if ($priority == 'tag' and $attributes_data) {
 						$current[$tag. '_attr'] = $attributes_data;
 					}
@@ -388,15 +389,15 @@ class XML
 					if (isset($current[$tag][0]) and is_array($current[$tag])) { // If it is already an array...
 
 						// ...push the new element into that array.
-						$current[$tag][$repeated_tag_index[$tag.'_'.$level]] = $result;
+						$current[$tag][$repeated_tag_index[$tag . '_' . $level]] = $result;
 
 						if ($priority == 'tag' and $get_attributes and $attributes_data) {
-							$current[$tag][$repeated_tag_index[$tag.'_'.$level] . '_attr'] = $attributes_data;
+							$current[$tag][$repeated_tag_index[$tag . '_' . $level] . '_attr'] = $attributes_data;
 						}
-						$repeated_tag_index[$tag.'_'.$level]++;
+						$repeated_tag_index[$tag . '_' . $level]++;
 					} else { // If it is not an array...
-						$current[$tag] = [$current[$tag], $result]; //...Make it an array using using the existing value and the new value
-						$repeated_tag_index[$tag.'_'.$level] = 1;
+						$current[$tag] = [$current[$tag], $result]; //...Make it an array 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
 
@@ -405,10 +406,10 @@ class XML
 							}
 
 							if ($attributes_data) {
-								$current[$tag][$repeated_tag_index[$tag.'_'.$level] . '_attr'] = $attributes_data;
+								$current[$tag][$repeated_tag_index[$tag . '_' . $level] . '_attr'] = $attributes_data;
 							}
 						}
-						$repeated_tag_index[$tag.'_'.$level]++; // 0 and 1 indexes are already taken
+						$repeated_tag_index[$tag . '_' . $level]++; // 0 and 1 indexes are already taken
 					}
 				}
 			} elseif ($type == 'close') { // End of tag '</tag>'
@@ -439,7 +440,7 @@ class XML
 	 * Parse XML string
 	 *
 	 * @param string  $s XML string to parse into object
-	 * @param boolean $suppress_log Whether to supressing logging
+	 * @param boolean $suppress_log Whether to suppressing logging
 	 * @return SimpleXMLElement|bool SimpleXMLElement or false on failure
 	 */
 	public static function parseString(string $s, bool $suppress_log = false)
@@ -449,9 +450,9 @@ class XML
 		$x = @simplexml_load_string($s);
 		if (!$x) {
 			if (!$suppress_log) {
-				Logger::error('Error(s) while parsing XML string.', ['callstack' => System::callstack()]);
+				Logger::error('Error(s) while parsing XML string.');
 				foreach (libxml_get_errors() as $err) {
-					Logger::info('libxml error', ['code' => $err->code, 'position' => $err->line . ":" . $err->column, 'message' => $err->message]);
+					Logger::info('libxml error', ['code' => $err->code, 'position' => $err->line . ':' . $err->column, 'message' => $err->message]);
 				}
 				Logger::debug('Erroring XML string', ['xml' => $s]);
 			}
@@ -534,7 +535,7 @@ class XML
 	 *
 	 * @param string $str
 	 * @return string Escaped text.
-	 * @todo Move this generic method to Util\Strings and also rewrite all other findingd
+	 * @todo Move this generic method to Util\Strings and also rewrite all other occurrences
 	 */
 	public static function escape(string $str): string
 	{
@@ -546,7 +547,7 @@ class XML
 	 *
 	 * @param string $s xml escaped text
 	 * @return string unescaped text
-	 * @todo Move this generic method to Util\Strings and also rewrite all other findingd
+	 * @todo Move this generic method to Util\Strings and also rewrite all other occurrences
 	 */
 	public static function unescape(string $s): string
 	{