Response::message() - Code Metrics - Inspection of "Fixes #12: Gradually implement proper response han..." - AfriCC/php-epp2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#51)

by Günter

created 2017-04-27 12:56 UTC

Response::message() A

↳ Parent: Response

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php

/**
 * This file is part of the php-epp2 library.
 *
 * (c) Gunter Grodotzki <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE file
 * that was distributed with this source code.
 */

namespace AfriCC\EPP\Frame;

use AfriCC\EPP\AbstractFrame;
use AfriCC\EPP\Frame\Response\Result;
use DOMNode;
use DOMNodeList;

/**
 * @see http://tools.ietf.org/html/rfc5730#section-2.6
 */
class Response extends AbstractFrame
{
    /**
     * nodeToArray force array values for the following tags. Usually the upper
     * level will expect them as an array to traverse. Otherwise, if only one
     * value exists it will be converted directly to a string
     *
     * @var array
     */
    protected $n2a_force_array = [
        'hostAttr' => true,
        'hostObj' => true,
        'street' => true,
        'hostAddr' => true,
    ];

    /**
     * nodeToArray ignore conversion of following attributes. Usually because
     * the information is redundant or useless (like the definition of IP types
     * which should be done on the higher level)
     *
     * @var array
     */
    protected $n2a_ignore_attr = [
        'hostAddr' => true,
    ];

    public function results()
    {
        $results = [];
        $nodes = $this->get('//epp:epp/epp:response/epp:result');
        foreach ($nodes as $node) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            $results[] = new Result($node);
        }

        return $results;
    }

    public function success()
    {
        $code = $this->code();
        if ($code >= 1000 && $code < 2000) {
            return true;
        }

        return false;
    }

    public function code()
    {
        return (int) $this->get('//epp:epp/epp:response/epp:result/@code');
    }

    public function message()
    {
        return (string) $this->get('//epp:epp/epp:response/epp:result/epp:msg/text()');
    }

    public function clientTransactionId()
    {
        $value = $this->get('//epp:epp/epp:response/epp:trID/epp:clTRID/text()');
        if ($value === false) {
            return;
        }

        return (string) $value;
    }

    public function serverTransactionId()
    {
        $value = $this->get('//epp:epp/epp:response/epp:trID/epp:svTRID/text()');
        if ($value === false) {
            return;
        }

        return (string) $value;
    }

    public function data()
    {
        $nodes = $this->get('//epp:epp/epp:response/epp:resData');
        if ($nodes === false || !($nodes instanceof DOMNodeList) || $nodes->length === 0 || !$nodes->item(0)->hasChildNodes()) {
            $data = [];
        } else {
            $data = $this->nodeToArray($nodes->item(0));
        }

        // check for extension data
        $nodes = $this->get('//epp:epp/epp:response/epp:extension');
        if ($nodes !== false && $nodes instanceof DOMNodeList && $nodes->length > 0 && $nodes->item(0)->hasChildNodes()) {
            $data = array_merge_recursive($data, $this->nodeToArray($nodes->item(0)));
        }

        return $data;
    }

    private function nodeToArray(DOMNode $node)
    {
        $tmp = [];
        foreach ($node->childNodes as $each) {
            if ($each->nodeType !== XML_ELEMENT_NODE) {
                continue;
            }

            // if node only has a type attribute lets distinguish them directly
            // and then ignore the attribtue
            if ($each->hasAttribute('type')) {
                $key = $each->localName . '@' . $each->getAttribute('type');
                $ignore_attributes = true;
            } else {
                $key = $each->localName;
                $ignore_attributes = false;
            }

            // in case of special keys, always create array
            if (isset($this->n2a_force_array[$key])) {
                $current = &$tmp[$key][];
                end($tmp[$key]);
                $insert_key = key($tmp[$key]);
            }
            // if key already exists, dynamically create an array
            elseif (isset($tmp[$key])) {
                if (!is_array($tmp[$key]) || !isset($tmp[$key][0])) {
                    $tmp[$key] = [$tmp[$key]];
                }
                $current = &$tmp[$key][];
                end($tmp[$key]);
                $insert_key = key($tmp[$key]);
            }
            // key was not yet set, so lets start off with a string
            else {
                $current = &$tmp[$key];
                $insert_key = null;
            }

            if ($each->hasChildNodes()) {
                $current = $this->nodeToArray($each);
            } else {
                $current = $each->nodeValue;

                if (!$ignore_attributes && !isset($this->n2a_ignore_attr[$each->localName]) && $each->hasAttributes()) {
                    foreach ($each->attributes as $attr) {

                        // single attribute with empty node, use the attr-value directly
                        if ($each->localName === 'status' || ($each->attributes->length === 1 && $each->nodeValue === '')) {
                            $current = $attr->nodeValue;
                            break;
                        }

                        if ($insert_key) {
                            if (isset($tmp['@' . $key][$attr->nodeName]) && !is_array($tmp['@' . $key][$attr->nodeName])) {
                                $tmp['@' . $key][$attr->nodeName] = [$tmp['@' . $key][$attr->nodeName]];
                            }
                            $tmp['@' . $key][$attr->nodeName][$insert_key] = $attr->nodeValue;
                        } else {
                            $tmp['@' . $key][$attr->nodeName] = $attr->nodeValue;
                        }
                    }
                }
            }
        }

        return $tmp;
    }
}


1			<?php
2
3			/**
4			* This file is part of the php-epp2 library.
5			*
6			* (c) Gunter Grodotzki <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE file
9			* that was distributed with this source code.
10			*/
11
12			namespace AfriCC\EPP\Frame;
13
14			use AfriCC\EPP\AbstractFrame;
15			use AfriCC\EPP\Frame\Response\Result;
16			use DOMNode;
17			use DOMNodeList;
18
19			/**
20			* @see http://tools.ietf.org/html/rfc5730#section-2.6
21			*/
22			class Response extends AbstractFrame
23			{
24			/**
25			* nodeToArray force array values for the following tags. Usually the upper
26			* level will expect them as an array to traverse. Otherwise, if only one
27			* value exists it will be converted directly to a string
28			*
29			* @var array
30			*/
31			protected $n2a_force_array = [
32			'hostAttr' => true,
33			'hostObj' => true,
34			'street' => true,
35			'hostAddr' => true,
36			];
37
38			/**
39			* nodeToArray ignore conversion of following attributes. Usually because
40			* the information is redundant or useless (like the definition of IP types
41			* which should be done on the higher level)
42			*
43			* @var array
44			*/
45			protected $n2a_ignore_attr = [
46			'hostAddr' => true,
47			];
48
49			public function results()
50			{
51			$results = [];
52			$nodes = $this->get('//epp:epp/epp:response/epp:result');
53			foreach ($nodes as $node) {
			0 ignored issues – show Bug introduced 2017-04-27 12:58 UTC by Report Bug Copy Issue Report The expression `$nodes` of type `false\|string\|object<DOMNodeList>` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
54			$results[] = new Result($node);
55			}
56
57			return $results;
58			}
59
60			public function success()
61			{
62			$code = $this->code();
63			if ($code >= 1000 && $code < 2000) {
64			return true;
65			}
66
67			return false;
68			}
69
70			public function code()
71			{
72			return (int) $this->get('//epp:epp/epp:response/epp:result/@code');
73			}
74
75			public function message()
76			{
77			return (string) $this->get('//epp:epp/epp:response/epp:result/epp:msg/text()');
78			}
79
80			public function clientTransactionId()
81			{
82			$value = $this->get('//epp:epp/epp:response/epp:trID/epp:clTRID/text()');
83			if ($value === false) {
84			return;
85			}
86
87			return (string) $value;
88			}
89
90			public function serverTransactionId()
91			{
92			$value = $this->get('//epp:epp/epp:response/epp:trID/epp:svTRID/text()');
93			if ($value === false) {
94			return;
95			}
96
97			return (string) $value;
98			}
99
100			public function data()
101			{
102			$nodes = $this->get('//epp:epp/epp:response/epp:resData');
103			if ($nodes === false \|\| !($nodes instanceof DOMNodeList) \|\| $nodes->length === 0 \|\| !$nodes->item(0)->hasChildNodes()) {
104			$data = [];
105			} else {
106			$data = $this->nodeToArray($nodes->item(0));
107			}
108
109			// check for extension data
110			$nodes = $this->get('//epp:epp/epp:response/epp:extension');
111			if ($nodes !== false && $nodes instanceof DOMNodeList && $nodes->length > 0 && $nodes->item(0)->hasChildNodes()) {
112			$data = array_merge_recursive($data, $this->nodeToArray($nodes->item(0)));
113			}
114
115			return $data;
116			}
117
118			private function nodeToArray(DOMNode $node)
119			{
120			$tmp = [];
121			foreach ($node->childNodes as $each) {
122			if ($each->nodeType !== XML_ELEMENT_NODE) {
123			continue;
124			}
125
126			// if node only has a type attribute lets distinguish them directly
127			// and then ignore the attribtue
128			if ($each->hasAttribute('type')) {
129			$key = $each->localName . '@' . $each->getAttribute('type');
130			$ignore_attributes = true;
131			} else {
132			$key = $each->localName;
133			$ignore_attributes = false;
134			}
135
136			// in case of special keys, always create array
137			if (isset($this->n2a_force_array[$key])) {
138			$current = &$tmp[$key][];
139			end($tmp[$key]);
140			$insert_key = key($tmp[$key]);
141			}
142			// if key already exists, dynamically create an array
143			elseif (isset($tmp[$key])) {
144			if (!is_array($tmp[$key]) \|\| !isset($tmp[$key][0])) {
145			$tmp[$key] = [$tmp[$key]];
146			}
147			$current = &$tmp[$key][];
148			end($tmp[$key]);
149			$insert_key = key($tmp[$key]);
150			}
151			// key was not yet set, so lets start off with a string
152			else {
153			$current = &$tmp[$key];
154			$insert_key = null;
155			}
156
157			if ($each->hasChildNodes()) {
158			$current = $this->nodeToArray($each);
159			} else {
160			$current = $each->nodeValue;
161
162			if (!$ignore_attributes && !isset($this->n2a_ignore_attr[$each->localName]) && $each->hasAttributes()) {
163			foreach ($each->attributes as $attr) {
164
165			// single attribute with empty node, use the attr-value directly
166			if ($each->localName === 'status' \|\| ($each->attributes->length === 1 && $each->nodeValue === '')) {
167			$current = $attr->nodeValue;
168			break;
169			}
170
171			if ($insert_key) {
172			if (isset($tmp['@' . $key][$attr->nodeName]) && !is_array($tmp['@' . $key][$attr->nodeName])) {
173			$tmp['@' . $key][$attr->nodeName] = [$tmp['@' . $key][$attr->nodeName]];
174			}
175			$tmp['@' . $key][$attr->nodeName][$insert_key] = $attr->nodeValue;
176			} else {
177			$tmp['@' . $key][$attr->nodeName] = $attr->nodeValue;
178			}
179			}
180			}
181			}
182			}
183
184			return $tmp;
185			}
186			}
187

AfriCC / php-epp2

Pull Request — master (#51)

Response::message() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like