Runner::sendResponseCode() - Code Metrics - Inspection of "Adds response code sending in runner" - slickframework/error-handler - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 6a6271...1ab0b5 )

by Filipe

created 2024-08-24 17:59 UTC

Runner::sendResponseCode() A

↳ Parent: Runner

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/**
 * This file is part of error-handler
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Slick\ErrorHandler;

use ErrorException;
use Slick\ErrorHandler\Exception\ExceptionInspector;
use Slick\ErrorHandler\Handler\HandlerInterface;
use Slick\ErrorHandler\Util\SystemFacade;
use Throwable;

/**
 * Runner
 *
 * @package Slick\ErrorHandler
 */
final class Runner implements RunnerInterface
{

    /** @var array<callable|HandlerInterface> */
    private array $handlers = [];

    public function __construct(private readonly SystemFacade $system, private readonly ?string $path = '/')
    {
    }

    /**
     * @inheritDoc
     */
    public function pushHandler(callable|HandlerInterface $handler): self
    {
        $this->handlers[] = $handler;
        return $this;
    }

    /**
     * @inheritDoc
     */
    public function getHandlers(): array
    {
        return $this->handlers;
    }

    /**
     * @inheritDoc
     */
    public function clearHandlers(): self
    {
        $this->handlers = [];
        return $this;
    }

    /**
     * @inheritDoc
     */
    public function register(): self
    {
        $this->system->setExceptionHandler([$this, 'handleException']);
        $this->system->setErrorHandler([$this, 'handleError']);
        $this->system->registerShutdownFunction([$this, 'handleShutdown']);
        return $this;
    }

    /**
     * @inheritDoc
     */
    public function unregister(): self
    {
        $this->system->restoreExceptionHandler();
        $this->system->restoreErrorHandler();
        return $this;
    }

    /**
     * @inheritDoc
     */
    public function handleException(Throwable $exception): string
    {
        $inspector = new ExceptionInspector($exception, $this->path);
        $inspector = new ExceptionInspector($exception, /** @scrutinizer ignore-type */ $this->path);
        $this->system->startOutputBuffering();
        // Just in case there are no handlers:
        $handlerResponse = null;

        try {
            foreach (array_reverse($this->handlers) as $handler) {
                $handlerResponse = is_callable($handler)
                    ? $handler($exception, $inspector, $this)
                    : $handler->handle($exception, $inspector, $this);

                if (in_array($handlerResponse, [HandlerInterface::LAST_HANDLER, HandlerInterface::QUIT])) {
                    break;
                }
            }
        } finally {
            $output = $this->system->cleanOutputBuffer();
        }

        if ($handlerResponse === HandlerInterface::QUIT) {
            // Cleanup all other output buffers before sending our output:
            while ($this->system->getOutputBufferLevel() > 0) {
                $this->system->endOutputBuffering();
            }

            echo $output;
            $this->system->flushOutputBuffer();
            $this->system->stopExecution(1);
        }

        return is_string($output) ? $output : '';

    }

    /**
     * @inheritDoc
     */
    public function handleError(int $level, string $message, ?string $file = null, ?int $line = null): bool
    {
        $shouldHandle = $level & $this->system->getErrorReportingLevel();
        if (!($shouldHandle)) {
            // Propagate error to the next handler, allows error_get_last() to
            // work on silenced errors.
            return false;
        }

        $exception = new ErrorException($this->clearMessage($message), 0, $level, $file, $line);
        $this->handleException($exception);
        return true;
    }

    /**
     * @inheritDoc
     */
    public function handleShutdown(): void
    {
        $error = $this->system->getLastError();
        if ($error && $this->isLevelFatal($error['type'])) {
            $this->handleError($error['type'], $error['message'], $error['file'], $error['line']);
        }
    }

    /**
     * Determine if an error level is fatal (halts execution)
     *
     * @param int $level
     * @return bool
     */
    private function isLevelFatal($level): bool
    {
        $errors = E_ERROR;
        $errors |= E_PARSE;
        $errors |= E_CORE_ERROR;
        $errors |= E_CORE_WARNING;
        $errors |= E_COMPILE_ERROR;
        $errors |= E_COMPILE_WARNING;
        return ($level & $errors) > 0;
    }

    /**
     * @inheritDoc
     * @param array<string, string> $headers
     */
    public function outputHeaders(array $headers): void
    {
        $this->system->sendHeaders($headers);
    }

    public function sendResponseCode(int $code): void
    {
        $this->system->setHttpResponseCode($code);
    }

    private function clearMessage(string $message): string
    {
        $parts = explode("in /", $message, 2);
        return trim($parts[0]);
    }
}


slickframework / error-handler

Push — main ( 6a6271...1ab0b5 )

Runner::sendResponseCode() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like