Download the PHP package phphd/exception-handler without Composer
On this page you can find all versions of the php package phphd/exception-handler. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package exception-handler
Exception Handler
🧰 PHP Exception Handler built on top of Symfony Messenger component. Provides middlewares that allow you to easily re-raise exceptions, chain them, or handle with a dedicated handler.
Installation 📥
-
Install via composer
- Enable the bundle in the
bundles.php
Configuration ⚒️
To leverage features of this bundle, you should add phd_exception_handler
middleware to the list:
The core principle of exception handling revolves around the idea that exceptions are dispatched to the corresponding bus to be handled. There must be one exception bus per one origin bus.
The exception bus name convention is straightforward: command.bus
exceptions are forwarded
into command.exception.bus
.
Currently, there are few exception handling middlewares provided.
Rethrowing unhandled
Middleware: phd_exception_rethrow_unhandled
In case if dispatched exception had not been handled it is rethrown back. The exception is considered as handled if handler returns a response, or throws another exception.
Exception chaining
Middleware: phd_exception_chaining
Implements automatic exceptions escalation logic with #[RaiseAs]
attribute.
Result filter
Middleware: phd_exception_result_filter
Filters out all null results of exception handlers.
Usage 🚀
Re-Raising Exceptions
The simplest use-case is defining #[RaiseAs]
attribute on your exception class:
In this example, any time NonWhiteListedUserException
is thrown from an underlying handler,
it will be raised as AccessDeniedHttpException
.
As you can see, there's required attribute bus option. Since some exceptions could be thrown from multiple different contexts (hence, different buses), it is required to explicitly specify the bus from which the particular exception must be raised, so that in other scenarios another exceptions could be escalated:
In this example, ImportLockedException
could be thrown either in http context (api.bus
), or in the mq consumer
context (consumer.bus
). Therefore, raised exceptions are different.
Manual Handling
The exception is dispatched down to your custom handlers, where you could either return a Response, throw a new
exception, or just log it and return null
so that exception will be re-thrown again.
If you would like to use the same exception handler for multiple exception buses, you can do so by adding multiple
#[AsMessageHandler]
attributes:
All versions of exception-handler with dependencies
symfony/messenger Version ^6.2 | ^7.0
symfony/string Version ^6.0 | ^7.0
symfony/polyfill-php83 Version ^1.31