Download the PHP package mixerapi/exception-render without Composer
On this page you can find all versions of the php package mixerapi/exception-render. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mixerapi/exception-render
More information about mixerapi/exception-render
Files in mixerapi/exception-render
Package exception-render
Short Description Handles rendering entity validation errors and other exceptions for your API
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package exception-render
MixerAPI ExceptionRender
This plugin handles rendering entity validation errors and other exceptions for your API.
- Integrates with Validator on
add()andedit()actions. - Adds the short name of the Exception thrown to the response
Read more at MixerAPI.com.
Installation
!!! tip "" You can skip this step if you have MixerApi installed.
Alternatively after composer installing you can manually load the plugin in your Application:
Setup
In your config/app.php file change the default exceptionRenderer:
Usage
Define your Validations as normal in your Table classes and MixerApiExceptionRenderer handles the rest by attaching
a listener to the afterMarshall event which fires
when request data is merged into entities during patchEntity() or newEntity() calls. If a validation fails then a
ValidationException is thrown and rendered with an HTTP 422 status code.
Example controller action:
Output:
Using the controller example from above, we can catch the exception if desired and perform additional logic:
Exceptions
For non-validation based exceptions, even your projects own custom exceptions, the output is similar to CakePHP native
output with the addition of an exception attribute. For example, a MethodNotAllowedException would result in:
If for instance you have a custom exception that is thrown, such as InventoryExceededException, you would see:
Providing an Exception name, in conjunction with the status code already provided by CakePHP, enables API clients to tailor their exception handling.
Disabling ValidationExceptions
There may be times when you don't want ValidationExceptions to run. You can easily disable the event:
Another example is you may only want the event to run for non-CLI portions of your application:
Changing Error Messages
ExceptionRender dispatches a MixerApi.ExceptionRender.beforeRender event that you can listen for to alter viewVars
and serialize variables. Both are accessible via the MixerApi\ExceptionRender\ErrorDecorator.
Example:
Read more about Events in the official CakePHP documentation.
