https://github.com/webfactory/exceptions-bundle
A bundle to ease development of custom, user-friendly Symfony2 error pages.
https://github.com/webfactory/exceptions-bundle
Last synced: 9 months ago
JSON representation
A bundle to ease development of custom, user-friendly Symfony2 error pages.
- Host: GitHub
- URL: https://github.com/webfactory/exceptions-bundle
- Owner: webfactory
- License: mit
- Created: 2014-02-13T14:56:24.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2024-04-02T12:43:30.000Z (over 1 year ago)
- Last Synced: 2025-01-29T22:06:59.579Z (10 months ago)
- Language: Twig
- Size: 145 KB
- Stars: 62
- Watchers: 13
- Forks: 15
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-symfony - WebfactoryExceptionsBundle - Easily develop custom, user-friendly error pages. (Development)
README
# WebfactoryExceptionsBundle
A Symfony Bundle with some Twig templates and blocks to create helpful, user friendly error pages.
⚠️ **Please note:** At webfactory, we do no longer use this bundle in new projects, since its main functionality was merged into Symfony 2.6 and we prefer to have project-specific templates. However, we still use the wording that we provide with this bundle.
## Basic Usage
First, follow the [Symfony Documentation](https://symfony.com/doc/current/controller/error_pages.html) to learn how to create and preview custom error pages. Been there, done that? Fine!
Let's say your generic error page extends the base layout of MyWebsiteBundle. Then you may want to have your
`error.html.twig` to look something like this:
{# error.html.twig #}
{% extends '@MyWebsite/Layout/base.html.twig' %}
{% use '@WebfactoryExceptions/Exception/blocks.html.twig' %}
{% block myMainContentContainer %}
{{ block('webfactory_exceptions_standardExceptionPage') }}
{% endblock %}
The `webfactory_exceptions_standardExceptionPage` block has headings, the translated exception description and provides
the user with a list of alternatives what they can do next: get back (simulating a browser back), get to the homepage,
get to the contact page or google the domain. It may look like this:
## Links to Homepage and Contact Page
A default block in the bundle provides a link to the homepage with the default target `/`. If your application does not
start at `/`, you need to set the variable `homepageUrl`.
Also, you may want to set the variable `contactUrl` to get a link to your contact page in the listed alternatives.
{# error.html.twig #}
{% extends '@MyWebsite/Layout/base.html.twig' %}
{% use '@WebfactoryExceptions/Exception/blocks.html.twig' %}
{% set homepageUrl = "https://www.webfactory.de" %}
{% set contactUrl = path('name_of_a_route') %}
{# your blocks and definitions... #}
## Filling in Blocks of Base Layouts
If your base layout already features blocks you need to fill with exception specific content, you can do it this way:
{# error.html.twig #}
{% extends '@MyWebsite/Layout/base.html.twig' %}
{% use '@WebfactoryExceptions/Exception/blocks.html.twig' with
webfactory_exceptions_error_title as title,
webfactory_exceptions_error_headline as stage_headline
%}
This loads the `webfactory_exceptions_error_title` block *directly* into the `title` block of your base layout, as well
as the `webfactory_exceptions_error_headline` block into the `stage_headline` block.
Happy error-styling!
## Credits, Copyright and License
This bundle was started at webfactory GmbH, Bonn. It was inspired by the blog post [How Symfony2 turns exceptions into error pages and how to customize those](https://www.webfactory.de/blog/symfony2-exception-handling-and-custom-error-pages-explained).
Previous releases of this bundle contained extra code that would help during development to preview your error pages. This code, however, could be merged into the Symfony core in Symfony 2.6, so we could finally remove it from this bundle. Read the [announcement](https://symfony.com/blog/new-in-symfony-2-6-error-page-previews) when you're interested in historic details.
-
-
Copyright 2012-2022 webfactory GmbH, Bonn. Code released under [the MIT license](LICENSE).