ExceptionRenderer::header() - Code Metrics - Inspection of "Improve unit tests for ExceptionRenderer" - abterphp/framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — html ( fbdc06...58a6c6 )

by Peter

created 2021-04-25 19:02 UTC

ExceptionRenderer::header() A

↳ Parent: ExceptionRenderer

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	3
c	0
b	0
f	0
nc	2
nop	3
dl	0
loc	6
rs	10

<?php

declare(strict_types=1);

namespace AbterPhp\Framework\Debug\Exceptions\Handlers\Whoops;

use Exception;
use Opulence\Framework\Debug\Exceptions\Handlers\Http;
use Opulence\Http\HttpException;
use Throwable;
use Whoops\RunInterface;

/**
 * @SuppressWarnings(PHPMD)
 */
class ExceptionRenderer extends Http\ExceptionRenderer implements Http\IExceptionRenderer
{
    public const HTML = <<< EOF
        <!DOCTYPE html>
        <html>
            <head>
                <meta name="viewport" content="initial-scale=1"/>
                <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/css/bootstrap.min.css"
                    integrity="sha384-Vkoo8x4CGsO3+Hhxv8T/Q5PaXtkKtu6ug5TOeNV6gBiFeWPGFN9MuhOf23Q9Ifjh"
                    crossorigin="anonymous">
            </head>
            <body>
                <main class="main">
                    <div class="container">
                        <div class="row">
                            <div class="col-sm">
                                <div class="alert alert-danger" role="alert">
                                    <h4 class="alert-heading">Exception: %s</h4>
                                    <p>%s</p>
                                    <hr>
                                    <p class="mb-0">
                                        <a href="#" class="btn btn-danger btn-lg active" role="button" aria-pressed="true"
                                        onclick="location.reload(); return false;">Try again</a>
                                        <a href="#" class="btn btn-primary btn-lg active" role="button" aria-pressed="true"
                                        onclick="window.history.back(); return false;">Back to previous page</a>
                                    </p>
                                </div>
                            </div>
                        </div>
                    </div>
                </main>
            </body>
        </html>
        EOF;

    protected array $headers = [];

    /** @var RunInterface */
    protected RunInterface $run;

    /**
     * @return bool
     */
    public function isInDevelopmentEnvironment(): bool
    {
        return $this->inDevelopmentEnvironment;
    }

    /**
     * @param bool $inDevelopmentEnvironment
     *
     * @return $this
     */
    public function setInDevelopmentEnvironment(bool $inDevelopmentEnvironment): self
    {
        $this->inDevelopmentEnvironment = $inDevelopmentEnvironment;

        return $this;
    }

    /**
     * WhoopsRenderer constructor.
     *
     * @param RunInterface $run
     * @param bool         $inDevelopmentEnvironment
     */
    public function __construct(RunInterface $run, bool $inDevelopmentEnvironment = false)
    {
        $this->run = $run;

        parent::__construct($inDevelopmentEnvironment);
    }

    /**
     * @return RunInterface
     */
    public function getRun(): RunInterface
    {
        return $this->run;
    }

    /**
     * Renders an exception
     *
     * @param Throwable|Exception $ex The thrown exception
     */
    public function render($ex): void
    {
        if (!$this->inDevelopmentEnvironment) {
            $this->run->writeToOutput(false);

            $this->run->unregister();

            $this->devRender($ex);

            return;
        }

        $this->run->handleException($ex);
    }

    /**
     * @param Exception $ex
     */
    public function devRender(Exception $ex): void
    {
        // Add support for HTTP library without having to necessarily depend on it
        $statusCode = 500;
        $headers    = [];
        if ($ex instanceof HttpException) {
            $statusCode = $ex->getStatusCode();
            $headers    = $ex->getHeaders();
        }

        switch ($this->getRequestFormat()) {
            case 'json':
                $headers['Content-Type'] = 'application/json';
                break;
            default:
                $content                 = sprintf(

                    self::HTML,
                    get_class($ex),
                    $ex->getMessage()
                );
                $headers['Content-Type'] = 'text/html';
        }

        $this->devRenderHeaders($headers, $statusCode);

        // Always get the content, even if headers are sent, so that we can unit test this
        echo $ex->getMessage();

        // To prevent any potential output buffering, let's flush
        flush();
    }

    /**
     * @param array $headers
     * @param int   $statusCode
     */
    protected function devRenderHeaders(array $headers, int $statusCode): void
    {
        $this->header("HTTP/1.1 $statusCode", true, $statusCode);

        foreach ($headers as $name => $values) {
            $values = (array)$values;

            foreach ($values as $value) {
                $this->header("$name:$value", false);
            }
        }
    }

    /**
     * @param string   $header
     * @param bool     $replace
     * @param int|null $responseCode
     */
    protected function header(string $header, bool $replace = true, ?int $responseCode = null): void
    {
        $this->headers[] = [$header, $replace, $responseCode];

        if (!headers_sent()) {
            header($header, $replace, $responseCode);
            header($header, $replace, /** @scrutinizer ignore-type */ $responseCode);
        }
    }

    /**
     * @return array
     */
    public function getHeaders(): array
    {
        return $this->headers;
    }
}


abterphp / framework

Push — html ( fbdc06...58a6c6 )

ExceptionRenderer::header() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like