tinymeng/whoops

为酷 kids 设计的 PHP 错误处理

资助包维护!
denis-sokolov

2.7.3 2020-06-14 09:00 UTC

README

为酷 kids 设计的 PHP 错误

tinymeng 安装修改版本,兼容 QQ 邮箱 email

composer require tinymeng/whoops dev-master

Total Downloads Latest Version Build Status on newer versions Build Status on older 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的持续参与。