/filament-exceptions

A Simple & Beautiful Pluggable Exception Viewer for FilamentPHP's Admin Panel

Primary LanguagePHPMIT LicenseMIT

filament-exceptions-art

FILAMENT 8.x Packagist Tests Passing Code Style Passing Downloads

Filament Exception Viewer

A Simple & Beautiful Exception Viewer for FilamentPHP's Admin Panel

  • For FilamentPHP 2.x use version 1.x

Installation

  1. You can install the package via composer:
composer require bezhansalleh/filament-exceptions
  1. Publish and run the migration via:
php artisan exceptions:install
  1. Register the plugin for the Filament Panel
public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            \BezhanSalleh\FilamentExceptions\FilamentExceptionsPlugin::make()
        ]);
}
  1. Activate the plugin by editing your App's Exception Handler as follow:
<?php

namespace App\Exceptions;

use BezhanSalleh\FilamentExceptions\FilamentExceptions;

class Handler extends ExceptionHandler
{
    ...

    public function register()
    {
        $this->reportable(function (Throwable $e) {
            if ($this->shouldReport($e)) {
                FilamentExceptions::report($e);
            }
        });

        ...
    }

Configuration

The configuration file filament-exceptions.php is automatically published into your config directory. You can change icons and navigations settings as well as the active pill and slug there.

  • Mass Pruning: By default exceptions older than a week are scheduled to be pruned daily. You can change the period by providing a date in the config or using carbon.

Note in order for the schedule to work you need to make sure that you have configured your server if not follow this link on how to configure it. Running The Scheduler

Theme

By default the plugin uses the default theme of Filamentphp, but if you are using a custom theme then include the plugins view path into the content array of your tailwind.config.js file:

export default {
    content: [
        // ...
        './vendor/bezhansalleh/filament-exceptions/resources/views/**/*.blade.php', // Language Switch Views
    ],
    // ...
}

Translations

Publish the translations with

php artisan vendor:publish --tag=filament-exceptions-translations

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

License

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