DO NOT USE YET, THIS PACKAGE IS IN DEVELOPMENT
Ignition: a beautiful error page for PHP apps
Ignition is a beautiful and customizable error page for PHP applications
Here's a minimal example.
use Spatie\Ignition\Ignition;
include 'vendor/autoload.php';
Ignition::make()->register();
throw new Exception('Bye world');
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 spatie/ignition
Usage
In order display the Ignition error page when an error occurs in your project, you must add this code. Typically, this would be done in the bootstrap part of your application.
\Spatie\Ignition\Ignition::make()->register();
Setting the application path
When setting the application path, Ignition will trim the given value from all paths. This will make the error page look more cleaner.
\Spatie\Ignition\Ignition::make()
->applicationPath($basePathOfYourApplication)
->register();
Using dark mode
By default, Ignition uses a nice white based them. If this is too bright for your eyes, you can use dark mode.
\Spatie\Ignition\Ignition::make()
->useDarkMode()
->register();
Avoid rendering Ignition in a production environment
You don't want to render the Ignition error page in a production environment, as it potentially can display sensitive information.
To avoid rendering Ignition, you can call shouldDisplayException and pass it a falsy value.
\Spatie\Ignition\Ignition::make()
->shouldDisplayException($inLocalEnvironment)
->register();
Displaying solutions
In addition to displaying an exception, Ignition can display a solution as well.
Out of the box, Ignition will display solutions for common errors such as bad methods calls, or using undefined properties.
Adding a solution directly to an exception
To add a solution text to your exception, let the exception implement the Spatie\IgnitionContracts\ProvidesSolution interface.
This interface requires you to implement one method, which is going to return the Solution that users will see when the exception gets thrown.
use Spatie\IgnitionContracts\Solution;
use Spatie\IgnitionContracts\ProvidesSolution;
class CustomException implements ProvidesSolution
{
public function getSolution(): Solution
{
return new CustomSolution();
}
}
use Spatie\IgnitionContracts\Solution;
class CustomSolution implements Solution
{
public function getSolutionTitle(): string
{
return 'The solution title goes here';
}
public function getSolutionDescription(): string
{
return 'This is a longer description of the solution that you want to show.';
}
public function getDocumentationLinks(): array
{
return [
'Your documentation' => 'https://your-project.com/relevant-docs-page',
];
}
}
This is how the exception would be displayed if you were to throw it.
TODO: insert image
Using solution providers
Instead of adding solutions to exceptions directly, you can also create a solution provider. While exceptions that return a solution, provide the solution directly to Ignition, a solution provider allows you to figure out if an exception can be solved.
For example, you could create a custom "Stack Overflow solution provider", that will look up if a solution can be found for a given throwable.
Solution providers can be added by third party packages or within your own application.
A solution provider is any class that implements the \Spatie\IgnitionContracts\HasSolutionsForThrowable interface.
This is how the interface looks like:
interface HasSolutionsForThrowable
{
public function canSolve(Throwable $throwable): bool;
/** \Facade\IgnitionContracts\Solution[] */
public function getSolutions(Throwable $throwable): array;
}
When an error occurs in your app, the class will receive the Throwable in the canSolve method. In that method you can decide if your solution provider is applicable to the Throwable passed. If you return true, getSolutions will get called.
To register a solution provider to Ignition you must call the addSolutionProviders method.
\Spatie\Ignition\Ignition::make()
->addSolutionProviders([
YourSolutionProvider::class,
AnotherSolutionProvider::class,
])
->register();
Sending exceptions to Flare
Ignition comes the ability to send exceptions to Flare, an exception monitoring service. Flare can notify you when new exceptions are occurring in your production environment.
To send exceptions to Flare, simply call the sendToFlareMethod and pass it the API key you got when creating a project on Flare.
You probably want to combine this with calling runningInProductionEnvironment. That method will, when passed a truthy value, not display the Ignition error page, but only send the exception to Flare.
\Spatie\Ignition\Ignition::make()
->runningInProductionEnvironment($boolean)
->sendToFlare($yourApiKey)
->register();
When you pass a falsy value to runningInProductionEnvironment, the Ignition error page will get shown, but no exceptions will be sent to Flare.
Sending custom context to Flare
When you send an error to Flare, you can add custom information that will be sent along with every exception that happens in your application. This can be very useful if you want to provide key-value related information that furthermore helps you to debug a possible exception.
use Spatie\FlareClient\Flare;
\Spatie\Ignition\Ignition::make()
->runningInProductionEnvironment($boolean)
->sendToFlare($yourApiKey)
->configureFlare(function(Flare $flare) {
$flare->context('Tenant', 'My-Tenant-Identifier');
})
->register();
Sometimes you may want to group your context items by a key that you provide to have an easier visual differentiation when you look at your custom context items.
The Flare client allows you to also provide your own custom context groups like this:
use Spatie\FlareClient\Flare;
\Spatie\Ignition\Ignition::make()
->runningInProductionEnvironment($boolean)
->sendToFlare($yourApiKey)
->configureFlare(function(Flare $flare) {
$flare->group('Custom information', [
'key' => 'value',
'another key' => 'another value',
]);
})
->register();
Anonymize request to Flare
By default, the Ignition collects information about the IP address of your application users. If you want don't want to send this information to Flare, call anonymizeIp().
use Spatie\FlareClient\Flare;
\Spatie\Ignition\Ignition::make()
->runningInProductionEnvironment($boolean)
->sendToFlare($yourApiKey)
->configureFlare(function(Flare $flare) {
$flare->anonymizeIp();
})
->register();
Censoring request body fields
When an exception occurs in a web request, the Flare client will pass on any request fields that are present in the body.
In some cases, such as a login page, these request fields may contain a password that you don't want to send to Flare.
To censor out values of certain fields, you can use call censorRequestBodyFields. You should pass it the names of the fields you wish to censor.
use Spatie\FlareClient\Flare;
\Spatie\Ignition\Ignition::make()
->runningInProductionEnvironment($boolean)
->sendToFlare($yourApiKey)
->configureFlare(function(Flare $flare) {
$flare->censorRequestBodyFields(['password']);
})
->register();
This will replace the value of any sent fields named "password" with the value "".
Using middleware to modify data sent to Flare
Before Flare receives the data that was collected from your local exception, we give you the ability to call custom middleware methods. These methods retrieve the report that should be sent to Flare and allow you to add custom information to that report.
A valid middleware is any class that implements FlareMiddleware.
use Spatie\FlareClient\Report;
use Spatie\FlareClient\FlareMiddleware\FlareMiddleware;
class MyMiddleware implements FlareMiddleware
{
public function handle(Report $report, Closure $next)
{
$report->message("{$report->getMessage()}, now modified");
return $next($report);
}
}
use Spatie\FlareClient\Flare;
\Spatie\Ignition\Ignition::make()
->runningInProductionEnvironment($boolean)
->sendToFlare($yourApiKey)
->configureFlare(function(Flare $flare) {
$flare->registerMiddleware([
MyMiddleware::class,
])
})
->register();
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.
2 Oct 11, 2021
1.1k Dec 25, 2022
8.8k Jan 5, 2023
6.8k Jan 3, 2023
1.4k Nov 30, 2022
111 Dec 16, 2022
6 Apr 25, 2022
3 Jan 18, 2022
35 Nov 1, 2022
24 Oct 4, 2022
95 Dec 25, 2022
3 May 18, 2022
4 May 3, 2022
14 Jan 3, 2023
12 Nov 15, 2022
8.7k Jan 8, 2023
9.9k Dec 29, 2022
148.1k Jan 7, 2023
6.7k Dec 21, 2022