Download the PHP package pccomponentes/apixception-bundle without Composer
On this page you can find all versions of the php package pccomponentes/apixception-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download pccomponentes/apixception-bundle
More information about pccomponentes/apixception-bundle
Files in pccomponentes/apixception-bundle
Package apixception-bundle
Short Description Bundle to handle and render custom exceptions in API-Style projects using symfony kernel events.
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 apixception-bundle
Pccomponentes Apixception bundle
El objetivo de esta librería es ofrecer una pequeña ayuda al programador a la hora de renderizar las excepciones que llegan al controlador, como respuestas del API.
Está integrado usando el evento Kernel.exception del Kernel de Symfony Framework v4.
Las respuestas serán en formato JSON (Symfony\Component\HttpFoundation\JsonResponse).
Instalación
-
Descarga e instala el vendor usando composer.
-
Añade el bundle en
config\bundles.php. Por ejemplo: -
Escribe el fichero de configuración del bundle indicando las excepciones que deseas capturar, y su transformación para generar la respuesta. Para ello, crea un archivo con nombre
apixception.yamlen la rutaconfig/packages. Un ejemplo de su contenido es:Este archivo se modificará para añadir o quitar las reglas que sean necesarias para el proyecto en el que se use.
Configuración
Este archivo debe contener un listado de reglas. Cada regla debe tener:
exception: Nombre de la clase o interface, namespace incluído, que representa el tipo de la excepción que se quiere capturar.http_code: Código HTTP que devolverá el objetoSymfony\Component\HttpFoundation\JsonResponse.transformer: Clase con namespace incluído, que transformará la excepción en un array de datos serializables por el objetoSymfony\Component\HttpFoundation\JsonResponse.
Creación de un nuevo transformador
Aunque la aplicación proporciona un par de transformadores básicos, está abierto para que cada proyecto pueda inyectar sus propios transformadores.
Las excepción deben implementar la interfaz \Throwable o de heredar de clases que ya lo hagan.
Los transformadores son clases que deben heredar de la clase PcComponentes\Apixception\Core\Transformer\ExceptionTransformer.
Por cuestiones de simplicidad, no se permite inyectar dependencias, así que heredar de esta clase implica tener un constructor vacío y contener lógica de transformación ligera.
Un ejemplo de un transformador propio sería:
Si llegara una excepción personalizada, con métodos únicos, puedes usarlas. Asegúrate que en la configuración garantice que a tu transformador sólo llegan excepciones del tipo que esperas, o haz que tu transformador actúe en consecuencia.
Transformadores disponibles
La librería proporciona dos transformadores que puedes usar desde el primer momento.
PcComponentes\Apixception\Core\Transformer\NoSerializableTransformer: Este transformador es capaz de renderizar cualquier tipo de excepción. En la respuesta meterá un objeto JSON con las propiedadesexceptioncon el nombre de la excepción, ymessage, con el mensaje de la excepción.PcComponentes\Apixception\Core\Transformer\JsonSerializableTransformer: Este transformador será capaz de renderizar cualquier excepción que implemente la interfaz\JsonSerializable. El array que devuelva dicho método, será lo que se incluya en la respuesta.
Excepciones
Como se ha comentado anteriormente, esta librería acepta excepciones de todo tipo.
