Filament Exceptions

https://github.com/bezhansalleh/filament-exceptions
Admin
Filament Exceptions is a simple and beautiful exception viewer plugin for FilamentPHP's admin panel...
Tokens:27,087
Snippets:409
Trust Score:9.5
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### Run Installation Command

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/integration-guide.md

Executes the setup process including migrations. Use the force flag to overwrite existing files.

```bash
php artisan exceptions:install
```

```bash
php artisan exceptions:install --force
```

--------------------------------

### Example plugin usage

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/README.md

A practical example of chaining configuration methods during plugin registration.

```php
return $panel
    ->plugins([
        FilamentExceptionsPlugin::make()
            ->navigationLabel('Error Logs')
            ->navigationIcon('heroicon-o-bug-ant')
            ->navigationBadge()
            ->navigationGroup('System')
            ->modelPruneInterval(now()->subDays(7))
    ]);
```

--------------------------------

### Install package and run migrations

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/integration-guide.md

Commands to install the package or manually run migrations.

```bash
php artisan exceptions:install

# Or run migrations manually
php artisan migrate
```

--------------------------------

### Run Installation Command

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Executes the package installation process, optionally using the force flag to overwrite existing files.

```bash
php artisan exceptions:install

# With force flag
php artisan exceptions:install --force
```

--------------------------------

### exceptions:install

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

The installation command publishes necessary migration files, executes pending migrations, and provides an option to star the repository.

```APIDOC
## exceptions:install

### Description
Publishes migration files, runs pending migrations, and prompts to star the repository on GitHub.

### Signature
`exceptions:install`

### Options
- **--force** (-F) - Optional - Force overwrite of published files

### Example
```bash
php artisan exceptions:install

# With force flag
php artisan exceptions:install --force
```
```

--------------------------------

### Install Filament Exceptions

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/README.md

Run these commands in your terminal to install the package and run the installation command.

```bash
composer require bezhansalleh/filament-exceptions
php artisan exceptions:install
```

--------------------------------

### Run Migrations

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/errors.md

Commands to install or migrate the database tables.

```bash
php artisan exceptions:install
# or
php artisan migrate
```

--------------------------------

### InstallCommand

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/SYMBOLS.md

Console command to install the Filament Exceptions plugin.

```APIDOC
## Command: exceptions:install

### Description
Installs the Filament Exceptions plugin for your Filament project.

### Signature
`exceptions:install {--F|force}`

### Usage
`php artisan exceptions:install`
```

--------------------------------

### Assign Route Parameters Example

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/types.md

Demonstrates how to populate the route parameters array.

```php
$parameters = [
    'id' => '123',
    'slug' => 'my-post',
    'page' => 2,
];

$data['route_parameters'] = $parameters;
```

--------------------------------

### Iterate Application Queries Example

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/types.md

Demonstrates how to iterate and print normalized application queries.

```php
foreach ($stored->applicationQueries() as $query) {
    printf("%s: %s (%fms)\n",
        $query['connectionName'],
        $query['sql'],
        $query['time']
    );
}
```

--------------------------------

### Assign Route Context Example

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/types.md

Demonstrates how to populate the route context array.

```php
$routeContext = [
    'route' => 'users.show',
    'controller' => 'App\Http\Controllers\UserController',
    'action' => 'show',
];

$data['route_context'] = $routeContext;
```

--------------------------------

### Assign Query Data Example

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/types.md

Demonstrates how to populate the query data array for reporting.

```php
$queries = [
    [
        'connection' => 'mysql',
        'sql' => 'SELECT * FROM users WHERE id = ?',
        'time' => 1.23,
    ],
];

$data['query'] = $queries;
```

--------------------------------

### Iterate Frame Groups Example

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/types.md

Demonstrates how to iterate through frame groups and display file information.

```php
foreach ($stored->frameGroups() as $group) {
    if ($group['is_vendor']) {
        echo "Vendor Code:\n";
    } else {
        echo "Application Code:\n";
    }
    
    foreach ($group['frames'] as $frame) {
        echo $frame->file() . ':' . $frame->line() . "\n";
    }
}
```

--------------------------------

### Assign Request Headers Example

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/types.md

Demonstrates how to structure request headers for the report data.

```php
$headers = [
    'content-type' => 'application/json',
    'accept' => ['application/json', 'text/html'],
    'authorization' => 'Bearer token...',
];

$data['headers'] = $headers;
```

--------------------------------

### Install package via Composer

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/README.md

Run this command in your terminal to add the package to your project.

```bash
composer require bezhansalleh/filament-exceptions
```

--------------------------------

### Get frame arguments

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Retrieve an array of formatted argument descriptions.

```php
$args = $frame->args(); // ['$userId', 'object(User)', 'true']
```

--------------------------------

### Excluded Exception Examples

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/errors.md

Examples of exceptions that will be excluded from recording based on the defined validation criteria.

```php
// Blank message — EXCLUDED
throw new Exception('');

// No file — EXCLUDED  
$error = new Error();
$error->file = null;

// Eval'd code — EXCLUDED
eval('throw new Exception("Error");');

// VSCode debug — EXCLUDED
throw new Exception('__VSCODE_LARAVEL_ debug marker');

// Invalid line — EXCLUDED
$e = new Exception('error');
// If getLine() returns 0 or negative
```

--------------------------------

### Configure Filament Exceptions Plugin

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/configuration.md

A comprehensive example demonstrating various configuration methods available on the plugin instance.

```php
use BezhanSalleh\FilamentExceptions\FilamentExceptionsPlugin;
use Carbon\Carbon;
use Filament\Pages\Enums\SubNavigationPosition;

FilamentExceptionsPlugin::make()
    // Navigation
    ->navigationLabel('Error Logs')
    ->navigationIcon('heroicon-o-bug-ant')
    ->activeNavigationIcon('heroicon-s-bug-ant')
    ->navigationGroup('System')
    ->navigationBadge(true)
    ->navigationBadgeColor('danger')
    ->navigationSort(1)
    ->registerNavigation(true)
    ->subNavigationPosition(SubNavigationPosition::Start)
    
    // Labels
    ->modelLabel('Exception')
    ->pluralModelLabel('Exceptions')
    ->titleCaseModelLabel(true)
    ->globallySearchable(true)
    
    // Tenancy
    ->scopeToTenant(true)
    ->tenantRelationshipName('tenant')
    ->tenantOwnershipRelationshipName('owner')
    
    // Pruning
    ->modelPruneInterval(Carbon::now()->subDays(30))
    
    // General
    ->slug('exceptions')
    ->cluster(null)
```

--------------------------------

### GET /admin/exceptions

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/SYMBOLS.md

Retrieves a list of stored exceptions.

```APIDOC
## GET /admin/exceptions

### Description
Retrieves the ListExceptions page, which displays a collection of stored exceptions.

### Method
GET

### Endpoint
/admin/exceptions
```

--------------------------------

### Get previous frame

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Retrieve the preceding frame in the stack trace.

```php
if ($prev = $frame->previous()) {
    echo $prev->file();
}
```

--------------------------------

### Get editor link

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Generate a URI to open the file in an editor at the specific line number.

```php
$href = $frame->editorHref(); // 'vscode://file///app/MyClass.php:42'
```

--------------------------------

### Configure Filament Exceptions Plugin

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/README.md

Use these snippets to register the plugin in your Filament configuration. The recommended setup includes navigation customization and automatic model pruning.

```php
FilamentExceptionsPlugin::make()
```

```php
FilamentExceptionsPlugin::make()
    ->navigationLabel('Error Logs')
    ->navigationIcon('heroicon-o-bug-ant')
    ->navigationGroup('System')
    ->navigationBadge()
    ->navigationBadgeColor('danger')
    ->modelPruneInterval(now()->subDays(30))
```

--------------------------------

### Usage of ExceptionResource Table

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Example of invoking the table method within a Filament panel context.

```php
// Usage in Filament panel - typically automatic
$table = ExceptionResource::table($table);
```

--------------------------------

### Get frame source

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Retrieve the class name or file path associated with the frame.

```php
$source = $frame->source(); // 'MyClass' or 'src/MyClass.php'
```

--------------------------------

### Get code snippet

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Retrieve the source code surrounding the error line.

```php
$snippet = $frame->snippet();
echo $snippet; // Multi-line code around the error
```

--------------------------------

### Get frame class

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Retrieve the class name if it exists in the class map.

```php
$class = $frame->class(); // 'MyClass' or null
```

--------------------------------

### Get frame file

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Retrieve the relative file path or internal function indicator.

```php
$file = $frame->file(); // 'src/MyClass.php' or '[internal function]'
```

--------------------------------

### Simulate Silent Failure

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/errors.md

Example of how an invalid model class causes silent failure during storage.

```php
FilamentExceptions::model('NonExistent\Exception\Class');
// Silently returns false when store() is called
```

--------------------------------

### Publish and run migrations

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/README.md

Execute the package migration to set up the necessary database tables.

```bash
php artisan exceptions:install
```

--------------------------------

### StoredException::requestHeaders

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Get the request headers.

```APIDOC
## StoredException::requestHeaders()

### Description
Get the request headers.

### Returns
- **array<string, string>** - Associative array of header name => value pairs
```

--------------------------------

### StoredException::code

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Get the exception code.

```APIDOC
## StoredException::code()

### Description
Get the exception code.

### Returns
- **int|string** - The exception code, or 0 if not available
```

--------------------------------

### Get Maximum Content Width

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/resources.md

Sets the page width to 6xl to ensure sufficient space for displaying code snippets.

```php
public function getMaxContentWidth(): Width | string | null
```

--------------------------------

### StoredException::message

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Get the exception message.

```APIDOC
## StoredException::message()

### Description
Get the exception message.

### Returns
- **string** - The exception message, or empty string if not available
```

--------------------------------

### StoredException::requestBody

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Get the request body as a string.

```APIDOC
## StoredException::requestBody()

### Description
Get the request body as a string.

### Returns
- **string|null** - JSON-encoded request body, or null if empty
```

--------------------------------

### StoredException::httpStatusCode

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Get the HTTP status code.

```APIDOC
## StoredException::httpStatusCode()

### Description
Get the HTTP status code.

### Returns
- **int** - Always returns 500
```

--------------------------------

### Enable exception recording with FilamentExceptions::startRecording

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Activates the recording functionality for exceptions.

```php
use BezhanSalleh\FilamentExceptions\FilamentExceptions;

FilamentExceptions::startRecording();
```

--------------------------------

### Utilize Carbon Date Instances

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/types.md

Demonstrates setting prune intervals and creating specific date instances using the Carbon library.

```php
use Carbon\Carbon;

// Set to keep exceptions for 30 days
FilamentExceptionsPlugin::make()
    ->modelPruneInterval(now()->subDays(30));

// Create specific date
$keepSince = Carbon::create(2024, 1, 1);
```

--------------------------------

### Get frame callable

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Retrieve the function or method name.

```php
$func = $frame->callable(); // 'myMethod' or 'throw'
```

--------------------------------

### Get frame operator

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Retrieve the function operator such as '->' or '::'.

```php
$op = $frame->operator(); // '->' or '::' or ''
```

--------------------------------

### Run tests

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/README.md

Execute the test suite using composer.

```bash
composer test
```

--------------------------------

### FilamentExceptions::startRecording

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/SYMBOLS.md

Enables exception recording.

```APIDOC
## static startRecording(): void

### Description
Starts or resumes the recording of exceptions.
```

--------------------------------

### StoredException::frameGroups

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Get exception frames grouped by vendor status.

```APIDOC
## StoredException::frameGroups()

### Description
Get exception frames grouped by vendor status.

### Returns
- **array** - Array of groups with is_vendor boolean and frames array
```

--------------------------------

### StoredException::frames

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Get the exception stack trace as StoredFrame instances.

```APIDOC
## StoredException::frames()

### Description
Get the exception stack trace as StoredFrame instances.

### Returns
- **Collection<int, StoredFrame>** - Collection of frame objects
```

--------------------------------

### Build custom theme

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/README.md

Compile your assets after updating the theme configuration.

```bash
npm run build
```

--------------------------------

### StoredException::fullClass

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Get the fully qualified exception class name.

```APIDOC
## StoredException::fullClass()

### Description
Get the fully qualified exception class name.

### Returns
- **string** - The full class name with namespace
```

--------------------------------

### StoredException::title

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Get the exception title (HTTP status text).

```APIDOC
## StoredException::title()

### Description
Get the exception title (HTTP status text).

### Returns
- **string** - Always returns 'Internal Server Error'
```

--------------------------------

### General plugin configuration

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/README.md

Methods for setting cluster and slug options.

```php
FilamentExceptionsPlugin::make()
    ->cluster(string | Closure | null $cluster)
    ->slug(string | Closure | null $slug)
```

--------------------------------

### Configure Method Column

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/resources.md

Displays the HTTP request method with color-coded badges.

```php
TextColumn::make('method')
    ->label(fn (): string => __('filament-exceptions::filament-exceptions.columns.method'))
    ->badge()
    ->colors([
        'success' => fn ($state): bool => $state === 'GET',
        'primary' => fn ($state): bool => $state === 'POST',
        'warning' => fn ($state): bool => in_array($state, ['PUT', 'PATCH'], true),
        'danger' => fn ($state): bool => $state === 'DELETE',
        'gray' => fn ($state): bool => $state === 'OPTIONS',
    ])
    ->searchable()
    ->sortable()
```

--------------------------------

### Get Breadcrumbs

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/resources.md

Returns an empty array to disable breadcrumb navigation.

```php
public function getBreadcrumbs(): array
```

--------------------------------

### Configure Custom Theme

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/integration-guide.md

Add the view source path to your theme CSS and rebuild the assets.

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

```bash
npm run build
```

--------------------------------

### GET /admin/exceptions/{record}

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/SYMBOLS.md

Retrieves the details of a specific exception record.

```APIDOC
## GET /admin/exceptions/{record}

### Description
Retrieves the ViewException page for a specific exception record identified by the record ID.

### Method
GET

### Endpoint
/admin/exceptions/{record}

### Parameters
#### Path Parameters
- **record** (string) - Required - The unique identifier of the exception record.
```

--------------------------------

### Configure custom theme source

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/README.md

Add the plugin path to your theme.css file to ensure proper styling.

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

--------------------------------

### Instantiate StoredFrame

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Create a new instance by providing the class map, frame data, base path, and an optional previous frame.

```php
$frame = new StoredFrame(
    classMap: ['MyClass' => '/app/MyClass.php'],
    frame: [
        'file' => '/app/MyClass.php',
        'line' => 42,
        'class' => 'MyClass',
        'type' => '->',
        'function' => 'myMethod',
        'args' => [],
    ],
    basePath: '/var/www/html'
);
```

--------------------------------

### ExceptionResource Navigation Configuration Methods

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/resources.md

Methods for customizing the appearance and behavior of the exception resource within the Filament navigation menu.

```php
public static function getModelLabel(): string
```

```php
public static function getPluralModelLabel(): string
```

```php
public static function getActiveNavigationIcon(): ?string
```

```php
public static function getNavigationGroup(): ?string
```

```php
public static function getNavigationLabel(): string
```

```php
public static function getNavigationIcon(): string
```

```php
public static function getSlug(?Panel $panel = null): string
```

```php
public static function getNavigationBadge(): ?string
```

```php
// If navigationBadge(true) is set:
// Returns: "42" (for 42 exceptions)

// If navigationBadge(false):
// Returns: null (no badge shown)
```

```php
public static function getNavigationBadgeColor(): string | array | null
```

```php
public static function shouldRegisterNavigation(): bool
```

```php
public static function getNavigationSort(): ?int
```

--------------------------------

### Reporting Exceptions with Throwable

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/types.md

Shows how to catch and report exceptions using the Throwable interface.

```php
try {
    // Code
} catch (Throwable $e) {
    FilamentExceptions::report($e);
}
```

--------------------------------

### Recover from Missing Migrations

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/errors.md

Commands to publish and run migrations when the database table is missing.

```bash
# Publish migrations
php artisan vendor:publish --tag=filament-exceptions-migrations --force

# Run migrations
php artisan migrate

# Or use install command
php artisan exceptions:install
```

--------------------------------

### StoredException::request

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Get a mock Request object built from stored data.

```APIDOC
## StoredException::request()

### Description
Get a mock Request object built from stored data.

### Returns
- **Illuminate\Http\Request** - Mock request instance with stored method, path, IP, and headers
```

--------------------------------

### Get Page Header

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/resources.md

Returns null to disable the default page header.

```php
public function getHeader(): ?View
```

--------------------------------

### Configure Multi-Tenant Scoping

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/integration-guide.md

Enables tenant-based exception isolation by specifying the relationship names.

```php
FilamentExceptionsPlugin::make()
    ->scopeToTenant(true)
    ->tenantRelationshipName('organization')
    ->tenantOwnershipRelationshipName('owner')
```

--------------------------------

### Recording Callback Error Handling

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/errors.md

Demonstrates how exceptions thrown within the recordUsing callback are handled and the internal logic for checking recording conditions.

```php
FilamentExceptions::recordUsing(function (Throwable $e) {
    // If this function throws, exception is caught silently
    // and recording proceeds normally
    return ! $e instanceof ValidationException;
});
```

```php
if (static::$shouldRecordCallback instanceof Closure && 
    ! call_user_func(static::$shouldRecordCallback, $throwable)) {
    // If callback throws here, outer try-catch handles it
    return;
}
```

--------------------------------

### Configure Custom Recording Callback

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/integration-guide.md

Use recordUsing to define custom logic for logging or filtering exceptions before they are stored.

```php
use BezhanSallehilamentExceptionsilamentExceptions;
use Illuminate\Support\Facades\Log;

public function boot(): void
{
    FilamentExceptions::recordUsing(function (Throwable $e) {
        // Log the exception separately
        Log::error('Exception recorded', [
            'class' => $e::class,
            'message' => $e->getMessage(),
            'file' => $e->getFile(),
            'line' => $e->getLine(),
        ]);

        // Record exceptions in production
        return app()->isProduction();
    });
}
```

--------------------------------

### Control Exception Recording via Facade

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/configuration.md

Use the FilamentExceptions facade to toggle recording state or define custom filtering logic globally.

```php
use BezhanSallehilamentExceptions\FilamentExceptions;

// Stop recording all exceptions
FilamentExceptions::stopRecording();

// Resume recording
FilamentExceptions::startRecording();

// Check current state
if (FilamentExceptions::isRecording()) {
    // Recording is active
}

// Set custom recording logic
FilamentExceptions::recordUsing(function (Throwable $e) {
    // Return true to record, false to skip
    return ! $e instanceof ValidationException;
});
```

--------------------------------

### Control exception recording

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/README.md

Manage recording status within the AppServiceProvider boot method.

```php
use BezhanSalleh\FilamentExceptions\FilamentExceptions;

public function boot(): void
{
    // Stop recording exceptions
    FilamentExceptions::stopRecording();

    // Resume recording
    FilamentExceptions::startRecording();

    // Check if recording is active
    FilamentExceptions::isRecording();
}
```

--------------------------------

### Check if recording is enabled

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/integration-guide.md

Verify the current recording status of the package.

```php
if (! FilamentExceptions::isRecording()) {
    // Recording is disabled
}
```

--------------------------------

### StoredException::class

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Get the exception class name (short form, without namespace).

```APIDOC
## StoredException::class()

### Description
Get the exception class name (short form, without namespace).

### Returns
- **string** - The class name without namespace
```

--------------------------------

### Configure Created At Column

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/resources.md

Displays the timestamp of the exception, hidden by default.

```php
TextColumn::make('created_at')
    ->label(fn (): string => __('filament-exceptions::filament-exceptions.columns.occurred_at'))
    ->sortable()
    ->searchable()
    ->dateTime()
    ->toggleable(isToggledHiddenByDefault: true)
```

--------------------------------

### Configure IP Column

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/resources.md

Displays the client IP address as a monospace badge, hidden by default.

```php
TextColumn::make('ip')
    ->label(fn (): string => __('filament-exceptions::filament-exceptions.columns.ip'))
    ->badge()
    ->extraAttributes(['class' => 'font-mono'])
    ->sortable()
    ->searchable()
    ->toggleable(isToggledHiddenByDefault: false)
```

--------------------------------

### ExceptionResource Tenancy Methods

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/resources.md

Methods for managing multi-tenancy scoping and relationship definitions for the exception resource.

```php
public static function isScopedToTenant(): bool
```

```php
public static function getTenantRelationshipName(): string
```

```php
public static function getTenantOwnershipRelationshipName(): string
```

--------------------------------

### Plugin Configuration Methods

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Chainable configuration methods for customizing the plugin's behavior, navigation, and labels.

```APIDOC
## Plugin Configuration Methods

### Navigation Configuration
- **navigationBadge(bool|Closure)** - Optional - Show exception count badge
- **navigationBadgeColor(string|array|Closure)** - Optional - Badge color
- **navigationGroup(string|Closure|null)** - Optional - Navigation group label
- **navigationParentItem(string|Closure|null)** - Optional - Parent navigation item
- **navigationIcon(string|Closure|null)** - Optional - Icon when inactive
- **activeNavigationIcon(string|Closure|null)** - Optional - Icon when active
- **navigationLabel(string|Closure|null)** - Optional - Navigation label
- **navigationSort(int|Closure|null)** - Optional - Navigation sort order
- **registerNavigation(bool|Closure)** - Optional - Register in navigation
- **subNavigationPosition(SubNavigationPosition|Closure)** - Optional - Sub-navigation position

### Labels Configuration
- **modelLabel(string|Closure|null)** - Optional - Singular model label
- **pluralModelLabel(string|Closure|null)** - Optional - Plural model label
- **titleCaseModelLabel(bool|Closure)** - Optional - Title case labels
- **globallySearchable(bool|Closure)** - Optional - Enable global search

### Tenancy Configuration
- **scopeToTenant(bool|Closure)** - Optional - Scope to current tenant
- **tenantRelationshipName(string|Closure|null)** - Optional - Tenant relationship name
- **tenantOwnershipRelationshipName(string|Closure|null)** - Optional - Ownership relationship name

### Pruning Configuration
- **modelPruneInterval(Carbon)** - Optional - Records to keep (default 7 days)

### General Configuration
- **cluster(string|Closure|null)** - Optional - Cluster class name
- **slug(string|Closure|null)** - Optional - Resource slug
```

--------------------------------

### Pruning with Eloquent Builder

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/types.md

Demonstrates using the prunable builder to count and delete exceptions.

```php
$builder = Exception::prunable();
$count = $builder->count();
$builder->delete();
```

--------------------------------

### Get frame line number

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Retrieve the line number, returning 0 if the file is unreadable.

```php
$line = $frame->line(); // 42
```

--------------------------------

### Implement ListExceptions Empty State Icon

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/resources.md

Sets the empty state icon to match the resource navigation icon.

```php
return static::$resource::getNavigationIcon();
```

--------------------------------

### Usage in Blade View

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/resources.md

Example of accessing the StoredException instance within a Blade template to display exception details.

```blade
@php
$exception = $this->getStoredException();
@endphp

<h1>{{ $exception->class() }}</h1>
<p>{{ $exception->message() }}</p>
```

--------------------------------

### Tenancy configuration

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/README.md

Methods for scoping exceptions to specific tenants.

```php
FilamentExceptionsPlugin::make()
    ->scopeToTenant(bool | Closure $condition = true)
    ->tenantOwnershipRelationshipName(string | Closure | null $ownershipRelationshipName)
    ->tenantRelationshipName(string | Closure | null $relationshipName)
```

--------------------------------

### Navigation configuration options

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/README.md

Methods available for customizing the navigation menu items.

```php
FilamentExceptionsPlugin::make()
    ->navigationBadge(bool | Closure $condition = true)
    ->navigationBadgeColor(string | array | Closure $color)
    ->navigationGroup(string | Closure | null $group)
    ->navigationParentItem(string | Closure | null $item)
    ->navigationIcon(string | Closure | null $icon)
    ->activeNavigationIcon(string | Closure | null $icon)
    ->navigationLabel(string | Closure | null $label)
    ->navigationSort(int | Closure | null $sort)
    ->registerNavigation(bool | Closure $shouldRegisterNavigation)
    ->subNavigationPosition(SubNavigationPosition | Closure $position)
```

--------------------------------

### Get Page Heading

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/resources.md

Returns null to suppress the default page heading, as the custom view handles its own layout.

```php
public function getHeading(): string | Htmlable | null
```

--------------------------------

### Publish translations

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/README.md

Use the artisan command to publish package translation files.

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

--------------------------------

### Get Custom Page CSS Classes

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/resources.md

Defines custom CSS classes to adjust the Filament page header layout.

```php
public function getPageClasses(): array
```

```php
[
    '[&_.fi-page-header-main-ctn]:gap-y-0! [&_.fi-page-header-main-ctn]:py-1',
]
```

--------------------------------

### Label and search configuration

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/README.md

Methods for customizing model labels and global search behavior.

```php
FilamentExceptionsPlugin::make()
    ->modelLabel(string | Closure | null $label)
    ->pluralModelLabel(string | Closure | null $label)
    ->titleCaseModelLabel(bool | Closure $condition = true)
    ->globallySearchable(bool | Closure $condition = true)
```

--------------------------------

### Define ListExceptions Empty State Icon Method

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/resources.md

Defines the method signature for retrieving the empty state icon.

```php
protected function getTableEmptyStateIcon(): ?string
```

--------------------------------

### Implement ListExceptions Empty State Heading

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/resources.md

Returns the translated heading text for the empty state.

```php
return __('filament-exceptions::filament-exceptions.empty_list');
```

--------------------------------

### Retrieve Model Configuration

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/errors.md

Access the currently configured exception model.

```php
public static function getModel(): ?string
{
    return static::$model; // null if never set
}
```

--------------------------------

### Register Exception Model

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/errors.md

Set the exception model in the AppServiceProvider boot method.

```php
use BezhanSalleh
ullFilamentExceptions
ullFilamentExceptions;

// In AppServiceProvider boot()
FilamentExceptions::model(MyException::class);
```

--------------------------------

### Locate Blade View File

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/resources.md

Path to the main exception detail view file.

```text
resources/views/filament-exceptions/view-exception.blade.php
```

--------------------------------

### Define custom recording logic

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Configure a callback to filter which exceptions are recorded. Pass null to reset to default behavior.

```php
public static function recordUsing(?Closure $callback): void
```

```php
function(Throwable $throwable): bool {
    // Return true to record, false to skip
}
```

```php
use BezhanSalleh\FilamentExceptions\FilamentExceptions;

// Only record in production
FilamentExceptions::recordUsing(fn () => app()->isProduction());

// Skip validation exceptions
FilamentExceptions::recordUsing(function (Throwable $e) {
    return ! $e instanceof \Illuminate\Validation\ValidationException;
});

// Complex conditions
FilamentExceptions::recordUsing(function (Throwable $e) {
    // Skip 4xx HTTP errors
    if ($e instanceof \Symfony\Component\HttpKernel\Exception\HttpException) {
        return $e->getStatusCode() >= 500;
    }
    
    // Skip authentication exceptions
    if ($e instanceof \Illuminate\Auth\AuthenticationException) {
        return false;
    }
    
    return true;
});

// Disable custom logic
FilamentExceptions::recordUsing(null);
```

--------------------------------

### Define ListExceptions Empty State Heading Method

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/resources.md

Defines the method signature for retrieving the empty state heading.

```php
protected function getTableEmptyStateHeading(): ?string
```

--------------------------------

### Unit Testing Exception Recording

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/integration-guide.md

Use FilamentExceptions::startRecording() and stopRecording() to control exception logging during test execution.

```php
use BezhanSallehilamentExceptionsilamentExceptions;
use BezhanSallehilamentExceptions
Models
Exception;

class ExceptionRecordingTest extends TestCase
{
    public function test_exceptions_are_recorded()
    {
        // Ensure recording is enabled
        FilamentExceptions::startRecording();

        try {
            throw new Exception('Test exception');
        } catch (Exception $e) {
            FilamentExceptions::report($e);
        }

        // Check if recorded
        $this->assertDatabaseHas('filament_exceptions_table', [
            'message' => 'Test exception',
        ]);
    }

    public function test_exceptions_not_recorded_when_disabled()
    {
        FilamentExceptions::stopRecording();

        try {
            throw new Exception('Should not record');
        } catch (Exception $e) {
            FilamentExceptions::report($e);
        }

        $this->assertDatabaseMissing('filament_exceptions_table', [
            'message' => 'Should not record',
        ]);
    }
}
```

--------------------------------

### Configure Navigation Badge

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/configuration.md

Methods for defining the navigation badge visibility and color.

```php
public function navigationBadge(bool | Closure $condition = true): static
```

```php
FilamentExceptionsPlugin::make()
    ->navigationBadge(true) // Always show count
    ->navigationBadge(fn () => auth()->user()->isAdmin()) // Conditionally
```

```php
public function navigationBadgeColor(string | array | Closure $color): static
```

```php
FilamentExceptionsPlugin::make()
    ->navigationBadgeColor('danger')
    ->navigationBadgeColor(fn () => auth()->user()->isAdmin() ? 'danger' : 'warning')
```

--------------------------------

### Define Resource Pages Routes

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/resources.md

Registers the index and view routes for the exception resource.

```php
public static function getPages(): array
{
    return [
        'index' => ListExceptions::route('/'),
        'view' => ViewException::route('/{record}'),
    ];
}
```

--------------------------------

### Register plugin in Filament panel

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/README.md

Add the plugin to your Filament panel configuration.

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

--------------------------------

### Configure Toolbar Actions

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/resources.md

Adds bulk delete functionality to the table toolbar.

```php
->toolbarActions([
    BulkActionGroup::make([
        DeleteBulkAction::make(),
    ]),
])
```

--------------------------------

### Register custom exception model

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/README.md

Register the custom model in the boot method of a service provider.

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

--------------------------------

### Automated Pruning Configuration

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/integration-guide.md

Commands to configure and verify the Laravel scheduler for automated model pruning.

```bash
* * * * * cd /path/to/project && php artisan schedule:run >> /dev/null 2>&1
```

```bash
php artisan schedule:list
```

--------------------------------

### Mark frame as main

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Identify this frame as the primary non-vendor frame.

```php
$frame->markAsMain();
```

--------------------------------

### Register Custom Resource

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/resources.md

Note regarding resource registration within the plugin.

```php
// This would require extending FilamentExceptions::model()
// The resource is auto-discovered from the model
```

--------------------------------

### Configure Tenant Scoping

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/configuration.md

Defines the method signature for enabling or disabling tenant-based exception filtering.

```php
public function scopeToTenant(bool | Closure $condition = true): static
```

```php
FilamentExceptionsPlugin::make()
    ->scopeToTenant(true)  // Each tenant sees only their exceptions
    ->scopeToTenant(false) // Admins see all exceptions
```

--------------------------------

### Configure Table Filters

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/resources.md

Placeholder for table filters.

```php
->filters([
    //
])
```

--------------------------------

### Configure Resource Cluster

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/configuration.md

Assigns the exception resource to a specific Filament cluster.

```php
public function cluster(string | Closure | null $cluster): static
```

```php
use App\Filament\Clusters\System;

FilamentExceptionsPlugin::make()
    ->cluster(System::class)
```

--------------------------------

### Retrieve application route context

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Returns an array containing route name, controller, and action information.

```php
$context = $stored->applicationRouteContext();
// ['route' => 'users.show', 'controller' => 'UserController', 'action' => 'show']
```

--------------------------------

### Verify Database Table Existence

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/errors.md

Check for the existence of the exceptions table and stop recording if missing.

```php
// In AppServiceProvider or another provider
protected function ensureMigrationsRun(): void
{
    if (! Schema::hasTable('filament_exceptions_table')) {
        Log::error('Exceptions table missing — run migrations');
        FilamentExceptions::stopRecording();
    }
}
```

--------------------------------

### Configure Resource Slug

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/configuration.md

Sets the URL path for the exception resource.

```php
public function slug(string | Closure | null $slug): static
```

```php
FilamentExceptionsPlugin::make()
    ->slug('error-logs')      // URL: /admin/error-logs
    ->slug('system-errors')   // URL: /admin/system-errors
```

--------------------------------

### Configure production exception recording

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/integration-guide.md

Implement custom logic in AppServiceProvider to filter out expected exceptions and non-production errors.

```php
<?php

namespace App\Providers;

use BezhanSalleh\FilamentExceptions\FilamentExceptions;
use Illuminate\Validation\ValidationException;
use Illuminate\Auth\AuthenticationException;
use Symfony\Component\HttpKernel\Exception\HttpException;
use Illuminate\Support\ServiceProvider;
use Throwable;

class AppServiceProvider extends ServiceProvider
{
    public function boot(): void
    {
        FilamentExceptions::recordUsing(function (Throwable $e) {
            // Only in production
            if (! app()->isProduction()) {
                return false;
            }

            // Skip expected exceptions
            if ($e instanceof ValidationException) {
                return false;
            }

            if ($e instanceof AuthenticationException) {
                return false;
            }

            // Skip 4xx HTTP errors
            if ($e instanceof HttpException && $e->getStatusCode() < 500) {
                return false;
            }

            // Record server errors and unexpected exceptions
            return true;
        });
    }
}
```

--------------------------------

### Configure Path Column

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/resources.md

Displays the request path where the exception occurred.

```php
TextColumn::make('path')
    ->label(fn (): string => __('filament-exceptions::filament-exceptions.columns.path'))
    ->searchable()
```

--------------------------------

### Register Custom Model in Service Provider

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/configuration.md

Use the FilamentExceptions::model method within the boot method of a service provider to register the custom model.

```php
use BezhanSalleh\FilamentExceptions\FilamentExceptions;

public function boot(): void
{
    FilamentExceptions::model(CustomException::class);
}
```

--------------------------------

### Configure navigation label

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/configuration.md

Sets the navigation item label using a string or a closure that returns a string.

```php
public function navigationLabel(string | Closure | null $label): static
```

```php
FilamentExceptionsPlugin::make()
    ->navigationLabel('Error Logs')
    ->navigationLabel(fn () => 'Errors (' . Exception::count() . ')')
```

--------------------------------

### Configure Code Column

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/resources.md

Displays the exception or HTTP status code, hidden by default.

```php
TextColumn::make('code')
    ->label(fn (): string => __('filament-exceptions::filament-exceptions.columns.code'))
    ->searchable()
    ->sortable()
    ->toggleable(isToggledHiddenByDefault: false)
```

--------------------------------

### Instantiate StoredException

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Create a new instance by passing a stored exception model record.

```php
use BezhanSalleh\FilamentExceptions\StoredException;
use BezhanSalleh\FilamentExceptions\Models\Exception;

$exceptionRecord = Exception::find(1);
$stored = new StoredException($exceptionRecord);
```

--------------------------------

### Configure Type Column

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/resources.md

Displays the short form of the exception class name.

```php
TextColumn::make('type')
    ->label(fn (): string => __('filament-exceptions::filament-exceptions.columns.type'))
    ->sortable()
    ->searchable()
```

--------------------------------

### Configure Navigation Icons

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/configuration.md

Set the icons for the navigation item in both active and inactive states.

```php
public function navigationIcon(string | Closure | null $icon): static
```

```php
FilamentExceptionsPlugin::make()
    ->navigationIcon('heroicon-o-exclamation-triangle')
    ->navigationIcon(fn () => auth()->user()->isAdmin() ? 'heroicon-o-bug-ant' : 'heroicon-o-information-circle')
```

```php
public function activeNavigationIcon(string | Closure | null $icon): static
```

```php
FilamentExceptionsPlugin::make()
    ->activeNavigationIcon('heroicon-s-exclamation-triangle')
```

--------------------------------

### Configure title case for model labels

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/configuration.md

Controls whether model labels are automatically title-cased.

```php
public function titleCaseModelLabel(bool | Closure $condition = true): static
```

```php
FilamentExceptionsPlugin::make()
    ->titleCaseModelLabel(true)  // 'Exception' becomes 'Exception'
    ->titleCaseModelLabel(false) // 'exception' stays 'exception'
```

--------------------------------

### Verify Model Registration

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/errors.md

Checks if the exception model is correctly configured and the class exists.

```php
$model = FilamentExceptions::getModel();
if (! $model) {
    // Model not set
}

if (! class_exists($model)) {
    // Model class doesn't exist
}
```

--------------------------------

### registerNavigation()

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/configuration.md

Controls whether to register the resource in navigation.

```APIDOC
## registerNavigation(bool | Closure $shouldRegisterNavigation)

### Description
Controls whether to register the resource in navigation. Defaults to true.

### Parameters
- **$shouldRegisterNavigation** (bool|Closure) - Required - Register or callable returning bool.

### Example
```php
FilamentExceptionsPlugin::make()
    ->registerNavigation(fn () => auth()->user()?->is_admin)
```
```

--------------------------------

### Monitor database table size

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/integration-guide.md

SQL query to check the storage size of the exceptions table.

```sql
// Check table size
SELECT table_name, round(((data_length + index_length) / 1024 / 1024), 2) AS size_mb
FROM information_schema.tables
WHERE table_name = 'filament_exceptions_table';
```

--------------------------------

### Create Mock Request from Stored Data

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/errors.md

Generates a Request object using stored record properties with defaults for path, method, and IP address.

```php
protected function createRequest(): Request
{
    $request = Request::create(
        uri: '/' . ltrim($this->record->path ?? '', '/'),
        method: $this->record->method ?? 'GET',
        server: [
            'REMOTE_ADDR' => $this->record->ip ?? '127.0.0.1',
        ]
    );

    if ($headers = $this->record->headers) {
        foreach ($headers as $key => $value) {
            $request->headers->set($key, $value);
        }
    }

    return $request;
}
```

--------------------------------

### Resolving Class Maps and Source Paths

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/errors.md

The class method returns null if resolution fails, while source provides a fallback to the file path.

```php
public function class(): ?string
{
    $file = $this->frame['file'] ?? '';
    if (empty($file)) {
        return null;
    }

    $class = array_search((string) realpath($file), $this->classMap, true);

    return $class === false ? null : $class;
}
```

```php
public function source(): string
{
    $class = $this->class();
    return $class ?? $this->file();
}
```

--------------------------------

### Configure Navigation Parent Item

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/configuration.md

Define a parent navigation item to nest the exceptions page under.

```php
public function navigationParentItem(string | Closure | null $item): static
```

```php
FilamentExceptionsPlugin::make()
    ->navigationParentItem('monitoring') // Shows under 'monitoring' item
```

--------------------------------

### Configure Record Actions

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/resources.md

Adds a view action to the table records.

```php
->recordActions([
    ViewAction::make()
        ->color('primary'),
])
```

--------------------------------

### FilamentExceptions Facade

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/SYMBOLS.md

The FilamentExceptions facade provides a static interface to interact with the exception handling and recording system.

```APIDOC
## FilamentExceptions Facade

### Description
Provides static methods to report exceptions, manage recording states, and configure model/cluster settings.

### Methods
- `report(Throwable $exception)`: Reports an exception.
- `store(array $data)`: Stores exception data.
- `getModel()` / `model(string $model)`: Get or set the model.
- `getCluster()` / `cluster(string $cluster)`: Get or set the cluster.
- `stopRecording()` / `startRecording()`: Control recording state.
- `isRecording()`: Check if currently recording.
- `recordUsing(?Closure $callback)`: Set a custom recording callback.
- `renderCss()` / `renderJs()`: Render package assets.
```

--------------------------------

### Debug recording callback

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/integration-guide.md

Use a custom callback to inspect exceptions being processed by the package.

```php
// Look in AppServiceProvider for recordUsing() calls
FilamentExceptions::recordUsing(function (Throwable $e) {
    // Debug: log what's happening
    \Log::debug('Recording callback', ['class' => $e::class]);
    return true;
});
```

--------------------------------

### Manage exception model configuration

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Methods to set or retrieve the custom model class used for storing exceptions.

```php
use App\Models\MyCustomException;
use BezhanSalleh\FilamentExceptions\FilamentExceptions;

FilamentExceptions::model(MyCustomException::class);
```

```php
$modelClass = FilamentExceptions::getModel(); // 'BezhanSalleh\FilamentExceptions\Models\Exception'
```

--------------------------------

### Retrieve Mock Request

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Returns a mock Request object containing the stored request metadata.

```php
$request = $stored->request();
echo $request->method(); // 'POST'
echo $request->path();   // '/api/users'
echo $request->ip();     // '192.168.1.1'
```

--------------------------------

### Define a Class Map

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/types.md

Represents a mapping of fully qualified class names to their absolute file paths.

```php
$classMap = [
    'App\Models\User' => '/var/www/app/Models/User.php',
    'App\Http\Controllers\UserController' => '/var/www/app/Http/Controllers/UserController.php',
];
```

--------------------------------

### Mass pruning configuration

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/README.md

Set the interval for automatically pruning old exception records.

```php
FilamentExceptionsPlugin::make()
    ->modelPruneInterval(Carbon $interval)
```

--------------------------------

### Implement Custom Exception Model

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/integration-guide.md

Extends the base exception model to define a custom table and additional relationships.

```php
<?php

namespace App\Models;

use BezhanSalleh\FilamentExceptions\Models\Exception as BaseException;
use Illuminate\Database\Eloquent\Relations\BelongsTo;

class CustomException extends BaseException
{
    protected $table = 'custom_exceptions_table';

    public function user(): BelongsTo
    {
        return $this->belongsTo(User::class);
    }

    protected function casts(): array
    {
        return array_merge(parent::casts(), [
            // Additional casts
        ]);
    }
}
```

--------------------------------

### Retrieve Exception Class Name

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Returns the short class name without the namespace.

```php
$class = $stored->class(); // 'RuntimeException'
```

--------------------------------

### Handle Missing Model Recovery

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/errors.md

Silent failure check when the model is not set or does not exist.

```php
if (! $model || ! class_exists($model)) {
    return false; // Silent failure
}
```

--------------------------------

### Retrieve application route parameters

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/api-reference.md

Returns a JSON-encoded string of route parameters or null if none exist.

```php
$params = $stored->applicationRouteParametersContext(); // '{"id":123}'
$data = json_decode($params, true);
```

--------------------------------

### Define Route Context Array Structure

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/types.md

Defines the structure for storing matched route information.

```php
array<string, string>
```

--------------------------------

### Define a custom recording callback

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/types.md

Use this closure signature to define custom logic for filtering which exceptions are recorded by the package.

```php
Closure(Throwable): bool
```

```php
$callback = function(Throwable $e): bool {
    return ! $e instanceof ValidationException;
};

FilamentExceptions::recordUsing($callback);
```

--------------------------------

### Process StoredFrame Collections

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/types.md

Shows how to filter and iterate over a collection of StoredFrame objects.

```php
$frames = $stored->frames(); // Collection<int, StoredFrame>

$mainFrames = $frames->filter(fn ($f) => !$f->isFromVendor());

foreach ($frames as $index => $frame) {
    // $index is numeric key
    // $frame is StoredFrame
}
```

--------------------------------

### Set Tenant Relationship Name

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/configuration.md

Defines the method signature and usage for specifying the tenant relationship name.

```php
public function tenantRelationshipName(string | Closure | null $relationshipName): static
```

```php
FilamentExceptionsPlugin::make()
    ->tenantRelationshipName('organization')
    ->tenantRelationshipName('company')
```

--------------------------------

### Retrieve StoredException Instance

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/resources.md

Fetches or initializes the StoredException instance for the current record. Includes defensive logic to handle potential instantiation errors.

```php
public function getStoredException(): StoredException
```

```php
public function getStoredException(): StoredException
{
    if ($this->storedException instanceof StoredException) {
        return $this->storedException;
    }

    try {
        $this->storedException = new StoredException($this->record);
    } catch (Throwable) {
        // If something goes wrong, create with a fresh record
        $this->storedException = new StoredException($this->record);
    }

    return $this->storedException;
}
```

--------------------------------

### Configure global search

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/configuration.md

Enables or disables global search functionality for exceptions.

```php
public function globallySearchable(bool | Closure $condition = true): static
```

```php
FilamentExceptionsPlugin::make()
    ->globallySearchable(true)  // Searchable from panel search
    ->globallySearchable(fn () => auth()->user()?->can('view exceptions'))
```

--------------------------------

### ExceptionResource::table()

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/resources.md

Configures the table display for the exception list view, including column definitions, query optimization, and available actions.

```APIDOC
## ExceptionResource::table()

### Description
Defines the table structure for the exception list, including column configurations, query modifications, and toolbar actions.

### Signature
`public static function table(Table $table): Table`

### Parameters
- **$table** (`Filament\Tables\Table`) - Required - The table builder instance.

### Returns
- **Filament\Tables\Table** - The configured table instance.
```

--------------------------------

### Configure Navigation Group

Source: https://github.com/bezhansalleh/filament-exceptions/blob/main/_autodocs/configuration.md

Set the navigation group label for the plugin.

```php
public function navigationGroup(string | Closure | null $group): static
```

```php
FilamentExceptionsPlugin::make()
    ->navigationGroup('System')
    ->navigationGroup(fn () => auth()->user()?->is_admin ? 'Admin' : 'Tools')
```
Tokens:
Raw