OCA\Music\Http\XMLResponse

Complexity

Total Complexity

16

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	arrayIsIndexed()	0	3	2
B	addChildElement()	0	27	10
A	render()	0	9	2
A	__construct()	0	8	2

<?php

/**
 * 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 <pauli.jarvinen@gmail.com>
 * @copyright Pauli Järvinen 2019
 */

namespace OCA\Music\Http;

use OCP\AppFramework\Http\Response;

The type OCP\AppFramework\Http\Response was not found. Maybe you did not declare it correctly or list all dependencies?

/**
 * 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 may not be suitable for all other purposes.
 */
class XMLResponse extends Response {

	private $content;

	public function __construct(array $content) {
		$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;
	}

	public function render() {
		$rootName = \array_keys($this->content)[0];

		$xmlTree = new \SimpleXMLElement("<?xml version='1.0' encoding='UTF-8'?><$rootName/>");
		foreach ($this->content[$rootName] as $key => $value) {
			self::addChildElement($xmlTree, $key, $value);
		}

		return $xmlTree->asXML();
	}

	private static function addChildElement($parentNode, $key, $value) {
		if (\is_bool($value)) {
			$value = $value ? 'true' : 'false';
			$parentNode->addAttribute($key, $value);
		}
		elseif (\is_string($value) || \is_numeric($value)) {
			$parentNode->addAttribute($key, $value);
		}
		elseif (\is_array($value)) {
			if (self::arrayIsIndexed($value)) {
				foreach ($value as $child) {
					self::addChildElement($parentNode, $key, $child);
				}
			}
			else {
				// associative array
				$element = $parentNode->addChild($key);
				foreach ($value as $childKey => $childValue) {
					self::addChildElement($element, $childKey, $childValue);
				}
			}
		}
		elseif ($value === null) {
			// skip
		}
		else {
			throw new \Exception("Unexpected value type for key $key");
		}
	}

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