XmlResponse::addChildElement() - Code Metrics - Inspection of "[WIP] Ampache API improvements" - owncloud/music - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#1078)

by Pauli

created 2023-08-29 19:41 UTC

XmlResponse::addChildElement() D

↳ Parent: XmlResponse

Complexity

Conditions	18
Paths	70

Size

Total Lines	43
Code Lines	33

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	18
eloc	33
nc	70
nop	4
dl	0
loc	43
rs	4.8666
c	1
b	0
f	0

How to fix Complexity

<?php declare(strict_types=1);

/**
 * ownCloud - Music app
 *
 * This file is licensed under the Affero General Public License version 3 or
 * later. See the COPYING file.
 *
 * @author Pauli Järvinen <[email protected]>
 * @copyright Pauli Järvinen 2019 - 2023
 */

namespace OCA\Music\Http;

use OCP\AppFramework\Http\Response;

/**
 * This class creates an XML response out of a passed in associative array,
 * similarly how the class JSONResponse works. The content is described with
 * a recursive array structure, where arrays may have string or integer keys.
 * One array should not mix string and integer keys, that will lead to undefined
 * outcome. Furthermore, array with integer keys is supported only as payload of
 * an array with string keys.
 *
 * Note that this response type has been created to fulfill the needs of the
 * SubsonicController and AmpacheController and may not be suitable for all other
 * purposes.
 */
class XmlResponse extends Response {
	private $content;
	private $doc;
	private $attributeKeys;
	private $boolAsInt;
	private $nullAsEmpty;
	private $textNodeKey;

	/**
	 * @param array $content
	 * @param bool|string[] $attributes If true, then key-value pair is made into attribute if possible.
	 *                                  If false, then key-value pairs are never made into attributes.
	 *                                  If an array, then keys found from the array are made into attributes if possible.
	 * @param bool $boolAsInt If true, any boolean values are yielded as int 0/1.
	 *                        If false, any boolean values are yielded as string "false"/"true".
	 * @param bool $nullAsEmpty If true, any null values are converted to empty strings, and the result has an empty element or attribute.
	 *                          If false, any null-valued keys are are left out from the result.
	 * @param ?string $textNodeKey When a key within @a $content mathes this, the corresponding value is converted to a text node,
	 *                             instead of creating an element or attribute named by the key.
	 */
	public function __construct(array $content, /*mixed*/ $attributes=true,
								bool $boolAsInt=false, bool $nullAsEmpty=false,
								?string $textNodeKey='value') {
		$this->addHeader('Content-Type', 'application/xml');

		// The content must have exactly one root element, add one if necessary
		if (\count($content) != 1) {
			$content = ['root' => $content];
		}
		$this->content = $content;
		$this->doc = new \DOMDocument('1.0', 'UTF-8');
		$this->doc->formatOutput = true;
		$this->attributeKeys = $attributes;
		$this->boolAsInt = $boolAsInt;
		$this->nullAsEmpty = $nullAsEmpty;
		$this->textNodeKey = $textNodeKey;
	}

	public function render() {
		$rootName = \array_keys($this->content)[0];
		$this->addChildElement($this->doc, $rootName, $this->content[$rootName]);
		return $this->doc->saveXML();
	}

	private function addChildElement($parentNode, $key, $value, $allowAttribute=true) {
		if (\is_bool($value)) {
			if ($this->boolAsInt) {
				$value = $value ? '1' : '0';
			} else {
				$value = $value ? 'true' : 'false';
			}
		} elseif (\is_numeric($value)) {
			$value = (string)$value;
		} elseif ($value === null && $this->nullAsEmpty) {
			$value = '';
		}

		if (\is_string($value)) {
			if ($key == $this->textNodeKey) {
				$parentNode->appendChild($this->doc->createTextNode($value));
			} elseif ($allowAttribute && $this->keyMayDefineAttribute($key)) {
				$parentNode->setAttribute($key, $value);
			} else {
				$child = $this->doc->createElement($key);
				$child->appendChild($this->doc->createTextNode($value));
				$parentNode->appendChild($child);
			}
		} elseif (\is_array($value)) {
			if (self::arrayIsIndexed($value)) {
				foreach ($value as $child) {
					$this->addChildElement($parentNode, $key, $child, /*allowAttribute=*/false);
				}
			} else { // associative array
				$element = $this->doc->createElement($key);
				$parentNode->appendChild($element);
				foreach ($value as $childKey => $childValue) {
					$this->addChildElement($element, $childKey, $childValue);
				}
			}
		} elseif ($value instanceof \stdClass) {
			// empty element
			$element = $this->doc->createElement($key);
			$parentNode->appendChild($element);
		} elseif ($value === null) {
			// skip
		} else {
			throw new \Exception("Unexpected value type for key $key");
		}
	}

	private function keyMayDefineAttribute($key) {
		if (\is_array($this->attributeKeys)) {
			return \in_array($key, $this->attributeKeys);
		} else {
			return \boolval($this->attributeKeys);
		}
	}

	/**
	 * Array is considered to be "indexed" if its first element has numerical key.
	 * Empty array is considered to be "indexed".
	 * @param array $array
	 */
	private static function arrayIsIndexed(array $array) {
		\reset($array);
		return empty($array) || \is_int(\key($array));
	}
}


1			<?php declare(strict_types=1);
2
3			/**
4			* ownCloud - Music app
5			*
6			* This file is licensed under the Affero General Public License version 3 or
7			* later. See the COPYING file.
8			*
9			* @author Pauli Järvinen <[email protected]>
10			* @copyright Pauli Järvinen 2019 - 2023
11			*/
12
13			namespace OCA\Music\Http;
14
15			use OCP\AppFramework\Http\Response;
16
17			/**
18			* This class creates an XML response out of a passed in associative array,
19			* similarly how the class JSONResponse works. The content is described with
20			* a recursive array structure, where arrays may have string or integer keys.
21			* One array should not mix string and integer keys, that will lead to undefined
22			* outcome. Furthermore, array with integer keys is supported only as payload of
23			* an array with string keys.
24			*
25			* Note that this response type has been created to fulfill the needs of the
26			* SubsonicController and AmpacheController and may not be suitable for all other
27			* purposes.
28			*/
29			class XmlResponse extends Response {
30			private $content;
31			private $doc;
32			private $attributeKeys;
33			private $boolAsInt;
34			private $nullAsEmpty;
35			private $textNodeKey;
36
37			/**
38			* @param array $content
39			* @param bool\|string[] $attributes If true, then key-value pair is made into attribute if possible.
40			* If false, then key-value pairs are never made into attributes.
41			* If an array, then keys found from the array are made into attributes if possible.
42			* @param bool $boolAsInt If true, any boolean values are yielded as int 0/1.
43			* If false, any boolean values are yielded as string "false"/"true".
44			* @param bool $nullAsEmpty If true, any null values are converted to empty strings, and the result has an empty element or attribute.
45			* If false, any null-valued keys are are left out from the result.
46			* @param ?string $textNodeKey When a key within @a $content mathes this, the corresponding value is converted to a text node,
47			* instead of creating an element or attribute named by the key.
48			*/
49			public function __construct(array $content, /mixed/ $attributes=true,
50			bool $boolAsInt=false, bool $nullAsEmpty=false,
51			?string $textNodeKey='value') {
52			$this->addHeader('Content-Type', 'application/xml');
53
54			// The content must have exactly one root element, add one if necessary
55			if (\count($content) != 1) {
56			$content = ['root' => $content];
57			}
58			$this->content = $content;
59			$this->doc = new \DOMDocument('1.0', 'UTF-8');
60			$this->doc->formatOutput = true;
61			$this->attributeKeys = $attributes;
62			$this->boolAsInt = $boolAsInt;
63			$this->nullAsEmpty = $nullAsEmpty;
64			$this->textNodeKey = $textNodeKey;
65			}
66
67			public function render() {
68			$rootName = \array_keys($this->content)[0];
69			$this->addChildElement($this->doc, $rootName, $this->content[$rootName]);
70			return $this->doc->saveXML();
71			}
72
73			private function addChildElement($parentNode, $key, $value, $allowAttribute=true) {
74			if (\is_bool($value)) {
75			if ($this->boolAsInt) {
76			$value = $value ? '1' : '0';
77			} else {
78			$value = $value ? 'true' : 'false';
79			}
80			} elseif (\is_numeric($value)) {
81			$value = (string)$value;
82			} elseif ($value === null && $this->nullAsEmpty) {
83			$value = '';
84			}
85
86			if (\is_string($value)) {
87			if ($key == $this->textNodeKey) {
88			$parentNode->appendChild($this->doc->createTextNode($value));
89			} elseif ($allowAttribute && $this->keyMayDefineAttribute($key)) {
90			$parentNode->setAttribute($key, $value);
91			} else {
92			$child = $this->doc->createElement($key);
93			$child->appendChild($this->doc->createTextNode($value));
94			$parentNode->appendChild($child);
95			}
96			} elseif (\is_array($value)) {
97			if (self::arrayIsIndexed($value)) {
98			foreach ($value as $child) {
99			$this->addChildElement($parentNode, $key, $child, /allowAttribute=/false);
100			}
101			} else { // associative array
102			$element = $this->doc->createElement($key);
103			$parentNode->appendChild($element);
104			foreach ($value as $childKey => $childValue) {
105			$this->addChildElement($element, $childKey, $childValue);
106			}
107			}
108			} elseif ($value instanceof \stdClass) {
109			// empty element
110			$element = $this->doc->createElement($key);
111			$parentNode->appendChild($element);
112			} elseif ($value === null) {
113			// skip
114			} else {
115			throw new \Exception("Unexpected value type for key $key");
116			}
117			}
118
119			private function keyMayDefineAttribute($key) {
120			if (\is_array($this->attributeKeys)) {
121			return \in_array($key, $this->attributeKeys);
122			} else {
123			return \boolval($this->attributeKeys);
124			}
125			}
126
127			/**
128			* Array is considered to be "indexed" if its first element has numerical key.
129			* Empty array is considered to be "indexed".
130			* @param array $array
131			*/
132			private static function arrayIsIndexed(array $array) {
133			\reset($array);
134			return empty($array) \|\| \is_int(\key($array));
135			}
136			}
137

owncloud / music

Pull Request — master (#1078)

XmlResponse::addChildElement() D

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like