README

酷孩子们的PHP错误

whoops 是一个用于 PHP 的错误处理框架。它提供了一个美观的错误界面，帮助您调试您的网络项目，但本质上它是一个简单而强大的堆叠错误处理系统。

特性

• 灵活的基于堆栈的错误处理
• 独立库（目前）无依赖项要求
• 简单的 API 用于处理异常、跟踪框架及其数据
• 包括用于您的网络应用程序项目的美观的错误页面
• 包括直接在您的编辑器和 IDE 中打开引用文件的功能
• 包括不同响应格式（JSON、XML、SOAP）的处理程序
• 易于扩展和集成到现有库中
• 干净、结构良好、经过测试的代码库

赞助商

安装

如果您使用 Laravel 4、Laravel 5.5+ 或 Mezzio，您已经拥有了 Whoops。还有社区提供的说明，介绍如何将 Whoops 集成到 Silex 1、Silex 2、Phalcon、Laravel 3、Laravel 5、CakePHP 3、CakePHP 4、Zend 2、Zend 3、Yii 1、FuelPHP、Slim、Pimple、Laminas 或任何消耗 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 Campbell 和 Markus Staab 的持续参与。