Download the PHP package gsousadev/laravel-problem-detail-exceptions-lib without Composer
On this page you can find all versions of the php package gsousadev/laravel-problem-detail-exceptions-lib. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download gsousadev/laravel-problem-detail-exceptions-lib
More information about gsousadev/laravel-problem-detail-exceptions-lib
Files in gsousadev/laravel-problem-detail-exceptions-lib
Package laravel-problem-detail-exceptions-lib
Short Description Pacote feito para padronizar o uso de exceptions com o formato de 'problem details'
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 laravel-problem-detail-exceptions-lib
Laravel Problem Detail Exceptions
Esse projeto tem por objetivo prover uma biblioteca Laravel que permite implementar de maneira simples e rápida um padrão de exceptions, seguindo os conceitos da RFC de problem details
Instalação
O pacote pode ser instalado usando Composer:
Após a instalação é necessário publicar os arquivos de configuração do pacote. Use o comando abaixo para isso:
Após a publicação do pacote deve ser criado um arquivo de configuração para o projeto no seguinte caminho: /config/problem-detail-exceptions.php.
Configurando
Este pacote permite algumas configurações de customização. Para isso deve-se user o arquivo problem-detail-exceptions.php
Para ter dados coerentes dentro do fluxo é importante ter duas variáveis de ambiente implementadas:
- PROBLEM_DETAIL_EXCEPTION_APP_NAME : Indica o nome que pode aparecer nos logs referente ao nome do projeto ou app que o pacote esta sendo usado.
- PROBLEM_DETAIL_EXCEPTION_GENERATE_LOGS : Esta variável permite que sejam ligados e desligados os logs que devem ser publicados em casos de erro.
Ex:
Existe também uma configuração que pode ser feita dentro do arquivo de configuração, informando quais campos devem ser considerados para exceptions de APIs
Existir duas configurações possíveis: Campos que devem ser usados em qualquer contexto chamado fields e campos que devem ser mostrados em chamadas HTTP como resposta em casos de erro renderable_fields.
Obs: NÃO RECOMENDAMOS o uso de todos os campos disponíveis, nas respostas HTTP, pois alguns campos podem ter informaçÕes que devem ser guardadas em segurança de não devem ser disponíveis para qualquer pessoa.
Todos os campos devem ser cadastrados de acordo com uma classe de Enum, que esta localizada tambem no projeto.
Os campos disponíveis estão dentro do Enum a seguir:
Criando Exceptions Customizadas
Para usar o pacote recomendamos que sejam criadas excessões extendendo da classe Gsousadev\LaravelProblemDetailExceptions\Exceptions\ProblemDetailException conforme a classe de exemplo abaixo:
Em seguida devemos criar dentro do construtor uma chamada para o construtor da classe Pai passando os parâmetros necessários para a construção da exception.
O resultado final deve ser algo como o exemplo abaixo
Desta maneira é possível ter uma exception bem legível, completa e com uma forma de invocação simples e direta
Log por Exception
Tambem é possível configurar o log em cada exception usando a opção $logThrow. Essa opção permite que possamos
configurar cada excessão para gerar logs, ou não, independente da configuração geral. Caso ela seja omitida a
configuração geral de logs será levada em consideração.
Ex:
Padronizando Exceptions de maneira Automática
Existe uma classe que pode ser usada em conjunto com o Handler de Exceptions do Laravel para permitir que todas as
exceptions lançadas e que passem pelo handler possam ser transformadas e normalizadas no padrão 'Problem Detail'.
Isso permite que a aplicação que tenham excetions em formatos diferentes possa rapidamente padronizar a saida dessas
exceptions para Logs e Requisições HTTP. Geralmente o arquivo de Handler do laravel esta localizado aqui
App\Exceptions\Handler.php. Podemos implementar a classe conforme o exemplo abaixo:
Contribuindo
O projeto esta em fase de construção e apontamentos de melhorias são muito importantes para o crescimento. Para sugerir uma melhoria use as Issues do github.
