eonx-com/easy-error-handler

Provides customizable ready-to-use error handler for applications

3.4.7 2021-10-15 03:24 UTC

This package is auto-updated.

Last update: 2021-10-15 03:26:54 UTC


README

---eonx_docs--- title: Introduction weight: 0 ---eonx_docs---

Introduction

The EasyErrorHandler package allows you to easily build informative HTTP responses and reports in response to exceptions in your applications.

Using the EasyErrorHandler package, you can:

  • Define a common structure for exceptions
  • Generate consistent error responses for unhandled exceptions within your code
  • Report exceptions to the main logging channel of your application (by default) or to custom destinations
  • Automatically notify Bugsnag based on the log level of the exception (by default, if used with easy-bugsnag)

Usage overview

The package will work with any PHP exception, but it provides several tailored Exceptions for common error conditions, e.g. 404 Not Found errors.

The ErrorHandler provides the main methods to build HTTP responses for exceptions and to report on exceptions (e.g. logging).

HTTP responses are built with error response builders. These builders progressively build the response body, status code and headers. You can implement your own error response builders. The HTTP response body is formatted as JSON by default, but you can implement your own formatter (see Response format).

Error reporters report on exceptions. The default error reporter logs to the main logging channel of your application, but you can implement custom error reporters, e.g. to send email.