Completed
Pull Request — v1 (#422)
by
unknown
03:17
created

XmlResponseHandler   A

Complexity

Total Complexity 8

Size/Duplication

Total Lines 83
Duplicated Lines 10.84 %

Coupling/Cohesion

Components 1
Dependencies 2

Test Coverage

Coverage 87.5%

Importance

Changes 4
Bugs 1 Features 0
Metric Value
wmc 8
c 4
b 1
f 0
lcom 1
cbo 2
dl 9
loc 83
ccs 28
cts 32
cp 0.875
rs 10

4 Methods

Rating   Name   Duplication   Size   Complexity  
A addTraceToOutput() 9 9 2
A handle() 0 13 1
B addDataToNode() 0 24 4
A toXml() 0 8 1

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

1
<?php
2
/**
3
 * Whoops - php errors for cool kids
4
 * @author Filipe Dobreira <http://github.com/filp>
5
 */
6
7
namespace Whoops\Handler;
8
9
use SimpleXMLElement;
10
use Whoops\Exception\Formatter;
11
12
/**
13
 * Catches an exception and converts it to an XML
14
 * response. Additionally can also return exception
15
 * frames for consumption by an API.
16
 */
17
class XmlResponseHandler extends Handler
18
{
19
    /**
20
     * @var bool
21
     */
22
    private $returnFrames = false;
23
24
    /**
25
     * @param  bool|null  $returnFrames
26
     * @return bool|$this
27
     */
28 1 View Code Duplication
    public function addTraceToOutput($returnFrames = null)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
29
    {
30 1
        if (func_num_args() == 0) {
31 1
            return $this->returnFrames;
32
        }
33
34
        $this->returnFrames = (bool) $returnFrames;
35
        return $this;
36
    }
37
38
    /**
39
     * @return int
40
     */
41 1
    public function handle()
42
    {
43
        $response = array(
44 1
            'error' => Formatter::formatExceptionAsDataArray(
45 1
                $this->getInspector(),
46 1
                $this->addTraceToOutput()
0 ignored issues
show
Bug introduced by
It seems like $this->addTraceToOutput() targeting Whoops\Handler\XmlRespon...ler::addTraceToOutput() can also be of type this<Whoops\Handler\XmlResponseHandler>; however, Whoops\Exception\Formatt...tExceptionAsDataArray() does only seem to accept boolean, maybe add an additional type check?

This check looks at variables that are passed out again to other methods.

If the outgoing method call has stricter type requirements than the method itself, an issue is raised.

An additional type check may prevent trouble.

Loading history...
47 1
            ),
48 1
        );
49
50 1
        echo $this->toXml($response);
51
52 1
        return Handler::QUIT;
53
    }
54
55
    /**
56
     * @param  SimpleXMLElement  $node Node to append data to, will be modified in place
57
     * @param  array|Traversable $data
58
     * @return SimpleXMLElement  The modified node, for chaining
59
     */
60 1
    private static function addDataToNode(\SimpleXMLElement $node, $data)
61
    {
62 1
        assert('is_array($data) || $node instanceof Traversable');
63
64 1
        foreach ($data as $key => $value) {
65 1
            if (is_numeric($key)) {
66
                // Convert the key to a valid string
67
                $key = "unknownNode_". (string) $key;
68
            }
69
70
            // Delete any char not allowed in XML element names
71 1
            $key = preg_replace('/[^a-z0-9\-\_\.\:]/i', '', $key);
72
73 1
            if (is_array($value)) {
74 1
                $child = $node->addChild($key);
75 1
                self::addDataToNode($child, $value);
76 1
            } else {
77 1
                $value = str_replace('&', '&amp;', print_r($value, true));
78 1
                $node->addChild($key, $value);
79
            }
80 1
        }
81
82 1
        return $node;
83
    }
84
85
    /**
86
     * The main function for converting to an XML document.
87
     *
88
     * @param  array|Traversable $data
89
     * @return string            XML
90
     */
91 1
    private static function toXml($data)
92
    {
93 1
        assert('is_array($data) || $node instanceof Traversable');
94
95 1
        $node = simplexml_load_string("<?xml version='1.0' encoding='utf-8'?><root />");
96
97 1
        return self::addDataToNode($node, $data)->asXML();
98
    }
99
}
100