HalXmlRenderer::arrayToXml() - Code Metrics - blongden/hal - Measure and Improve Code Quality continuously with Scrutinizer

HalXmlRenderer::arrayToXml() C
last analyzed 2021-06-08 09:00 UTC

↳ Parent: HalXmlRenderer

Complexity

Conditions	12
Paths	9

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	32
rs	6.9666
c	0
b	0
f	0
cc	12
nc	9
nop	3

How to fix Complexity

<?php
/**
 * This file is part of the Hal library
 *
 * (c) Ben Longden <[email protected]
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @package Nocarrier
 */
namespace Nocarrier;

/**
 * HalXmlRenderer
 *
 * @uses HalRenderer
 * @package Nocarrier
 * @author Ben Longden <[email protected]>
 */
class HalXmlRenderer implements HalRenderer
{
    /**
     * Render.
     *
     * @param \Nocarrier\Hal $resource
     * @param bool $pretty
     * @return string
     */
    public function render(Hal $resource, $pretty, $encode = true)
    {
        $doc = new \SimpleXMLElement('<resource></resource>');
        if (!is_null($resource->getUri())) {
            $doc->addAttribute('href', $resource->getUri());
        }
        $this->linksForXml($doc, $resource->getLinks());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $this->arrayToXml($resource->getData(), $doc);

        foreach ($resource->getResources() as $rel => $resources) {
            $this->resourcesForXml($doc, $rel, $resources);
        }

        $dom = dom_import_simplexml($doc);
        if ($pretty) {
            $dom->ownerDocument->preserveWhiteSpace = false;
            $dom->ownerDocument->formatOutput = true;
        }

        return $dom->ownerDocument->saveXML();
    }

    /**
     * linksForXml
     *
     * Add links in hal+xml format to a SimpleXmlElement object.
     *
     * @param \SimpleXmlElement $doc
     * @param \Nocarrier\HalLinkContainer $links
     * @return void
     */
    protected function linksForXml(\SimpleXmlElement $doc, HalLinkContainer $links)
    {
        foreach ($links as $rel => $links) {
            foreach ($links as $link) {
                $element = $doc->addChild('link');
                $element->addAttribute('rel', $rel);
                $element->addAttribute('href', $link->getUri());
                foreach ($link->getAttributes() as $attribute => $value) {
                    $element->addAttribute($attribute, $value);
                }
            }
        }
    }

    /**
     * arrayToXml
     *
     * @param array $data
     * @param \SimpleXmlElement $element
     * @param mixed $parent
     * @access protected
     * @return void
     */
    protected function arrayToXml($data, \SimpleXmlElement $element, $parent = null)
    {
        foreach ($data as $key => $value) {
            if (is_array($value) || $value instanceof \Traversable) {
                if (!is_numeric($key)) {
                    if (count($value) > 0 && isset($value[0])) {
                        $this->arrayToXml($value, $element, $key);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
                    } else {
                        $subnode = $element->addChild($key);
                        $this->arrayToXml($value, $subnode, $key);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
                    }
                } else {
                    $subnode = $element->addChild($parent);
                    $this->arrayToXml($value, $subnode, $parent);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
                }
            } else {
                if (!is_numeric($key)) {
                    if (substr($key, 0, 1) === '@') {
                        $element->addAttribute(substr($key, 1), $value);
                    } elseif ($key === 'value' and count($data) === 1) {
                        $element[0] = $value;
                    } elseif (is_bool($value)) {
                        $element->addChild($key, intval($value));
                    } else {
                        $element->addChild($key, htmlspecialchars($value, ENT_QUOTES));
                    }
                } else {
                    $element->addChild($parent, htmlspecialchars($value, ENT_QUOTES));
                }
            }
        }
    }

    /**
     * resourcesForXml
     *
     * Add resources in hal+xml format (identified by $rel) to a
     * SimpleXmlElement object.
     *
     * @param \SimpleXmlElement $doc
     * @param mixed $rel
     * @param mixed $resources
     */
    protected function resourcesForXml(\SimpleXmlElement $doc, $rel, $resources)
    {
        if (!is_array($resources)) {
            $resources = array($resources);
        }

        foreach($resources as $resource) {

            $element = $doc->addChild('resource');
            $element->addAttribute('rel', $rel);

            if ($resource) {
                if (!is_null($resource->getUri())) {
                    $element->addAttribute('href', $resource->getUri());
                }

                $this->linksForXml($element, $resource->getLinks());

                foreach ($resource->getResources() as $innerRel => $innerRes) {
                    $this->resourcesForXml($element, $innerRel, $innerRes);
                }

                $this->arrayToXml($resource->getData(), $element);
            }
        }
    }
}


1			<?php
2			/**
3			* This file is part of the Hal library
4			*
5			* (c) Ben Longden <[email protected]
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*
10			* @package Nocarrier
11			*/
12			namespace Nocarrier;
13
14			/**
15			* HalXmlRenderer
16			*
17			* @uses HalRenderer
18			* @package Nocarrier
19			* @author Ben Longden <[email protected]>
20			*/
21			class HalXmlRenderer implements HalRenderer
22			{
23			/**
24			* Render.
25			*
26			* @param \Nocarrier\Hal $resource
27			* @param bool $pretty
28			* @return string
29			*/
30			public function render(Hal $resource, $pretty, $encode = true)
31			{
32			$doc = new \SimpleXMLElement('<resource></resource>');
33			if (!is_null($resource->getUri())) {
34			$doc->addAttribute('href', $resource->getUri());
35			}
36			$this->linksForXml($doc, $resource->getLinks());
			0 ignored issues – show Documentation introduced 2016-03-28 19:29 UTC by Report Bug Copy Issue Report `$resource->getLinks()` is of type `array`, but the function expects a `object<Nocarrier\HalLinkContainer>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
37
38			$this->arrayToXml($resource->getData(), $doc);
39
40			foreach ($resource->getResources() as $rel => $resources) {
41			$this->resourcesForXml($doc, $rel, $resources);
42			}
43
44			$dom = dom_import_simplexml($doc);
45			if ($pretty) {
46			$dom->ownerDocument->preserveWhiteSpace = false;
47			$dom->ownerDocument->formatOutput = true;
48			}
49
50			return $dom->ownerDocument->saveXML();
51			}
52
53			/**
54			* linksForXml
55			*
56			* Add links in hal+xml format to a SimpleXmlElement object.
57			*
58			* @param \SimpleXmlElement $doc
59			* @param \Nocarrier\HalLinkContainer $links
60			* @return void
61			*/
62			protected function linksForXml(\SimpleXmlElement $doc, HalLinkContainer $links)
63			{
64			foreach ($links as $rel => $links) {
65			foreach ($links as $link) {
66			$element = $doc->addChild('link');
67			$element->addAttribute('rel', $rel);
68			$element->addAttribute('href', $link->getUri());
69			foreach ($link->getAttributes() as $attribute => $value) {
70			$element->addAttribute($attribute, $value);
71			}
72			}
73			}
74			}
75
76			/**
77			* arrayToXml
78			*
79			* @param array $data
80			* @param \SimpleXmlElement $element
81			* @param mixed $parent
82			* @access protected
83			* @return void
84			*/
85			protected function arrayToXml($data, \SimpleXmlElement $element, $parent = null)
86			{
87			foreach ($data as $key => $value) {
88			if (is_array($value) \|\| $value instanceof \Traversable) {
89			if (!is_numeric($key)) {
90			if (count($value) > 0 && isset($value[0])) {
91			$this->arrayToXml($value, $element, $key);
			0 ignored issues – show Bug introduced 2016-03-28 19:29 UTC by Report Bug Copy Issue Report It seems like `$value` can also be of type `object<Traversable>`; however, `Nocarrier\HalXmlRenderer::arrayToXml()` does only seem to accept `array`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
92			} else {
93			$subnode = $element->addChild($key);
94			$this->arrayToXml($value, $subnode, $key);
			0 ignored issues – show Bug introduced 2016-03-28 19:29 UTC by Report Bug Copy Issue Report It seems like `$value` can also be of type `object<Traversable>`; however, `Nocarrier\HalXmlRenderer::arrayToXml()` does only seem to accept `array`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
95			}
96			} else {
97			$subnode = $element->addChild($parent);
98			$this->arrayToXml($value, $subnode, $parent);
			0 ignored issues – show Bug introduced 2016-03-28 19:29 UTC by Report Bug Copy Issue Report It seems like `$value` can also be of type `object<Traversable>`; however, `Nocarrier\HalXmlRenderer::arrayToXml()` does only seem to accept `array`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
99			}
100			} else {
101			if (!is_numeric($key)) {
102			if (substr($key, 0, 1) === '@') {
103			$element->addAttribute(substr($key, 1), $value);
104			} elseif ($key === 'value' and count($data) === 1) {
105			$element[0] = $value;
106			} elseif (is_bool($value)) {
107			$element->addChild($key, intval($value));
108			} else {
109			$element->addChild($key, htmlspecialchars($value, ENT_QUOTES));
110			}
111			} else {
112			$element->addChild($parent, htmlspecialchars($value, ENT_QUOTES));
113			}
114			}
115			}
116			}
117
118			/**
119			* resourcesForXml
120			*
121			* Add resources in hal+xml format (identified by $rel) to a
122			* SimpleXmlElement object.
123			*
124			* @param \SimpleXmlElement $doc
125			* @param mixed $rel
126			* @param mixed $resources
127			*/
128			protected function resourcesForXml(\SimpleXmlElement $doc, $rel, $resources)
129			{
130			if (!is_array($resources)) {
131			$resources = array($resources);
132			}
133
134			foreach($resources as $resource) {
135
136			$element = $doc->addChild('resource');
137			$element->addAttribute('rel', $rel);
138
139			if ($resource) {
140			if (!is_null($resource->getUri())) {
141			$element->addAttribute('href', $resource->getUri());
142			}
143
144			$this->linksForXml($element, $resource->getLinks());
145
146			foreach ($resource->getResources() as $innerRel => $innerRes) {
147			$this->resourcesForXml($element, $innerRel, $innerRes);
148			}
149
150			$this->arrayToXml($resource->getData(), $element);
151			}
152			}
153			}
154			}
155

blongden / hal

HalXmlRenderer::arrayToXml() C last analyzed 2021-06-08 09:00 UTC

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like

HalXmlRenderer::arrayToXml() C
last analyzed 2021-06-08 09:00 UTC