fiesta/whoops

为酷孩子设计的PHP错误处理

2.0.0-alpha2 2015-12-15 12:27 UTC

README

为酷孩子设计的PHP错误

Total Downloads Latest Version Reference Status Dependency Status Build Status Scrutinizer Quality Score Code Coverage

Whoops!

whoops 是一个PHP错误处理框架。它自带一个美观的错误界面,帮助您调试Web项目,但本质上是一个简单而强大的错误处理系统。

主要版本升级

这是即将推出的Whoops 2版本的相关文档。 目前它处于预发布状态,可以通过单独的 预发布下载标签 获取。有关稳定版本的文档,请参阅 分支 v1

特性

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

安装

如果您使用Laravel 4,您已经拥有Whoops。还有社区提供的如何将Whoops集成到 Silex 1Silex 2PhalconLaravel 3Laravel 5CakePHP 2CakePHP 3Zend Framework 2Yii 1FuelPHPSlimPimple 或任何使用 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\Handler 命名空间中

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

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

作者

此库主要由Filipe Dobreira开发,并由Denis Sokolov维护。许多优秀的修复和增强也由多位贡献者提供。