XmlResponseHandler::contentType() - Code Metrics - filp/whoops - Measure and Improve Code Quality continuously with Scrutinizer

XmlResponseHandler::contentType() A
last analyzed 2021-06-04 17:23 UTC

↳ Parent: XmlResponseHandler

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	1

<?php
/**
 * Whoops - php errors for cool kids
 * @author Filipe Dobreira <http://github.com/filp>
 */

namespace Whoops\Handler;

use SimpleXMLElement;
use Whoops\Exception\Formatter;

/**
 * Catches an exception and converts it to an XML
 * response. Additionally can also return exception
 * frames for consumption by an API.
 */
class XmlResponseHandler extends Handler
{
    /**
     * @var bool
     */
    private $returnFrames = false;

    /**
     * @param  bool|null  $returnFrames
     * @return bool|static
     */
    public function addTraceToOutput($returnFrames = null)

    {
        if (func_num_args() == 0) {
            return $this->returnFrames;
        }

        $this->returnFrames = (bool) $returnFrames;
        return $this;
    }

    /**
     * @return int
     */
    public function handle()
    {
        $response = [
            'error' => Formatter::formatExceptionAsDataArray(
                $this->getInspector(),
                $this->addTraceToOutput()

            ),
        ];

        echo self::toXml($response);

        return Handler::QUIT;
    }

    /**
     * @return string
     */
    public function contentType()
    {
        return 'application/xml';
    }

    /**
     * @param  SimpleXMLElement  $node Node to append data to, will be modified in place
     * @param  array|\Traversable $data
     * @return SimpleXMLElement  The modified node, for chaining
     */
    private static function addDataToNode(\SimpleXMLElement $node, $data)
    {
        assert(is_array($data) || $data instanceof Traversable);
if ($x instanceof DoesNotExist) {
    // Do something.
}

        foreach ($data as $key => $value) {
            if (is_numeric($key)) {
                // Convert the key to a valid string
                $key = "unknownNode_". (string) $key;
            }

            // Delete any char not allowed in XML element names
            $key = preg_replace('/[^a-z0-9\-\_\.\:]/i', '', $key);

            if (is_array($value)) {
                $child = $node->addChild($key);
                self::addDataToNode($child, $value);
            } else {
                $value = str_replace('&', '&amp;', print_r($value, true));
                $node->addChild($key, $value);
            }
        }

        return $node;
    }

    /**
     * The main function for converting to an XML document.
     *
     * @param  array|\Traversable $data
     * @return string            XML
     */
    private static function toXml($data)
    {
        assert(is_array($data) || $data instanceof Traversable);
if ($x instanceof DoesNotExist) {
    // Do something.
}

        $node = simplexml_load_string("<?xml version='1.0' encoding='utf-8'?><root />");

        return self::addDataToNode($node, $data)->asXML();
    }
}


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\|static
27			*/
28	1	View Code Duplication	public function addTraceToOutput($returnFrames = null)
			0 ignored issues – show Duplication introduced 2017-08-02 13:14 UTC by Report Bug Copy Issue Report 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 = [
44	1		'error' => Formatter::formatExceptionAsDataArray(
45	1		$this->getInspector(),
46	1		$this->addTraceToOutput()
			0 ignored issues – show Bug introduced 2015-11-21 13:08 UTC by Report Bug Copy Issue Report 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 self::toXml($response);
51
52	1		return Handler::QUIT;
53			}
54
55			/**
56			* @return string
57			*/
58	1		public function contentType()
59			{
60	1		return 'application/xml';
61			}
62
63			/**
64			* @param SimpleXMLElement $node Node to append data to, will be modified in place
65			* @param array\|\Traversable $data
66			* @return SimpleXMLElement The modified node, for chaining
67			*/
68	1		private static function addDataToNode(\SimpleXMLElement $node, $data)
69			{
70	1		assert(is_array($data) \|\| $data instanceof Traversable);
			0 ignored issues – show Bug introduced 2017-12-01 09:23 UTC by Report Bug Copy Issue Report The class `Whoops\Handler\Traversable` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
71
72	1		foreach ($data as $key => $value) {
73	1		if (is_numeric($key)) {
74			// Convert the key to a valid string
75			$key = "unknownNode_". (string) $key;
76			}
77
78			// Delete any char not allowed in XML element names
79	1		$key = preg_replace('/[^a-z0-9\-\_\.\:]/i', '', $key);
80
81	1		if (is_array($value)) {
82	1		$child = $node->addChild($key);
83	1		self::addDataToNode($child, $value);
84	1		} else {
85	1		$value = str_replace('&', '&', print_r($value, true));
86	1		$node->addChild($key, $value);
87			}
88	1		}
89
90	1		return $node;
91			}
92
93			/**
94			* The main function for converting to an XML document.
95			*
96			* @param array\|\Traversable $data
97			* @return string XML
98			*/
99	1		private static function toXml($data)
100			{
101	1		assert(is_array($data) \|\| $data instanceof Traversable);
			0 ignored issues – show Bug introduced 2017-12-01 09:21 UTC by Report Bug Copy Issue Report The class `Whoops\Handler\Traversable` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
102
103	1		$node = simplexml_load_string("<?xml version='1.0' encoding='utf-8'?><root />");
104
105	1		return self::addDataToNode($node, $data)->asXML();
106			}
107			}
108

filp / whoops

XmlResponseHandler::contentType() A last analyzed 2021-06-04 17:23 UTC

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like

XmlResponseHandler::contentType() A
last analyzed 2021-06-04 17:23 UTC