XmlResponse::generateNode() - Code Metrics - Inspection of "Feature formbuilder" - FloKnapp/faulancer - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Pull Request — master (#19)

by Flo

created 2017-06-14 12:05 UTC

XmlResponse::generateNode() B

↳ Parent: XmlResponse

Complexity

Conditions	5
Paths	3

Size

Total Lines	22
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
dl	0
loc	22
rs	8.6737
c	1
b	1
f	0
cc	5
eloc	11
nc	3
nop	3

<?php
/**
 * Class XmlResponse | XmlResponse.php
 * @package Faulancer\Http
 * @author  Florian Knapp <[email protected]>
 */
namespace Faulancer\Http;

/**
 * Class XmlResponse
 */
class XmlResponse extends Response
{

    /** @var array  */
    protected $content = [];

    /**
     * @param array             $data
     * @param \SimpleXMLElement $xml
     * @codeCoverageIgnore
     */
    private function convertArrayToXml(\SimpleXMLElement &$xml, $data)
    {
        foreach ($data as $key=>$value) {

            if(is_numeric($key)) {
                $key = 'item' . $key;
            }

            if(is_array($value['value'])) {

                $node = $this->generateNode($xml, $key, $value);
                $this->convertArrayToXml($node, $value['value']);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}

            } else {
                $this->generateNode($xml, $key, $value);
            }

        }
    }

    /**
     * @param \SimpleXMLElement $xml
     * @param string            $key
     * @param null|array        $value
     * @return null|\SimpleXMLElement
     * @codeCoverageIgnore
     */
    private function generateNode(\SimpleXMLElement &$xml, $key, $value = null)
    {
        $node = null;

        if (is_array($value) && in_array('@attributes', array_keys($value))) {

            $attributes = $value['@attributes'];

            if (!is_array($value['value'])) {
                $node = $xml->addChild($key, htmlspecialchars($value['value']));
            } else {
                $node = $xml->addChild($key);
            }

            foreach ($attributes as $attr => $val) {
                $node->addAttribute($attr, $val);
            }

        }

        return $node;
    }

    /**
     * @param array $content
     * @return self
     * @codeCoverageIgnore
     */
    public function setContent($content = [])
    {
        $this->setResponseHeader(['Content-Base' => 'text/xml']);

        $xml = new \SimpleXMLElement('<?xml version="1.0"?><root></root>');
        $this->convertArrayToXml($xml, $content);
        $result = $xml->asXml();

        $this->content = $result;

        return $this;
    }

}

1			<?php
2			/**
3			* Class XmlResponse \| XmlResponse.php
4			* @package Faulancer\Http
5			* @author Florian Knapp <[email protected]>
6			*/
7			namespace Faulancer\Http;
8
9			/**
10			* Class XmlResponse
11			*/
12			class XmlResponse extends Response
13			{
14
15			/** @var array */
16			protected $content = [];
17
18			/**
19			* @param array $data
20			* @param \SimpleXMLElement $xml
21			* @codeCoverageIgnore
22			*/
23			private function convertArrayToXml(\SimpleXMLElement &$xml, $data)
24			{
25			foreach ($data as $key=>$value) {
26
27			if(is_numeric($key)) {
28			$key = 'item' . $key;
29			}
30
31			if(is_array($value['value'])) {
32
33			$node = $this->generateNode($xml, $key, $value);
34			$this->convertArrayToXml($node, $value['value']);
			0 ignored issues – show Bug introduced 2017-06-07 21:14 UTC by Report Bug Copy Issue Report It seems like `$node` defined by `$this->generateNode($xml, $key, $value)` on line `33` can be `null`; however, `Faulancer\Http\XmlResponse::convertArrayToXml()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
35
36			} else {
37			$this->generateNode($xml, $key, $value);
38			}
39
40			}
41			}
42
43			/**
44			* @param \SimpleXMLElement $xml
45			* @param string $key
46			* @param null\|array $value
47			* @return null\|\SimpleXMLElement
48			* @codeCoverageIgnore
49			*/
50			private function generateNode(\SimpleXMLElement &$xml, $key, $value = null)
51			{
52			$node = null;
53
54			if (is_array($value) && in_array('@attributes', array_keys($value))) {
55
56			$attributes = $value['@attributes'];
57
58			if (!is_array($value['value'])) {
59			$node = $xml->addChild($key, htmlspecialchars($value['value']));
60			} else {
61			$node = $xml->addChild($key);
62			}
63
64			foreach ($attributes as $attr => $val) {
65			$node->addAttribute($attr, $val);
66			}
67
68			}
69
70			return $node;
71			}
72
73			/**
74			* @param array $content
75			* @return self
76			* @codeCoverageIgnore
77			*/
78			public function setContent($content = [])
79			{
80			$this->setResponseHeader(['Content-Base' => 'text/xml']);
81
82			$xml = new \SimpleXMLElement('<?xml version="1.0"?><root></root>');
83			$this->convertArrayToXml($xml, $content);
84			$result = $xml->asXml();
85
86			$this->content = $result;
			0 ignored issues – show Documentation Bug introduced 2017-06-07 21:14 UTC by Report Bug Copy Issue Report It seems like `$result` of type `string` or `false` is incompatible with the declared type `array` of property `$content`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
87			return $this;
88			}
89
90			}

FloKnapp / faulancer

Pull Request — master (#19)

XmlResponse::generateNode() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like