Download the PHP package visualweber/error-handler-custom without Composer

ErrorHandlerCustom

Introduction

ErrorHandlerCustom is a module for Error Logging (DB and Mail) your ZF2, ZF3 Mvc Application, and ZF Expressive for Exceptions in 'dispatch.error' or 'render.error' or during request and response, and PHP E_* Error.

Features

• [x] Save to DB with Db Writer Adapter.
• [x] Log Exception (dispatch.error and render.error) and PHP Errors in all events process.
• [x] Support excludes PHP E_* Error (eg: exclude E_USER_DEPRECATED) in config settings.
• [x] Support excludes PHP Exception (eg: Exception class or classes that extends it) in config settings.
• [x] Handle only once log error for same error per configured time range.
• [x] Set default page (web access) or default message (console access) for error if configured 'display_errors' = 0.
• [x] Set default content when request is XMLHttpRequest via 'ajax' configuration.
• [x] Provide request information ( http method, raw data, query data, files data, and cookie data ).
• [x] Send Mail
  • [x] many receivers to listed configured email
  • [x] with include $_FILES into attachments on upload error.

Installation

1. Import the following SQL for Mysql

If you use other RDBMS, you may follow the log table structure above.

2. Setup your Zend\Db\Adapter\Adapter service or your Doctrine\ORM\EntityManager service config

You can use 'db' (with Zend\Db) config or 'doctrine' (with DoctrineORMModule) config that will be converted to be usable with Zend\Log\Writer\Db.

OR

If you use other RDBMS, you may configure your own db or doctrine config.

3. Require this module uses composer.

4. Copy config

a. For ZF2/ZF3 Mvc application, copy error-handler-custom.local.php.dist config to your local's autoload and configure it

Or run copy command:

b. For ZF Expressive application, copy expressive-error-handler-custom.local.php.dist config to your local's autoload and configure it

Or run copy command:

When done, you can modify logger service named ErrorHandlerCustomLogger and error-handler-custom config in your's local config:

5. Lastly, enable it

a. For ZF Mvc application

b. For ZF Expressive application

You need to use Zend\ServiceManager for service container and Zend\View for template engine.

For zend-expressive-skeleton ^1.0, It's should already just works!

For zend-expressive-skeleton ^2.0, you need to open config/pipeline.php and add the ErrorHandlerCustom\Middleware\Expressive::class middleware after default ErrorHandler::class registration:

and also add error-preview routes in config/routes.php (optional) :

to enable error preview page. To disable error preview page, just remove it from routes.

Give it a try!

Web Access

You will get the following page if display_errors config is 0:

For production env, you can disable error-preview sample page with set ['error-handler-custom']['enable-error-preview-page'] to false.

Console Access

If you use zend-mvc v3, you need to have zendframework/zend-mvc-console in your vendor, if you don't have, you can install it via command:

You will get the following page if display_errors config is 0:

For production env, you can disable error-preview sample page with set ['error-handler-custom']['enable-error-preview-page'] to false.

For ZF Expressive, there is no default console implementation, so, if you want to apply it in your console in ZF Expressive, you may need to custom implementation error handler that utilize ErrorHandlerCustom\Handler\Logging service (see detailed usage at ErrorHandlerCustom\Middleware\Expressive class)

Contributing

Contributions are very welcome. Please read CONTRIBUTING.md