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

JsonResponseHandler::setJsonApi() A
last analyzed 2021-06-04 17:23 UTC

↳ Parent: JsonResponseHandler

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

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

namespace Whoops\Handler;

use Whoops\Exception\Formatter;

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

    /**
     * @var bool
     */
    private $jsonApi = false;

    /**
     * Returns errors[[]] instead of error[] to be in compliance with the json:api spec
     * @param bool $jsonApi Default is false
     * @return static
     */
    public function setJsonApi($jsonApi = false)
    {
        $this->jsonApi = (bool) $jsonApi;
        return $this;
    }

    /**
     * @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()
    {
        if ($this->jsonApi === true) {
            $response = [
                'errors' => [
                    Formatter::formatExceptionAsDataArray(
                        $this->getInspector(),
                        $this->addTraceToOutput()

                    ),
                ]
            ];
        } else {
            $response = [
                'error' => Formatter::formatExceptionAsDataArray(
                    $this->getInspector(),
                    $this->addTraceToOutput()

                ),
            ];
        }

        echo json_encode($response, defined('JSON_PARTIAL_OUTPUT_ON_ERROR') ? JSON_PARTIAL_OUTPUT_ON_ERROR : 0);

        return Handler::QUIT;
    }

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


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 Whoops\Exception\Formatter;
10
11			/**
12			* Catches an exception and converts it to a JSON
13			* response. Additionally can also return exception
14			* frames for consumption by an API.
15			*/
16			class JsonResponseHandler extends Handler
17			{
18			/**
19			* @var bool
20			*/
21			private $returnFrames = false;
22
23			/**
24			* @var bool
25			*/
26			private $jsonApi = false;
27
28			/**
29			* Returns errors[[]] instead of error[] to be in compliance with the json:api spec
30			* @param bool $jsonApi Default is false
31			* @return static
32			*/
33			public function setJsonApi($jsonApi = false)
34			{
35			$this->jsonApi = (bool) $jsonApi;
36			return $this;
37			}
38
39			/**
40			* @param bool\|null $returnFrames
41			* @return bool\|static
42			*/
43	3	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...
44			{
45	3		if (func_num_args() == 0) {
46	3		return $this->returnFrames;
47			}
48
49	3		$this->returnFrames = (bool) $returnFrames;
50	3		return $this;
51			}
52
53			/**
54			* @return int
55			*/
56	3		public function handle()
57			{
58	3		if ($this->jsonApi === true) {
59			$response = [
60			'errors' => [
61	1		Formatter::formatExceptionAsDataArray(
62	1		$this->getInspector(),
63	1		$this->addTraceToOutput()
			0 ignored issues – show Bug introduced 2017-04-20 21:35 UTC by Report Bug Copy Issue Report It seems like `$this->addTraceToOutput()` targeting `Whoops\Handler\JsonRespo...ler::addTraceToOutput()` can also be of type `this<Whoops\Handler\JsonResponseHandler>`; 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...
64	1		),
65			]
66	1		];
67	1		} else {
68			$response = [
69	2		'error' => Formatter::formatExceptionAsDataArray(
70	2		$this->getInspector(),
71	2		$this->addTraceToOutput()
			0 ignored issues – show Bug introduced 2017-04-20 21:35 UTC by Report Bug Copy Issue Report It seems like `$this->addTraceToOutput()` targeting `Whoops\Handler\JsonRespo...ler::addTraceToOutput()` can also be of type `this<Whoops\Handler\JsonResponseHandler>`; 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...
72	2		),
73	2		];
74			}
75
76	3		echo json_encode($response, defined('JSON_PARTIAL_OUTPUT_ON_ERROR') ? JSON_PARTIAL_OUTPUT_ON_ERROR : 0);
77
78	3		return Handler::QUIT;
79			}
80
81			/**
82			* @return string
83			*/
84			public function contentType()
85			{
86			return 'application/json';
87			}
88			}
89

filp / whoops

JsonResponseHandler::setJsonApi() A last analyzed 2021-06-04 17:23 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

JsonResponseHandler::setJsonApi() A
last analyzed 2021-06-04 17:23 UTC