lighty/whoops

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

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

README

PHP错误处理,专为酷孩子设计

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

Whoops!

whoops 是一个用于 PHP 的错误处理框架。它自带一个精美的错误界面,可以帮助您调试您的网络项目,但核心是一个简单而强大的错误处理系统。

主要版本升级

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

功能

  • 灵活的基于堆栈的错误处理
  • 独立库,(目前) 无需依赖
  • 简单的 API 用于处理异常、跟踪帧及其数据
  • 包含一个精美的错误页面,适用于您的网络应用项目
  • 可以直接在您的编辑器和 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维护。许多出色的修复和增强也由各种贡献者提供。