Filament Exceptions

Follow these steps to integrate the exception viewer into your FilamentPHP admin panel:

1. Install the package via Composer:

   composer require bezhansalleh/filament-exceptions

2. Publish and run the migrations:

   php artisan exceptions:install

3. Register the plugin in your Filament Panel provider:

   public function panel(Panel $panel): Panel
   {
       return $panel
           ->plugins([
               \BezhanSalleh\FilamentExceptions\FilamentExceptionsPlugin::make()
           ]);
   }

Important: Theming To ensure the plugin follows your Filament theme, add the following line to your theme.css file and rebuild your assets:

@source '../../../../vendor/bezhansalleh/filament-exceptions/resources/views/**/*.blade.php';

npm run build

To customize the text used within the exception viewer, publish the package's translation files using the following Artisan command:

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

If you want to use a custom database model for storing exceptions, follow these two steps:

1. Create a model that extends the base exception model:

   namespace App\
   Models;
   
   use BezhanSalleh\\FilamentExceptions\\Models\\Exception as BaseException;
   
   class MyCustomException extends BaseException
   {
       // Your custom logic here
   }

2. Register your custom model in your AppServiceProvider::boot() method:

   use App\
   Models\\MyCustomException;
   use BezhanSalleh\\FilamentExceptions\\FilamentExceptions;
   
   public function boot()
   {
       FilamentExceptions::model(MyCustomException::class);
   }

// 1. Extend the base model
class MyCustomException extends \BezhanSalleh\FilamentExceptions\Models\Exception {}

// 2. Register it in AppServiceProvider
FilamentExceptions::model(MyCustomException::class);

Run the exceptions:install command to set up the Filament Exceptions plugin. This command automatically publishes the necessary migrations using the filament-exceptions-migrations tag and executes the database migrations.

If you need to overwrite existing files or force the migration process, use the --force flag.

php artisan exceptions:install

# To force overwrite files and migrations
php artisan exceptions:install --force

To integrate the exception viewer into your Filament panel, use the FilamentExceptionsPlugin::make() method within your panel configuration. This registers the ExceptionResource and sets up the necessary plugin infrastructure.

use BezhanSallehilament-exceptions\FilamentExceptionsPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        // ... other configuration
        ->plugins([
            FilamentExceptionsPlugin::make(),
        ]);
}

The package includes an InstallCommand which can be used to set up the necessary components. While the specific command name is typically handled by the package's internal installer, the presence of InstallCommand in the service provider indicates that an installation command is available to automate the setup process (migrations, views, etc.).

php artisan filament-exceptions:install

The markdown() method returns a string containing a full markdown report of the exception. If a markdown version was not explicitly stored in the database, the class will dynamically generate one containing:

• Exception class and title
• Message, PHP version, and Laravel version
• Hostname
• Stack Trace (file and line numbers)
• Request method and path
• Headers
• Route Context and Parameters
• Database Queries

The FilamentExceptions facade provides a static interface to control how exceptions are captured and stored. You can manually start or stop the recording process, check the current recording status, or define a custom callback for how exceptions are recorded.

use BezhanSalleh\FilamentExceptions\Facades\FilamentExceptions;

// Start recording exceptions
FilamentExceptions::startRecording();

// Check if recording is active
if (FilamentExceptions::isRecording()) {
    // ...
}

// Stop recording
FilamentExceptions::stopRecording();

// Define a custom recording logic via a closure
FilamentExceptions::recordUsing(function (Throwable $exception) {
    // Custom logic here
});