jolicode/gif-exception-bundle

The GhostBuster of your exception page

1.4.1 2017-11-18 10:02 UTC

README

Latest Stable Version Total Downloads Build Status

The GhostBuster of your exception page!

It displays a GIF instead of Symfony's ghost on exception page:

Demo

It's compatible with Symfony versions from 2.7 to latest. Here is what it looks like with Symfony 3.3+:

Demo sf 3.3

Be aware that we can not be held responsible for any loss of productivity during development.

Installation

  • Use Composer to install GifExceptionBundle in your project:
composer require "jolicode/gif-exception-bundle"
  • Enable the bundle in dev environment:
    /**
     * {@inheritdoc}
     */
    public function registerBundles()
    {
        $bundles = [
            // ...
        ];

        if (in_array($this->getEnvironment(), array('dev', 'test'))) {
            // ...
            $bundles[] = new \Joli\GifExceptionBundle\GifExceptionBundle();
        }

        return $bundles;
    }
  • Then install the assets to make gifs accessible to public:
app/console assets:install

or for Symfony 3+ :

bin/console assets:install

Now enjoy your exceptions \o/

Add some more gifs!

We need you to improve the included GIFs! Do not hesitate to open PRs to add more gifs in Resources/public/images/, it will be very welcomed! 😉

Optimizing gifs

If you are adding gifs we strongly recommend optimizing them. There is a tool to aid with this (you will need to install gifsicle).

bin/optimizer.php

You can also run this from a Symfony project if you have this as an installed bundle via:

bin/console jolicode:gifexception:optimize

Although it would probably make more sense to use the former and push up the optimized gifs.

It uses gifsicle to optimize gifs via the image-optimizer library.

Further documentation

You can see the current and past versions using one of the following:

And some meta documentation:

Credits

License

GifExceptionBundle is licensed under the MIT License - see the LICENSE file for details.