filp/damnit

为酷 kids 设计的 PHP 错误处理

资助包维护!
denis-sokolov

安装: 208

依赖关系: 0

建议者: 0

安全性: 0

Stars: 13 172

关注者: 194

Forks: 602

公开问题: 6

2.15.4 2023-11-03 12:00 UTC

README

为酷 kids 设计的 PHP 错误

Total Downloads Latest Version Build Status on newer versions Scrutinizer Quality Score Code Coverage

Whoops!

whoops 是一个 PHP 错误处理框架。开箱即用,它提供了一个美观的错误界面,可以帮助您调试您的 Web 项目,但本质上它是一个简单而强大的堆叠错误处理系统。

特性

  • 灵活的基于堆栈的错误处理
  • 独立的库,目前没有必需的依赖项
  • 简单的 API 用于处理异常、跟踪框架及其数据
  • 包括一个美观的错误页面,适用于您的 Web 应用项目
  • 包括在您的编辑器和 IDE 中直接打开引用文件的能力
  • 包括不同响应格式(JSON、XML、SOAP)的处理程序
  • 易于扩展和与现有库集成
  • 干净、结构良好且经过测试的代码库

赞助商

Blackfire.io

安装

如果您使用 Laravel 4、Laravel 5.5+ 或 Mezzio,您已经拥有 Whoops。还有社区提供的说明,介绍如何将 Whoops 集成到 Silex 1Silex 2PhalconLaravel 3Laravel 5CakePHP 3CakePHP 4Zend 2Zend 3Yii 1FuelPHPSlimPimpleLaminas 或任何消耗 StackPHP 中间件PSR-7 中间件 的框架。

如果您不使用这些框架中的任何一个,这里有一个非常简单的安装方法

  1. 使用 Composer 将 Whoops 安装到您的项目中

    composer require filp/whoops
  2. 在您的代码中注册美观的处理程序

    $whoops = new \Whoops\Run;
    $whoops->pushHandler(new \Whoops\Handler\PrettyPageHandler);
    $whoops->register();

有关更多信息,请查看 examples/ 中的 示例文件 以了解事物的工作方式。还可以查看 API 文档 和以下可用的处理程序列表。

您还可以覆盖 Whoops 执行的一些系统调用。为此,扩展 Whoops\Util\SystemFacade,覆盖您想要的函数,并将其作为参数传递给 Run 构造函数。

您还可以收集生成的 HTML 以进行处理

$whoops = new \Whoops\Run;
$whoops->allowQuit(false);
$whoops->writeToOutput(false);
$whoops->pushHandler(new \Whoops\Handler\PrettyPageHandler);
$html = $whoops->handleException($e);

可用的处理程序

whoops 目前附带以下内置处理程序,位于 Whoops\Handler 命名空间中

  • PrettyPageHandler - 当出现问题时显示美观的错误页面
  • PlainTextHandler - 为 CLI 应用程序输出纯文本消息
  • CallbackHandler - 将闭包或其他可调用对象包装为处理器。您无需显式使用此处理器,whoops 将自动将您传递给 Whoops\Run::pushHandler 的任何闭包或可调用对象进行包装
  • JsonResponseHandler - 捕获异常,并以 JSON 字符串的形式返回相关信息。例如,可以用来与 AJAX 请求友好地交互
  • XmlResponseHandler - 捕获异常,并以 XML 字符串的形式返回相关信息。例如,可以用来与 AJAX 请求友好地交互

您还可以使用可插入的处理器,例如 SOAP 处理器

作者

该库主要由 Filipe Dobreira 开发,并由 Denis Sokolov 维护。许多优秀的修复和增强也来自 各种贡献者。特别感谢 Graham CampbellMarkus Staab 的持续参与。