WhoopsThrowableJsonHandler::createResponse() - Code Metrics - limoncello-php-dist/application - Measure and Improve Code Quality continuously with Scrutinizer

WhoopsThrowableJsonHandler::createResponse() A
last analyzed 2020-02-09 15:57 UTC

↳ Parent: WhoopsThrowableJsonHandler

Complexity

Conditions	3
Paths	4

Size

Total Lines

Duplication

Lines	33
Ratio	100 %

Importance

Changes

Metric	Value
dl	33
loc	33
rs	9.392
c	0
b	0
f	0
cc	3
nc	4
nop	2

<?php declare(strict_types=1);

namespace Limoncello\Application\ExceptionHandlers;

/**
 * Copyright 2015-2020 [email protected]
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use Limoncello\Contracts\Http\ThrowableResponseInterface;
use Psr\Container\ContainerInterface;
use Throwable;
use Whoops\Handler\JsonResponseHandler;
use Whoops\Run;

/**
 * @package Limoncello\Application
 *
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 */
class WhoopsThrowableJsonHandler extends BaseThrowableHandler

{
    /**
     * @inheritdoc
     *
     * @SuppressWarnings(PHPMD.ElseExpression)
     */
    public function createResponse(Throwable $throwable, ContainerInterface $container): ThrowableResponseInterface
    {
        $message = '{"error":{"message":"Internal Server Error."}}';

        $this->logException($throwable, $container, $message);

        list($isDebug) = $this->getSettings($container);

        if ($isDebug === true) {
            $run = new Run();

            // If these two options are not used it would work fine with PHP Unit and XDebug,
            // however it produces output to console under PhpDbg. So we need a couple of
            // tweaks to make it work predictably in both environments.
            //
            // this one forbids Whoops spilling output to console
            $run->writeToOutput(false);
            // by default after sending error to output Whoops stops execution
            // as we want just generated output `string` we instruct not to halt
            $run->allowQuit(false);

            $handler = new JsonResponseHandler();
            $handler->setException($throwable);
            $run->appendHandler($handler);

            $message = $run->handleException($throwable);
        }

        $status   = $throwable->getCode() > 0 ? $throwable->getCode() : static::DEFAULT_HTTP_ERROR_CODE;
        $response = $this->createThrowableJsonResponse($throwable, $message, $status);
<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}

        return $response;
    }
}


1		<?php declare(strict_types=1);
2
3		namespace Limoncello\Application\ExceptionHandlers;
4
5		/**
6		* Copyright 2015-2020 [email protected]
7		*
8		* Licensed under the Apache License, Version 2.0 (the "License");
9		* you may not use this file except in compliance with the License.
10		* You may obtain a copy of the License at
11		*
12		* http://www.apache.org/licenses/LICENSE-2.0
13		*
14		* Unless required by applicable law or agreed to in writing, software
15		* distributed under the License is distributed on an "AS IS" BASIS,
16		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17		* See the License for the specific language governing permissions and
18		* limitations under the License.
19		*/
20
21		use Limoncello\Contracts\Http\ThrowableResponseInterface;
22		use Psr\Container\ContainerInterface;
23		use Throwable;
24		use Whoops\Handler\JsonResponseHandler;
25		use Whoops\Run;
26
27		/**
28		* @package Limoncello\Application
29		*
30		* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
31		*/
32	View Code Duplication	class WhoopsThrowableJsonHandler extends BaseThrowableHandler
		0 ignored issues – show Duplication introduced 2019-09-30 21:24 UTC by Report Bug Copy Issue Report This class 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...
33		{
34		/**
35		* @inheritdoc
36		*
37		* @SuppressWarnings(PHPMD.ElseExpression)
38		*/
39		public function createResponse(Throwable $throwable, ContainerInterface $container): ThrowableResponseInterface
40		{
41		$message = '{"error":{"message":"Internal Server Error."}}';
42
43		$this->logException($throwable, $container, $message);
44
45		list($isDebug) = $this->getSettings($container);
46
47		if ($isDebug === true) {
48		$run = new Run();
49
50		// If these two options are not used it would work fine with PHP Unit and XDebug,
51		// however it produces output to console under PhpDbg. So we need a couple of
52		// tweaks to make it work predictably in both environments.
53		//
54		// this one forbids Whoops spilling output to console
55		$run->writeToOutput(false);
56		// by default after sending error to output Whoops stops execution
57		// as we want just generated output `string` we instruct not to halt
58		$run->allowQuit(false);
59
60		$handler = new JsonResponseHandler();
61		$handler->setException($throwable);
62		$run->appendHandler($handler);
63
64		$message = $run->handleException($throwable);
65		}
66
67		$status = $throwable->getCode() > 0 ? $throwable->getCode() : static::DEFAULT_HTTP_ERROR_CODE;
68		$response = $this->createThrowableJsonResponse($throwable, $message, $status);
		0 ignored issues – show Security Bug introduced 2020-02-09 11:27 UTC by Report Bug Copy Issue Report It seems like `$message` defined by `$run->handleException($throwable)` on line `64` can also be of type `false`; however, `Limoncello\Application\E...ThrowableJsonResponse()` does only seem to accept `string`, did you maybe forget to handle an error condition? This check looks for type mismatches where the missing type is `false`. This is usually indicative of an error condtion. Consider the follow example <?php function getDate($date) { if ($date !== null) { return new DateTime($date); } return false; } This function either returns a new `DateTime` object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned `false` before passing on the value to another function or method that may not be able to handle a `false`. Loading history...
69
70		return $response;
71		}
72		}
73

limoncello-php-dist / application

WhoopsThrowableJsonHandler::createResponse() A last analyzed 2020-02-09 15:57 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

WhoopsThrowableJsonHandler::createResponse() A
last analyzed 2020-02-09 15:57 UTC