anonymous//src/ExceptionHandlers/WhoopsThrowableHtmlHandler.php$1 - Code Metrics - Inspection of "Add use for exception code in HTTP responses." - limoncello-php-dist/application - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4a6283...7d3219 )

by Neomerx

created 2020-02-09 13:37 UTC

anonymous//src/ExceptionHandlers/WhoopsThrowableHtmlHandler.php$1 A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	15
Duplicated Lines	0 %

Coupling/Cohesion

Dependencies

Test Coverage

Coverage

100%

Importance

Changes

Metric	Value
wmc	1
cbo	2
dl	0
loc	15
ccs	3
cts	3
cp	1
rs	10
c	0
b	0
f	0

<?php declare(strict_types=1);

namespace Limoncello\Application\ExceptionHandlers;

/**
 * Copyright 2015-2019 [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\PrettyPageHandler;
use Whoops\Run;
use function call_user_func;

/**
 * @package Limoncello\Application
 *
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 */
class WhoopsThrowableHtmlHandler extends BaseThrowableHandler
{
    /**
     * @inheritdoc
     *
     * @SuppressWarnings(PHPMD.ElseExpression)
     */
    public function createResponse(Throwable $throwable, ContainerInterface $container): ThrowableResponseInterface
    {
        $message = 'Internal Server Error';

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

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

        $status = $throwable->getCode() > 0 ? $throwable->getCode() : static::DEFAULT_HTTP_ERROR_CODE;

        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 PrettyPageHandler();
            // without the line below Whoops is too smart and do not produce any output in tests
            $handler->handleUnconditionally(true);

            if ($exceptionDumper !== null) {
                $appSpecificDetails = call_user_func($exceptionDumper, $throwable, $container);
                $handler->addDataTable("$appName Details", $appSpecificDetails);
            }

            $handler->setPageTitle("Whoops! There was a problem with '$appName'.");
            $run->appendHandler($handler);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

            $html     = $run->handleException($throwable);
            $response = $this->createThrowableHtmlResponse($throwable, $html, $status);
<?php

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

    return false;
}
        } else {
            $response = $this->createThrowableTextResponse($throwable, $message, $status);
        }

        return $response;
    }
}


1		<?php declare(strict_types=1);
2
3		namespace Limoncello\Application\ExceptionHandlers;
4
5		/**
6		* Copyright 2015-2019 [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\PrettyPageHandler;
25		use Whoops\Run;
26		use function call_user_func;
27
28		/**
29		* @package Limoncello\Application
30		*
31		* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
32		*/
33		class WhoopsThrowableHtmlHandler extends BaseThrowableHandler
34		{
35		/**
36		* @inheritdoc
37		*
38		* @SuppressWarnings(PHPMD.ElseExpression)
39		*/
40		public function createResponse(Throwable $throwable, ContainerInterface $container): ThrowableResponseInterface
41		{
42		$message = 'Internal Server Error';
43
44		$this->logException($throwable, $container, $message);
45
46		list($isDebug, $appName, $exceptionDumper) = $this->getSettings($container);
47
48		$status = $throwable->getCode() > 0 ? $throwable->getCode() : static::DEFAULT_HTTP_ERROR_CODE;
49
50	3	if ($isDebug === true) {
51		$run = new Run();
52	3
53		// If these two options are not used it would work fine with PHP Unit and XDebug,
54	3	// however it produces output to console under PhpDbg. So we need a couple of
55		// tweaks to make it work predictably in both environments.
56	3	//
57		// this one forbids Whoops spilling output to console
58	3	$run->writeToOutput(false);
59	2	// by default after sending error to output Whoops stops execution
60		// as we want just generated output `string` we instruct not to halt
61		$run->allowQuit(false);
62
63		$handler = new PrettyPageHandler();
64		// without the line below Whoops is too smart and do not produce any output in tests
65		$handler->handleUnconditionally(true);
66	2
67		if ($exceptionDumper !== null) {
68		$appSpecificDetails = call_user_func($exceptionDumper, $throwable, $container);
69	2	$handler->addDataTable("$appName Details", $appSpecificDetails);
70		}
71	2
72		$handler->setPageTitle("Whoops! There was a problem with '$appName'.");
73	2	$run->appendHandler($handler);
		0 ignored issues – show Documentation introduced 2019-09-30 21:24 UTC by Report Bug Copy Issue Report `$handler` is of type `object<Whoops\Handler\PrettyPageHandler>`, but the function expects a `callable`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
74
75	2	$html = $run->handleException($throwable);
76	2	$response = $this->createThrowableHtmlResponse($throwable, $html, $status);
		0 ignored issues – show Security Bug introduced 2020-02-09 11:27 UTC by Report Bug Copy Issue Report It seems like `$html` defined by `$run->handleException($throwable)` on line `75` can also be of type `false`; however, `Limoncello\Application\E...ThrowableHtmlResponse()` 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...
77	2	} else {
78		$response = $this->createThrowableTextResponse($throwable, $message, $status);
79		}
80	2
81	2	return $response;
82		}
83		}
84

limoncello-php-dist / application

Push — master ( 4a6283...7d3219 )

anonymous//src/ExceptionHandlers/WhoopsThrowableHtmlHandler.php$1 A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

Duplication Side-by-Side

Filter issues like