reusablecog/error-dictionary-bundle

1.0.0 2023-12-05 12:34 UTC

Requires

• symfony/config: ^6.0|^7.0
• symfony/dependency-injection: ^6.0|^7.0
• symfony/http-kernel: ^6.0|^7.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.37
• pedrotroller/php-cs-custom-fixer: ^2.33
• phpstan/extension-installer: ^1.3
• phpstan/phpstan: ^1.10
• phpstan/phpstan-strict-rules: ^1.5
• symfony/twig-bundle: ^6.0|^7.0

MIT

• Julien Blairy

README

Error Dictionary Bundle

The Error Dictionary Bundle is a Symfony bundle designed to simplify the generation of error management pages. It allows you to display error descriptions, associated codes, exceptions, and response codes by simply filling out a YAML configuration file.

Installation

You can install the ErrorDictionary using Composer:

composer require reusablecog/error-dictionary-bundle

Features

• Error Definition Configuration: Define error codes, labels, descriptions, categories, status codes, and associated exceptions in a YAML configuration file.
• Easy Integration: Seamlessly integrate error management pages into your Symfony project.

Usage

To use the Error Dictionary Bundle, you need to define error codes and their details in the configuration file. Here's an example:

#config/packages/error_dictionary.yaml
error_dictionary:
    error_definition:
        '999999':
            label: The resource was not found in database.
            description: The resource was not found in database.
            category: Home
            status_code: 404
            exception: ResourceNotFound
        '9E8302':
            label: Incorrect payload for the registration API.
            description: In the registration API all fields are required.
            category: Account
            status_code: 400
            exception: BadRequest

Versions

PHP version	Symfony version	Composer flags
>= 8.1	6.x / 7.x

Contributing

If you encounter any issues or would like to contribute to Error Dictionary Bundle, feel free to create a pull request or submit an issue on the GitHub repository.

License

The Error Dictionary Bundle is open-source software licensed under the MIT license.