spatie/symfony-ignition-bundle

A beautiful error page for Symfony apps

1.1.0 2023-12-16 17:16 UTC

Requires

• php: ^8.1
• spatie/ignition: ^1.0
• symfony/config: ^5.4 || ^6.0 || ^7.0
• symfony/dependency-injection: ^5.4 || ^6.3 || ^7.0
• symfony/event-dispatcher: ^5.4 || ^6.0 || ^7.0
• symfony/http-foundation: ^5.4 || ^6.0 || ^7.0
• symfony/http-kernel: ^5.4 || ^6.0 || ^7.0

Requires (Dev)

• phpunit/phpunit: ^9.5
• symfony/dom-crawler: ^5.4 || ^6.0 || ^7.0
• symfony/filesystem: ^5.4 || ^6.0 || ^7.0
• symfony/process: ^5.4 || ^6.0 || ^7.0

MIT

• Andrew MacRobert
• Freek Van der Herten

• spatie
• symfony-ignition-bundle

README

Ignition is a beautiful and customizable error page for PHP applications

Using this bundle, you can replace Symfony's default exception pages with Ignition.

This is what how the Ignition looks like in the browser.

There's also a beautiful dark mode.

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer:

composer require --dev spatie/symfony-ignition-bundle

Enable the bundle in config/bundles.php:

 return [
     // ...
+    Spatie\SymfonyIgnitionBundle\IgnitionBundle::class => ['dev' => true],
 ];

Configuration

Use bin/console debug:config ignition to see configuration options.

config/packages/ignition.yaml:

when@dev:
    ignition:
        application_path: '%kernel.project_dir%'
        dark_mode: false
        should_display_exception: '%kernel.debug%'
        # if you want AI solutions to your app's errors
        openai_key: 'key-here'

Usage

When you now throw an exception anywhere in your app...

class IndexController extends AbstractController
{
    #[Route('/', name: 'index')]
    public function index(): Response
    {
        throw new Exception('Hello Ignition!');
    }
}

... you'll see a beautiful error page.

To learn all the options that Ignition provides, including error reporting to Flare, head over to the readme of spatie/ignition.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Andrew MacRobert
• Freek Van der Herten
• All Contributors

License

The MIT License (MIT). Please see License File for more information.