Filament Spatie Laravel Backup

https://github.com/shuvroroy/filament-spatie-laravel-backup
Admin
This package provides a Filament page that allows you to create backups of your application,...
Tokens:45,480
Snippets:365
Trust Score:9.5
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install the package via Composer

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/README.md

Use this command to install the Filament Spatie Laravel Backup package via Composer.

```bash
composer require shuvroroy/filament-spatie-laravel-backup
```

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

### Example: retrieving raw status data

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/backup-destination-status-list-records.md

Demonstrates retrieving the raw backup destination status data and iterating over the statuses, showing the available keys.

```php
use ShuvroRoy\FilamentSpatieLaravelBackup\FilamentSpatieLaravelBackup;

$statuses = FilamentSpatieLaravelBackup::getBackupDestinationStatusData(); // list<array{...}>

foreach ($statuses as $status) {
    // $status['name'], $status['disk'], $status['reachable'],
    // $status['healthy'], $status['amount'], $status['newest'],
    // $status['usedStorage']
}
```

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

### Start a queue worker

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/README.md

Start a queue worker to process backup jobs asynchronously. Keep it running with a process monitor.

```bash
php artisan queue:work database
```

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

### Configure queue connection for production

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/README.md

Set the queue connection to database for asynchronous processing, then start a worker. This is recommended for production to avoid blocking Livewire requests.

```dotenv
QUEUE_CONNECTION=database
```

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

### Configure plugin with method calls instead of config file

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/UPGRADE.md

Replace the removed configuration options (backups, interval, queue) with method calls on the plugin object. The example shows using a custom page, queue, polling interval, and disabling status list records table.

```php
<?php

namespace App\Providers\Filament;

use Filament\Panel;
use Filament\PanelProvider;
use App\Filament\Pages\Backups;
use ShuvroRoy\FilamentSpatieLaravelBackup\FilamentSpatieLaravelBackupPlugin;

class AdminPanelProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            // ...
            ->plugin(
                FilamentSpatieLaravelBackupPlugin::make()
                    ->usingPage(Backups::class)
                    ->usingQueue('my-queue')
                    ->usingPollingInterval('10s') // default value is 30s
                    ->statusListRecordsTable(false) // default value is true
            );
    }
}
```

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

### Define Laravel Gates for backup actions

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/README.md

Define the 'create-backup', 'download-backup', and 'delete-backup' Gate abilities in a service provider. Replace the example condition with your application's authorization rule.

```php
<?php

namespace App\Providers;

use App\Models\User;
use Illuminate\Support\Facades\Gate;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    public function boot(): void
    {
        Gate::define('create-backup', fn (User $user): bool => (bool) $user->is_admin);
        Gate::define('download-backup', fn (User $user): bool => (bool) $user->is_admin);
        Gate::define('delete-backup', fn (User $user): bool => (bool) $user->is_admin);
    }
}
```

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

### static get(): static

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup-plugin.md

Returns the current plugin instance. When called from inside register(), returns the registering plugin; otherwise looks up the registered plugin by its ID.

```APIDOC
## static get(): static

### Description
Returns the current plugin instance. When called from inside `register()` (e.g. while Filament registers the page), returns `static::$registeringPlugin`; otherwise looks up the registered plugin by its ID: `filament($instance->getId())`.

### Method
get

### Return
static - The plugin instance.

### Throws
- **LogicException** - "The registered Filament backup plugin has an invalid type." when the plugin registered under the ID is not an instance of this class (`src/FilamentSpatieLaravelBackupPlugin.php:89`).
```

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

### navigationLabel and getNavigationLabel method signatures

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup-plugin.md

Sets or gets the navigation label, default 'Backups' translation. Throws UnexpectedValueException if resolved value is not string or null.

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

public function getNavigationLabel(): string
```

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

### Restrict page access with plugin authorize method

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/README.md

Configure the FilamentSpatieLaravelBackupPlugin to restrict access to the entire page using the authorize method. The example checks if the authenticated user can 'view-backups'.

```php
FilamentSpatieLaravelBackupPlugin::make()
    ->authorize(fn (): bool => auth()->user()?->can('view-backups') ?? false)
```

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

### Error handling for CreateBackupJob dispatch with RuntimeException

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/create-backup-job.md

Shows error handling in consumer code when dispatching CreateBackupJob. The job throws a RuntimeException on non-zero exit codes (e.g., "The backup command failed with exit code 1."). In asynchronous setups the exception fails the queued job, so the catch only runs for synchronous (sync-connection) dispatch paths.

```php
use RuntimeException;
use ShuvroRoy\FilamentSpatieLaravelBackup\Enums\BackupType;
use ShuvroRoy\FilamentSpatieLaravelBackup\Jobs\CreateBackupJob;

try {
    CreateBackupJob::dispatch(BackupType::ONLY_FILES, 300)->onQueue('backups');
} catch (RuntimeException $exception) {
    // e.g. "The backup command failed with exit code 1."
    // In an async setup this exception fails the queued job, so the catch
    // only runs for synchronous (`sync`-connection) dispatch paths.
    report($exception);
}
```

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

### navigationSort and getNavigationSort method signatures

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup-plugin.md

Sets or gets the navigation sort order, default 1. Throws UnexpectedValueException if resolved value is not an integer.

```php
public function navigationSort(int | Closure $navigationSort): static

public function getNavigationSort(): int
```

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

### static get(): static method signature

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup-plugin.md

Returns the current plugin instance. When called from inside register(), returns static::$registeringPlugin; otherwise looks up the registered plugin by its ID: filament($instance->getId()). Throws LogicException if the plugin registered under the ID is not an instance of this class.

```php
public static function get(): static
```

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

### navigationGroup and getNavigationGroup method signatures

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup-plugin.md

Sets or gets the navigation group. Defaults to 'Settings' translation. Throws UnexpectedValueException if resolved value is not string or null.

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

public function getNavigationGroup(): ?string
```

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

### Seeder for backup permissions with Spatie Laravel Permission

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/README.md

Create a seeder to register the backup permissions and assign them to a role. This example uses Spatie Laravel Permission and assigns the permissions to a 'backup' role and a user with ID 1.

```php
<?php

namespace Database\Seeders;

use Illuminate\Database\Seeder;
use Spatie\Permission\Models\Permission;
use Spatie\Permission\Models\Role;

class BackupPermissionSeeder extends Seeder
{
    public function run(): void
    {
        $permissions = [
            'download-backup',
            'delete-backup',
            'create-backup',
        ];

        foreach ($permissions as $permission) {
            Permission::firstOrCreate(['name' => $permission]);
        }

        $role = Role::firstOrCreate(['name' => 'backup']);
        $role->givePermissionTo($permissions);

        $user = \App\Models\User::find(1);

        if ($user && ! $user->hasRole('backup')) {
            $user->assignRole('backup');
        }
    }
}
```

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

### boot(Panel $panel): void method signature

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup-plugin.md

Empty hook (body is //) present to satisfy the Plugin contract.

```php
public function boot(Panel $panel): void
```

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

### Building a CachedBackupDestination

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/cached-backup-destination.md

Shows how the package constructs a CachedBackupDestination, injects a snapshot, and then uses the injected collection and flag.

```php
use ShuvroRoy\FilamentSpatieLaravelBackup\Support\CachedBackupDestination;
use Spatie\Backup\BackupDestination\BackupCollection;

$destination = CachedBackupDestination::create('backups', 'test-app');
$reachable = $destination->connectionError === null;
$backups = new BackupCollection; // empty when unreachable

$destination->useSnapshot($backups, $reachable, $snapshotError);

$destination->backups();     // injected collection
$destination->isReachable(); // injected flag
```

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

### navigationIcon and getNavigationIcon method signatures

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup-plugin.md

Sets or gets the navigation icon, default 'heroicon-o-archive-box-arrow-down'. Throws UnexpectedValueException if resolved value is not a string-backed value.

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

public function getNavigationIcon(): ?string
```

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

### boot(Panel $panel): void

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup-plugin.md

Empty hook method that satisfies the Plugin contract. It does nothing but is required for the interface.

```APIDOC
## boot(Panel $panel): void

### Description
Empty hook (body is `//`), present to satisfy the `Plugin` contract.

### Method
boot

### Parameters
- **$panel** (Panel) - Required - The Filament panel instance.

### Return
void
```

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

### Complete plugin configuration

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/configuration.md

Demonstrates the fluent configuration pattern for the FilamentSpatieLaravelBackupPlugin, including authorization, queue settings, polling intervals, and navigation customization.

```php
FilamentSpatieLaravelBackupPlugin::make()
    ->usingPage(Backups::class)
    ->authorize(fn (): bool => auth()->user()?->can('view-backups') ?? false)
    ->usingQueueConnection('redis')
    ->usingQueue('backups')
    ->usingPollingInterval('60s')       // default '30s', null disables
    ->cacheDuration(60)                 // seconds; 0 disables caching
    ->backupLimit(15)                   // newest 15 records; null = all
    ->statusListRecordsTable(true)      // health summary on/off
    ->timeout(120)                      // job timeout; noTimeout() = 0
    ->cluster(System::class)            // Filament cluster
    ->navigationIcon('heroicon-o-server-stack')
    ->navigationLabel(fn (): string => __('custom.backups'))
    ->navigationGroup(null)             // remove from navigation groups
    ->navigationSort(3);
```

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

### BackupDestinationListRecords downloadBackup method

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/backup-destination-list-records.md

Streams the archive to the browser using the configured disk. Throws whatever the filesystem adapter throws on invalid disk or path.

```php
/** @param array{disk: string, path: string, ...} $record */
protected function downloadBackup(array $record): StreamedResponse
```

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

### Basic dispatch of CreateBackupJob with default queue settings

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/create-backup-job.md

Basic dispatch using the application's default queue connection and queue from config. This is the same pattern used on the page. The backup type is DATABASE_AND_FILES and the timeout is null, meaning no explicit timeout is set.

```php
use ShuvroRoy\FilamentSpatieLaravelBackup\Enums\BackupType;
use ShuvroRoy\FilamentSpatieLaravelBackup\Jobs\CreateBackupJob;

CreateBackupJob::dispatch(BackupType::DATABASE_AND_FILES, null)
    ->onConnection(config('queue.defaults.connection'))
    ->onQueue(config('queue.defaults.queue'));
```

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

### static make(): static

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup-plugin.md

Resolves the plugin from the application container using app(static::class). Throws an exception if the container does not return a valid plugin instance.

```APIDOC
## static make(): static

### Description
Resolves the plugin from the application container: `app(static::class)`.

### Method
make

### Return
static - The plugin instance.

### Throws
- **LogicException** - "The container did not resolve a Filament backup plugin." when the container returns a non-plugin instance (`src/FilamentSpatieLaravelBackupPlugin.php:107`).
```

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

### Import FilamentSpatieLaravelBackup class

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup.md

Import statement for the FilamentSpatieLaravelBackup class.

```php
use ShuvroRoy\FilamentSpatieLaravelBackup\FilamentSpatieLaravelBackup;
```

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

### Read computed polling interval from outside

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/backup-destination-list-records.md

Instantiate the component via the container and call interval() to get the polling interval as a nullable string, e.g. '30s' or null.

```php
$component = app()->make(BackupDestinationListRecords::class);
$interval = $component->interval(); // ?string, e.g. '30s' or null
```

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

### create method

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/backups-page.md

A Livewire action that triggers the backup process. It validates the backup type and dispatches a CreateBackupJob if valid.

```php
public function create(string $type = BackupType::DATABASE_AND_FILES->value): void
```

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

### Configure asynchronous queue connection

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/UPGRADE.md

Configure the plugin to use an asynchronous queue connection and queue for backups, recommended for production to avoid timeouts.

```php
FilamentSpatieLaravelBackupPlugin::make()
    ->usingQueueConnection('redis')
    ->usingQueue('backups')
```

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

### navigationIcon(string | BackedEnum | Closure $navigationIcon): static / getNavigationIcon(): ?string

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup-plugin.md

Sets or gets the navigation icon for the plugin page. Defaults to 'heroicon-o-archive-box-arrow-down'. BackedEnum values are unwrapped and closures are evaluated.

```APIDOC
## navigationIcon(string | BackedEnum | Closure $navigationIcon): static / getNavigationIcon(): ?string

### Description
Sets the navigation icon (default `'heroicon-o-archive-box-arrow-down'`). `BackedEnum` values are unwrapped to their `value`; closures are evaluated.

### Methods
- `navigationIcon(string | BackedEnum | Closure $navigationIcon): static`
- `getNavigationIcon(): ?string`

### Parameters
#### navigationIcon
- **$navigationIcon** (string | BackedEnum | Closure) - Required - The icon name, a BackedEnum, or a closure returning one.

### Return Value
- **static** - Returns the plugin instance for chaining (setter).
- **?string** - The navigation icon string or null (getter).

### Exceptions
- **UnexpectedValueException** - Thrown when the resolved value is not a string: "The navigation icon must resolve to a string-backed value."
```

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

### getMonitorConfigurations method signature

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup.md

Reads config('backup.monitor_backups', []). Non-array entries are skipped; entries must have a string name and an array disks (only strings kept); missing health_checks defaults to [].

```php
/** @return list<array{name: string, disks: list<string>, health_checks: mixed}> */
protected static function getMonitorConfigurations(): array
```

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

### static make(): static method signature

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup-plugin.md

Resolves the plugin from the application container: app(static::class). Throws LogicException if the container returns a non-plugin instance.

```php
public static function make(): static
```

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

### navigationLabel(string | Closure | null $navigationLabel): static / getNavigationLabel(): string

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup-plugin.md

Sets or gets the navigation label for the plugin page. When unset or null, returns the default translation 'Backups'. Closures are evaluated.

```APIDOC
## navigationLabel(string | Closure | null $navigationLabel): static / getNavigationLabel(): string

### Description
Sets the navigation label. When unset or explicitly `null`, the translation `filament-spatie-backup::backup.pages.backups.navigation.label` (`Backups`) is returned. Closures are evaluated.

### Methods
- `navigationLabel(string | Closure | null $navigationLabel): static`
- `getNavigationLabel(): string`

### Parameters
#### navigationLabel
- **$navigationLabel** (string | Closure | null) - Required - The navigation label or a closure returning it. Pass `null` to use the default.

### Return Value
- **static** - Returns the plugin instance for chaining (setter).
- **string** - The navigation label (getter).

### Exceptions
- **UnexpectedValueException** - Thrown when a non-null resolved value is not a string: "The navigation label must resolve to a string or null."
```

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

### Dispatch CreateBackupJob with queue connection and queue

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/create-backup-job.md

Dispatches CreateBackupJob with a chainable queue configuration. The $connection and $queue parameters can be null to use application defaults, or set via the plugin's usingQueueConnection() and usingQueue() methods. With the default sync connection, the job runs inside the Livewire request; production should use an asynchronous connection and run php artisan queue:work.

```php
CreateBackupJob::dispatch($backupType, $timeout)
    ->onConnection($connection)
    ->onQueue($queue);
```

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

### navigationSort(int | Closure $navigationSort): static / getNavigationSort(): int

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup-plugin.md

Sets or gets the navigation sort order for the plugin page. Defaults to 1. Closures are evaluated and invalid values throw an exception.

```APIDOC
## navigationSort(int | Closure $navigationSort): static / getNavigationSort(): int

### Description
Sets the navigation sort order (default `1`). Closures are evaluated.

### Methods
- `navigationSort(int | Closure $navigationSort): static`
- `getNavigationSort(): int`

### Parameters
#### navigationSort
- **$navigationSort** (int | Closure) - Required - The sort order integer or a closure returning it.

### Return Value
- **static** - Returns the plugin instance for chaining (setter).
- **int** - The navigation sort order (getter).

### Exceptions
- **UnexpectedValueException** - Thrown when the resolved value is not an int: "The navigation sort must resolve to an integer."
```

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

### openOptionModal(): void

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/backups-page.md

Dispatches a Livewire browser event to open the backup type selection modal.

```APIDOC
## openOptionModal(): void

### Description
Dispatches a Livewire browser event to open the backup type selection modal.

### Method
Instance method

### Signature
```php
public function openOptionModal(): void
```

### Behavior
Dispatches the Livewire browser event `open-modal` with id `backup-option`.

### Return Value
- **void**
```

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

### navigationGroup(string | Closure | null $navigationGroup): static / getNavigationGroup(): ?string

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup-plugin.md

Sets or gets the navigation group for the plugin page. When unset, returns the default translation 'Settings'. Closures are evaluated and invalid values throw an exception.

```APIDOC
## navigationGroup(string | Closure | null $navigationGroup): static / getNavigationGroup(): ?string

### Description
Sets the navigation group, or `null` to remove the page from any group. When the group was never set explicitly, the default translation `filament-spatie-backup::backup.pages.backups.navigation.group` (`Settings`) is returned. Closures are evaluated.

### Methods
- `navigationGroup(string | Closure | null $navigationGroup): static`
- `getNavigationGroup(): ?string`

### Parameters
#### navigationGroup
- **$navigationGroup** (string | Closure | null) - Required - The navigation group value or a closure returning it. Pass `null` to remove from any group.

### Return Value
- **static** - Returns the plugin instance for chaining (setter).
- **?string** - The navigation group string or null (getter).

### Exceptions
- **UnexpectedValueException** - Thrown when the resolved value is non-null and not a string: "The navigation group must resolve to a string or null."
```

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

### Package usage pattern: building BackupCollection from CachedBackup

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/cached-backup.md

Shows how the package constructs CachedBackup instances from a backup listing and wraps them in a BackupCollection. This pattern is used in FilamentSpatieLaravelBackup::getBackupDestinationStatusData().

```php
$cachedBackups[] = new CachedBackup(
    $filesystem,
    $backup['path'],
    Carbon::createFromTimestamp($backup['timestamp']),
    $backup['size'],
);

$backups = new BackupCollection($cachedBackups);
```

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

### CreateBackupJob handle() method signature

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/create-backup-job.md

The queue worker entry point. It sets the time limit if possible, invokes the backup command via Artisan, checks the exit code, and clears backup destination caches.

```php
public function handle(): void
```

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

### loadBackupDestinationSnapshot method signature

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup.md

Lists the disk via Storage::disk, filters to backup archives, maps each to {path, timestamp, size}, and sorts descending. Any Throwable is caught and returned as {reachable: false, error: message, backups: []}.

```php
/** @return array{reachable: bool, error: ?string, backups: array<int, array{path: string, timestamp: int, size: float}>} */
protected static function loadBackupDestinationSnapshot(string $disk, string $backupName): array
```

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

### CachedBackup constructor signature

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/cached-backup.md

The public constructor accepts a Filesystem disk, path, backupDate, and backupSize. It sets disk, path, and exists to true, skipping parent existence checks to avoid per-file requests on remote disks.

```php
public function __construct(
    Filesystem $disk,
    string $path,
    protected Carbon $backupDate,
    protected float $backupSize,
)
```

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

### Configure backup queue connection and queue in Filament panel provider

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/README.md

Routes backup jobs to a dedicated queue connection and queue using the plugin's usingQueueConnection() and usingQueue() methods. Requires a non-sync connection and a running queue worker; otherwise backups run synchronously in the Livewire request and may exceed server timeouts.

```php
<?php

namespace App\Providers\Filament;

use Filament\Panel;
use Filament\PanelProvider;
use ShuvroRoy\FilamentSpatieLaravelBackup\FilamentSpatieLaravelBackupPlugin;

class AdminPanelProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            // ...
            ->plugin(
                FilamentSpatieLaravelBackupPlugin::make()
                    ->usingQueueConnection('redis')
                    ->usingQueue('backups')
            );
    }
}
```

```bash
php artisan queue:work redis --queue=backups
```

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

### Handling disk-resolution failure

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/cached-backup-destination.md

Demonstrates how to handle a disk-resolution failure. create() never throws for resolution failures; the caller checks connectionError and reports it.

```php
use ShuvroRoy\FilamentSpatieLaravelBackup\Support\CachedBackupDestination;

try {
    $destination = CachedBackupDestination::create('missing-disk', 'test-app');

    if ($destination->connectionError !== null) {
        // The disk could not be resolved; the destination is unusable and
        // is considered unreachable by the status API.
        report($destination->connectionError);
    }
} catch (Exception $exception) {
    // create() itself never throws for resolution failures —
    // this branch only catches exceptions before the call.
    report($exception);
}
```

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

### Package configuration chain

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/service-provider.md

Sets the package name to 'filament-spatie-backup', enables translations, and registers views.

```php
$package
    ->name('filament-spatie-backup')
    ->hasTranslations()
    ->hasViews();
```

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

### listBackupAttributes method signature

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup.md

For FilesystemAdapter instances, uses getDriver()->listContents($backupName, true)->toArray() (recursive, includes directory metadata); otherwise uses $filesystem->allFiles($backupName).

```php
/** @return array<int, StorageAttributes|string> */
protected static function listBackupAttributes(Filesystem $filesystem, string $backupName): array
```

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

### CachedBackup::__construct

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/cached-backup.md

Constructor for CachedBackup. Accepts a filesystem disk, archive path, backup date, and backup size. It assigns disk and path, sets exists to true, and skips the parent constructor's per-file existence checks.

```APIDOC
## CachedBackup::__construct

### Description
Constructor for the CachedBackup class. It initializes the backup with a disk, path, backup date, and backup size, and sets exists to true without performing per-file checks.

### Method
Constructor

### Signature
```php
public function __construct(
    Filesystem $disk,
    string $path,
    protected Carbon $backupDate,
    protected float $backupSize,
)
```

### Parameters
- **disk** (Illuminate\Contracts\Filesystem\Filesystem) - Required - The storage disk the archive lives on.
- **path** (string) - Required - Archive path within the disk.
- **backupDate** (Carbon\Carbon) - Required - Backup timestamp supplied from the directory listing.
- **backupSize** (float) - Required - Archive size in bytes supplied from the directory listing.

### Description
Assigns $this->disk, $this->path, and sets $this->exists = true directly, deliberately skipping the parent Backup constructor's per-file existence checks.
```

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

### packageBooted method signature

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/service-provider.md

Declares the packageBooted method that runs after the package is booted.

```php
public function packageBooted(): void
```

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

### Constructing a cached backup from snapshot data

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/cached-backup.md

Shows creating a CachedBackup instance using a Storage disk, path, Carbon timestamp, and size. The resulting object's date() and sizeInBytes() methods return the cached values.

```php
use Carbon\Carbon;
use ShuvroRoy\FilamentSpatieLaravelBackup\Support\CachedBackup;
use Illuminate\Support\Facades\Storage;

$filesystem = Storage::disk('backups');

$backup = new CachedBackup(
    $filesystem,
    'test-app/only-db-2026-08-24-02-00-00.zip',
    Carbon::createFromTimestamp(1_755_000_000),
    1_048_576.0,
);

$backup->date();       // Carbon copy
$backup->sizeInBytes(); // 1048576.0
```

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

### Register multiple plugins at once

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/README.md

Use the plugins method to register several plugins at once. Do not pass multiple plugins to plugin() as it only accepts one.

```php
return $panel->plugins([
    FirstPlugin::make(),
    FilamentSpatieLaravelBackupPlugin::make(),
]);
```

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

### getBackupDestinationData() method signature

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup.md

Loads the snapshot for $disk and maps each backup to a table record. $cacheDuration = 0 disables caching; otherwise the snapshot is served from the Cache store. Known behavior: an unreachable disk yields an empty list.

```php
/**
 * @return list<array{key: string, disk: string, path: string, type: string, date: string, size: string}>
 */
public static function getBackupDestinationData(
    string $disk,
    int $cacheDuration = self::DEFAULT_CACHE_DURATION,
): array
```

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

### getDisks() method signature

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup.md

Reads the configured destination disk names from config('backup.backup.destination.disks', []). Non-string entries are skipped; a non-array config yields []. Returns list<string> of disk names.

```php
/** @return list<string> */
public static function getDisks(): array
```

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

### configurePackage method signature

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/service-provider.md

Declares the configurePackage method that configures the package name, translations, and views.

```php
public function configurePackage(Package $package): void
```

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

### CreateBackupJob constructor

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/create-backup-job.md

Defines the job's constructor with a BackupType parameter (defaulting to DATABASE_AND_FILES) and an optional timeout parameter. Both are readonly promoted properties; type is protected, timeout is public.

```php
public function __construct(
    protected readonly BackupType $type = BackupType::DATABASE_AND_FILES,
    public readonly ?int $timeout = null,
) {}
```

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

### getHeaderActions method

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/backups-page.md

Builds the header action list, specifically the 'Create Backup' button. It is only visible if the user has the 'create-backup' permission.

```php
protected function getHeaderActions(): array
```

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

### Run tests with composer test

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/README.md

Executes the package test suite using Composer. Run this command from the project root to verify the codebase.

```bash
composer test
```

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

### Run the backup permission seeder

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/README.md

Command to run the BackupPermissionSeeder using artisan db:seed.

```bash
php artisan db:seed --class=BackupPermissionSeeder
```

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

### Detect backup type and clear caches

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup.md

Detects the backup type from a path and asserts it matches ONLY_DATABASE. Shows how to clear the cache for a specific destination or all caches after external mutations.

```php
use ShuvroRoy\FilamentSpatieLaravelBackup\Enums\BackupType;
use ShuvroRoy\FilamentSpatieLaravelBackup\FilamentSpatieLaravelBackup;

$type = FilamentSpatieLaravelBackup::detectBackupType($backupPath); // BackupType
assert($type === BackupType::ONLY_DATABASE);

// After mutating backup files externally:
FilamentSpatieLaravelBackup::clearBackupDestinationCache('local', config()->string('backup.backup.name'));
// or, for everything:
FilamentSpatieLaravelBackup::clearBackupDestinationCaches();
```

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

### Full plugin configuration with error-prone values

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup-plugin.md

Configures the plugin with custom page, authorization, queue, polling interval, cache duration, backup limit, table display, timeout, cluster, navigation icon, label, group, and sort. Note that some values like negative cacheDuration will throw exceptions.

```php
use App\Filament\Clusters\System;
use App\Filament\Pages\Backups; // extends the package page

return $panel->plugin(
    FilamentSpatieLaravelBackupPlugin::make()
        ->usingPage(Backups::class)
        ->authorize(fn (): bool => auth()->user()?->can('view-backups') ?? false)
        ->usingQueueConnection('redis')
        ->usingQueue('backups')
        ->usingPollingInterval('60s')
        ->cacheDuration(60)
        ->backupLimit(15)
        ->statusListRecordsTable(false)
        ->timeout(120)
        ->cluster(System::class)
        ->navigationIcon('heroicon-o-server-stack')
        ->navigationLabel(fn (): string => __('custom.backups'))
        ->navigationGroup(fn (): ?string => auth()->user()?->isAdmin() === true ? 'Admin' : 'Tools')
        ->navigationSort(3)
);
```

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

### Static factory create() signature

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/cached-backup-destination.md

Declares the static factory method that resolves the storage disk and constructs the destination. On failure, it captures the exception in connectionError without propagating.

```php
public static function create(string $diskName, string $backupName): self
```

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

### backups() method signature

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/cached-backup-destination.md

Returns the cached backup collection when set, otherwise delegates to the parent's live backups().

```php
public function backups(): BackupCollection
```

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

### Register Livewire components

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/service-provider.md

Registers the two Livewire components for backup destination lists and status lists.

```php
Livewire::component('backup-destination-list-records', BackupDestinationListRecords::class);
Livewire::component('backup-destination-status-list-records', BackupDestinationStatusListRecords::class);
```

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

### Use BackupType enum and detectBackupType

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/README.md

Manual backup creation, filename detection, and table filtering use the same enum values. detectBackupType returns a BackupType instance.

```php
use ShuvroRoy\FilamentSpatieLaravelBackup\Enums\BackupType;
use ShuvroRoy\FilamentSpatieLaravelBackup\FilamentSpatieLaravelBackup;

BackupType::ONLY_DATABASE->value;      // only-db
BackupType::ONLY_FILES->value;         // only-files
BackupType::DATABASE_AND_FILES->value; // db-and-files

$type = FilamentSpatieLaravelBackup::detectBackupType($backupPath); // BackupType
```

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

### Publish assets command

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/service-provider.md

Artisan command to publish the package's assets.

```bash
php artisan filament:assets
```

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

### BackupDestinationListRecords deleteBackup method

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/backup-destination-list-records.md

Deletes the archive from the disk. Throws RuntimeException if deletion fails, otherwise clears caches, resets the table, and sends a success notification.

```php
/** @param array{disk: string, path: string, ...} $record */
protected function deleteBackup(array $record): void
```

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

### sizeInBytes() method signature

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/cached-backup.md

The sizeInBytes() method returns the injected backupSize as float bytes without querying the filesystem.

```php
public function sizeInBytes(): float
```

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

### openOptionModal method

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/backups-page.md

Dispatches the 'open-modal' browser event to display the type-selection modal with the ID 'backup-option'.

```php
public function openOptionModal(): void
```

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

### getBackupDestinationSnapshot method signature

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup.md

Returns loadBackupDestinationSnapshot(...) directly when cacheDuration is 0, otherwise uses Cache::remember with the snapshot cache key and the given duration.

```php
/** @return array{reachable: bool, error: ?string, backups: array<int, array{path: string, timestamp: int, size: float}>} */
protected static function getBackupDestinationSnapshot(
    string $disk,
    string $backupName,
    int $cacheDuration,
): array
```

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

### CreateBackupJob::__construct

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/create-backup-job.md

Constructor for the CreateBackupJob class. Accepts a BackupType enum and an optional timeout in seconds.

```APIDOC
## CreateBackupJob::__construct

### Description
Creates a new CreateBackupJob instance with the specified backup type and timeout.

### Method
Constructor

### Signature
```php
public function __construct(
    protected readonly BackupType $type = BackupType::DATABASE_AND_FILES,
    public readonly ?int $timeout = null,
) {}
```

### Parameters
- **type** (BackupType enum) - Optional - Default: `BackupType::DATABASE_AND_FILES` - Which archive to create; controls the `--only-db` / `--only-files` flags and the filename.
- **timeout** (?int) - Optional - Default: `null` - Backup timeout in seconds; `null` = PHP/queue-worker defaults, `0` = never timeout.

### Notes
- `type` and `timeout` are readonly promoted properties: `type` is protected, `timeout` is public.
```

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

### List backups for a disk with custom cache duration

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup.md

Retrieves backup destination data for a specific disk with a cache duration of 0 (no caching). Iterates over records and prints key, disk, path, type, date, and size.

```php
use ShuvroRoy\FilamentSpatieLaravelBackup\FilamentSpatieLaravelBackup;
use ShuvroRoy\FilamentSpatieLaravelBackup\Enums\BackupType;

$records = FilamentSpatieLaravelBackup::getBackupDestinationData('s3-backups', 0); // no cache

foreach ($records as $record) {
    echo $record['key'] . ' ' . $record['disk'] . ' ' . $record['path'] . "\n";
    echo $record['type'] . ' ' . $record['date'] . ' ' . $record['size'] . "\n";
}
```

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

### usingPage(string $page): static / getPage(): string

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup-plugin.md

Sets or returns the page class registered on the panel. Defaults to Backups::class. Used to register a custom subclass of Pages\Backups.

```APIDOC
## usingPage(string $page): static

### Description
Sets the page class registered on the panel. Defaults to Backups::class. Used to register a custom subclass of Pages\Backups.

### Method
PHP method

### Signature
public function usingPage(string $page): static

### Parameters
- **$page** (string) - Required - The class-string of the page class to use.

### Returns
- **static** - Returns the instance for chaining.

## getPage(): string

### Description
Returns the page class registered on the panel. Defaults to Backups::class.

### Method
PHP method

### Signature
public function getPage(): string

### Returns
- **string** - The class-string of the page class.
```

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

### usingPage(string $page): static / getPage(): string

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup-plugin.md

Sets or returns the page class registered on the panel. Default is Backups::class. Used to register a custom subclass of Pages\Backups.

```php
/** @param class-string<Backups> $page */
public function usingPage(string $page): static

/** @return class-string<Backups> */
public function getPage(): string
```

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

### Headless dispatch of a backup

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/backups-page.md

Manually dispatch a CreateBackupJob to trigger a backup outside of the Filament page interface.

```php
use ShuvroRoy\FilamentSpatieLaravelBackup\Enums\BackupType;
use ShuvroRoy\FilamentSpatieLaravelBackup\Jobs\CreateBackupJob;

CreateBackupJob::dispatch(BackupType::ONLY_DATABASE, null)
    ->onConnection(config('queue.defaults.connection'))
    ->onQueue(config('queue.defaults.queue'));
```

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

### getFilterDisks() method signature

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup.md

Maps every disk from getDisks() to a capitalized display label: $result[$value] = ucfirst($value). Returns array<string, string> (disk name → label), used as SelectFilter options in the list component.

```php
/** @return array<string, string> */
public static function getFilterDisks(): array
```

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

### CreateBackupJob::handle

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/create-backup-job.md

Queue worker entry point that executes the backup command via Artisan, checks the exit code, and clears backup destination caches.

```APIDOC
## CreateBackupJob::handle

### Description
Runs the backup command through the Artisan facade, sets a time limit if configured, checks the exit code, and clears backup destination caches.

### Method
handle

### Signature
```php
public function handle(): void
```

### Behavior
1. **Time limit** - When `timeout !== null` and `canSetTimeLimit()` is true, calls `set_time_limit($this->timeout)`. On hosts where `set_time_limit` does not exist, this step is skipped.
2. **Command** - Invokes the console command through the Artisan facade:
   ```php
   $exitCode = Artisan::call(BackupCommand::class, [
       '--only-db' => $this->type === BackupType::ONLY_DATABASE,
       '--only-files' => $this->type === BackupType::ONLY_FILES,
       '--filename' => match ($this->type) {
           BackupType::DATABASE_AND_FILES => null,
           default => $this->type->value . '-' . date('Y-m-d-H-i-s') . '.zip',
       },
       '--timeout' => $canSetTimeLimit ? $this->timeout : null,
   ]);
   ```
   - Combined backups use Spatie's default filename; single-type backups use `only-db-<timestamp>.zip` / `only-files-<timestamp>.zip`.
3. **Exit-code check** - When `$exitCode !== Command::SUCCESS` (0), throws a RuntimeException.
4. **Cache invalidation** - Calls `FilamentSpatieLaravelBackup::clearBackupDestinationCaches()`; any Throwable is reported via `report($exception)`.

### Throws
- **RuntimeException** - "The backup command failed with exit code {exitCode}." when the command's exit code is not `Command::SUCCESS`.
```

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

### Guard download and delete actions with Laravel Gates

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/backup-destination-list-records.md

Define 'download-backup' and 'delete-backup' gates to control visibility of the download/delete row actions. Without these abilities, the actions are hidden; with them, delete requires confirmation.

```php
use Illuminate\Support\Facades\Gate;

Gate::define('download-backup', fn ($user): bool => (bool) $user->is_admin);
Gate::define('delete-backup', fn ($user): bool => (bool) $user->is_admin);

// Without these abilities granted, the download/delete row actions are
// simply not visible; with them granted, delete requires confirmation.
```

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

### snapshotCacheKey method signature

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup.md

Returns a cache key string using hash('sha256', $disk . "\0" . $backupName) with the prefix 'filament-spatie-backup:snapshot:'.

```php
protected static function snapshotCacheKey(string $disk, string $backupName): string
```

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

### register(Panel $panel): void method signature

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup-plugin.md

Registers the plugin's page on the panel. Sets static::$registeringPlugin, calls $panel->pages([$this->getPage()]), and resets registeringPlugin in a finally block. Called by Filament when the plugin is passed to Panel::plugin() or Panel::plugins().

```php
public function register(Panel $panel): void
```

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

### create(string $type = BackupType::DATABASE_AND_FILES->value): void

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/backups-page.md

Livewire-triggered action that creates a backup job based on the given backup type. Invalid types are reported via a danger notification and no job is dispatched.

```APIDOC
## create(string $type = BackupType::DATABASE_AND_FILES->value): void

### Description
Livewire-triggered action that creates a backup job based on the given backup type. Invalid types are reported via a danger notification and no job is dispatched.

### Method
Instance method

### Signature
```php
public function create(string $type = BackupType::DATABASE_AND_FILES->value): void
```

### Parameters
- **$type** (string) - Required - The backup type value. Must map to a BackupType enum case. Defaults to `BackupType::DATABASE_AND_FILES->value`.

### Behavior
1. Resolves `BackupType::tryFrom($type)`. If the value does not map to an enum case, sends a danger `Notification` (title `filament-spatie-backup::backup.pages.backups.modal.label`) and returns without dispatching a job.
2. Otherwise fetches the plugin via `filament()->getPlugin('filament-spatie-backup')` and dispatches `CreateBackupJob::dispatch($backupType, $plugin->getTimeout())->onConnection($plugin->getQueueConnection())->onQueue($plugin->getQueue())`.
3. Closes the modal (`close-modal`, id `backup-option`) and sends a success `Notification` (`...messages.backup_success` — "Creating a new backup in background.").

### Return Value
- **void** (Livewire action). Does not throw on user error — an invalid type is reported via a danger notification.
```

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

### getBackupDestinationStatusData(int $cacheDuration = self::DEFAULT_CACHE_DURATION): array

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup.md

Builds the health summary for every configured monitor. For each monitor and disk, it loads the snapshot, creates a CachedBackupDestination, and constructs a BackupDestinationStatus to determine reachability, health, backup count, newest backup, and used storage.

```APIDOC
## getBackupDestinationStatusData(int $cacheDuration = self::DEFAULT_CACHE_DURATION): array

### Description
Builds the health summary for every configured monitor. For each monitor in getMonitorConfigurations() and each of its disks, it loads the snapshot, creates a CachedBackupDestination, and constructs a BackupDestinationStatus to determine reachability, health, backup count, newest backup, and used storage.

### Method
Static method

### Signature
public static function getBackupDestinationStatusData(int $cacheDuration = self::DEFAULT_CACHE_DURATION): array

### Parameters
- **$cacheDuration** (int) - Optional - Cache duration in seconds. Defaults to self::DEFAULT_CACHE_DURATION.

### Return Value
Returns a list of associative arrays with the following keys:
- **id** (string) - Deterministic identifier: sha1($disk . "\0" . $name)
- **name** (string) - Backup name
- **disk** (string) - Disk name
- **reachable** (bool) - Whether the destination is reachable
- **healthy** (bool) - Whether the backup destination is healthy
- **amount** (int) - Number of backups
- **newest** (string) - Human-readable date of the newest backup or the 'no_backups_present' translation
- **usedStorage** (string) - Human-readable size of all backups

### Example
```php
$statusData = getBackupDestinationStatusData();
```
```

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

### usingQueueConnection(string $connection): static / getQueueConnection(): ?string

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup-plugin.md

Sets or returns the queue connection name used for CreateBackupJob dispatch. null means application default connection. The README requires a non-sync connection and a running worker for production; a sync connection runs the backup inside the Livewire request.

```php
public function usingQueueConnection(string $connection): static

public function getQueueConnection(): ?string
```

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

### isBackupFile method signature

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup.md

Returns true when the path extension (lowercased) is zip, or the mime type is one of application/zip, application/x-zip, application/x-gzip (case-insensitive).

```php
protected static function isBackupFile(string $path, ?string $mimeType = null): bool
```

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

### Publish translations command

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/service-provider.md

Artisan command to publish the localization files.

```bash
php artisan vendor:publish --tag="filament-spatie-backup-translations"
```

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

### Publish Spatie backup configuration

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/UPGRADE.md

Publish the Spatie backup configuration if not already published, required for v4.0.

```sh
php artisan vendor:publish --provider="Spatie\Backup\BackupServiceProvider" --tag="backup-config"
```

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

### getId(): string method signature

Source: https://github.com/shuvroroy/filament-spatie-laravel-backup/blob/main/_autodocs/api-reference/filament-spatie-laravel-backup-plugin.md

Returns the plugin ID 'filament-spatie-backup'.

```php
public function getId(): string
```
Tokens:
Raw