README

Yii 友好异常

一个提供友好名称和可能解决方案的异常接口。错误处理器可以考虑该接口在错误屏幕上渲染额外信息。

要求

PHP 7.4 或更高版本。

安装

可以使用 Composer 安装此包

composer require yiisoft/friendly-exception

通用使用

实现友好异常

要使异常友好，需要此包并实现 FriendlyExceptionInterface

use Yiisoft\FriendlyException\FriendlyExceptionInterface;

class RequestTimeoutException extends \RuntimeException implements FriendlyExceptionInterface
{
    public function getName(): string
    {
        return 'Request timed out.';
    }
    
    public function getSolution(): ?string
    {
        return <<<'SOLUTION'
            Likely it is a result of resource request is not responding in a timely fashion. Try increasing timeout.
            SOLUTION;
    }
}

当返回解决方案时，请考虑以下最佳实践

尽可能使解决方案描述简短。
不要使用 HTML 标签。
使用简单 Markdown。

处理友好异常

要使您的异常处理器渲染友好异常

use Yiisoft\FriendlyException\FriendlyExceptionInterface;

class ThrowableHandler
{
    public function handle(\Throwable $t)
    {
        if ($t instanceof FriendlyExceptionInterface) {
            // additional handling
        }
        // regular handling
    }
}

不要忘记渲染 Markdown。

文档

内部

如果您需要帮助或有疑问，请访问 Yii 论坛。您还可以查看其他 Yii 社区资源。

许可

Yii 友好异常是自由软件。它根据 BSD 许可协议发布。有关更多信息，请参阅 LICENSE。

由 Yii 软件维护。

yiisoft / friendly-exception

维护者

详细信息

README

Yii 友好异常

要求

安装

通用使用

实现友好异常

处理友好异常

文档

许可

支持项目

关注更新