<?php

declare(strict_types=1);
/**
 * This file is part of Hyperf.
 *
 * @link     https://www.hyperf.io
 * @document https://hyperf.wiki
 * @contact  group@hyperf.io
 * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
 */

namespace Hyperf\ExceptionHandler;

use Swow\Psr7\Message\ResponsePlusInterface;
use Throwable;

abstract class ExceptionHandler
{
    /**
     * Handle the exception, and return the specified result.
     */
    abstract public function handle(Throwable $throwable, ResponsePlusInterface $response);

    /**
     * Determine if the current exception handler should handle the exception.
     *
     * @see ExceptionHandler::stopPropagation() if you want to stop propagation after handling
     * an exception, as returning `true` in `isValid` does not stop the handlers call loop.
     *
     * @return bool If return true, then this exception handler will handle the exception and then call the next handler,
     *              If return false, this handler will be ignored and the next will be called
     */
    abstract public function isValid(Throwable $throwable): bool;

    /**
     * Stop propagate the exception to next handler.
     */
    public function stopPropagation(): bool
    {
        Propagation::instance()->setPropagationStopped(true);
        return true;
    }

    /**
     * Is propagation stopped ?
     * This will typically only be used by the handler to determine if the
     * previous handler halted propagation.
     */
    public function isPropagationStopped(): bool
    {
        return Propagation::instance()->isPropagationStopped();
    }
}