WhoopsThrowableTextHandler   A
last analyzed

Complexity

Total Complexity 3

Size/Duplication

Total Lines 41
Duplicated Lines 100 %

Coupling/Cohesion

Components 1
Dependencies 3

Test Coverage

Coverage 100%

Importance

Changes 0
Metric Value
wmc 3
lcom 1
cbo 3
dl 41
loc 41
ccs 11
cts 11
cp 1
rs 10
c 0
b 0
f 0

1 Method

Rating   Name   Duplication   Size   Complexity  
A createResponse() 33 33 3

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 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\PlainTextHandler;
25
use Whoops\Run;
26
27
/**
28
 * @package Limoncello\Application
29
 *
30
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
31
 */
32 View Code Duplication
class WhoopsThrowableTextHandler extends BaseThrowableHandler
0 ignored issues
show
Duplication introduced by
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 = '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 3
50
            // If these two options are not used it would work fine with PHP Unit and XDebug,
51 3
            // 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 3
            //
54
            // this one forbids Whoops spilling output to console
55 3
            $run->writeToOutput(false);
56 3
            // by default after sending error to output Whoops stops execution
57 2
            // as we want just generated output `string` we instruct not to halt
58
            $run->allowQuit(false);
59
60
            $handler = new PlainTextHandler();
61
            $handler->setException($throwable);
62
            $run->appendHandler($handler);
63
64 2
            $message = $run->handleException($throwable);
65
        }
66
67 2
        $status   = $throwable->getCode() > 0 ? $throwable->getCode() : static::DEFAULT_HTTP_ERROR_CODE;
68
        $response = $this->createThrowableTextResponse($throwable, $message, $status);
0 ignored issues
show
Security Bug introduced by
It seems like $message defined by $run->handleException($throwable) on line 64 can also be of type false; however, Limoncello\Application\E...ThrowableTextResponse() 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 2
70 2
        return $response;
71 2
    }
72
}
73