MikoPBX\Common\Providers\WhoopsErrorHandlerProvider

Complexity

Total Complexity

6

Size/Duplication

Total Lines	65
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	makePrettyErrorDescription()	0	11	2
A	handleModuleException()	0	5	1
A	register()	0	19	3

<?php
/*
 * MikoPBX - free phone system for small business
 * Copyright © 2017-2023 Alexey Portnov and Nikolay Beketov
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with this program.
 * If not, see <https://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace MikoPBX\Common\Providers;


use MikoPBX\Modules\PbxExtensionUtils;
use Throwable;
use Whoops\Handler\JsonResponseHandler;
use Whoops\Handler\PlainTextHandler;
use Whoops\Handler\PrettyPageHandler;
use Whoops\Run;
use Whoops;
use Phalcon\Di\DiInterface;
use Phalcon\Di\ServiceProviderInterface;
/**
 * Registers whoops error handler service provider.
 *
 * @package MikoPBX\Common\Providers
 */
class WhoopsErrorHandlerProvider implements ServiceProviderInterface
{
    public const SERVICE_NAME = 'whoopsErrorHandler';

    /**
     * Registers whoops error handler service provider
     *
     * @param DiInterface $di The DI container.
     */
    public function register(DiInterface $di): void
    {
        $di->set(
            self::SERVICE_NAME,
            function () {
                $whoops = new Run();
                $whoops->pushHandler(function ($exception, $inspector, $run) {
                    return WhoopsErrorHandlerProvider::handleModuleException($exception, $inspector, $run);
                });
                if (Whoops\Util\Misc::isAjaxRequest()) {
                    $handler = new JsonResponseHandler();
                } elseif (Whoops\Util\Misc::isCommandLine()) {
                    $handler = new PlainTextHandler();
                } else {
                    $handler = new PrettyPageHandler();
                }
                $whoops->appendHandler($handler);
                $whoops->register();
                return $whoops;
            }
        );
    }

    /**
     * Handles a Whoops exception and disables the corresponding module.
     *
     * @param Throwable $exception The exception to handle.
     * @param Whoops\Exception\Inspector $inspector The Inspector instance.
     * @param Run $run The Run instance.
     * @return int The Whoops handler status.
     */
    private static function handleModuleException($exception, $inspector, $run): int

The parameter $run is not used and could be removed.

The parameter $inspector is not used and could be removed.

    {
        $exceptionFile = $exception->getFile();
        PbxExtensionUtils::disableBadModule($exceptionFile);
        return \Whoops\Handler\Handler::DONE;
    }

    /**
     * Generates an error description for a given exception.
     *
     * @param Throwable $exception The exception for which to generate the error description.
     * @param bool $jsonResult Indicates whether the error description should be in JSON format.
     * @return string The generated error description.
     */
    public static function makePrettyErrorDescription(Throwable $exception, bool $jsonResult = false): string
    {
        $whoops = new Run();
        if ($jsonResult) {
            $whoops->pushHandler(new JsonResponseHandler());
        } else {
            $whoops->pushHandler(new PlainTextHandler());
        }
        $whoops->register();
        $whoops->allowQuit(false);
        return $whoops->handleException($exception);
    }
}