Filament Restore or Create

https://github.com/martinpetricko/filament-restore-or-create
Admin
A FilamentPHP plugin that prevents duplicate records by automatically detecting and restoring...
Tokens:3,238
Snippets:38
Trust Score:5.6
License:MIT
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install Filament Restore or Create Plugin

Source: https://github.com/martinpetricko/filament-restore-or-create/blob/main/README.md

Install the plugin using Composer. This is the initial setup step.

```bash
composer require martinpetricko/filament-restore-or-create
```

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

### Install Filament Restore or Create Package

Source: https://context7.com/martinpetricko/filament-restore-or-create/llms.txt

Install the package via Composer and optionally publish translation files using Artisan.

```bash
composer require martinpetricko/filament-restore-or-create

php artisan vendor:publish --tag="filament-restore-or-create-translations"
```

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

### Customize English Translations

Source: https://context7.com/martinpetricko/filament-restore-or-create/llms.txt

Example of a translation file for the 'actions' module in English. Customize modal headings, descriptions, submit buttons, and notification titles.

```php
<?php
// resources/lang/vendor/filament-restore-or-create/en/actions.php

return [
    'check_deleted' => [
        'modal_heading'    => 'Restore deleted record?',
        'modal_description'=> 'We found a deleted record that is similar to the one you are trying to create. Would you like to restore it?',
        'submit'           => 'Restore',
        'notifications'    => [
            'success' => [
                'title' => 'Restored',
            ],
        ],
    ],
];

```

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

### Basic Setup with CheckDeleted Trait

Source: https://context7.com/martinpetricko/filament-restore-or-create/llms.txt

Add the `CheckDeleted` trait to a Filament `CreateRecord` page to enable duplicate detection and restore functionality. This automatically checks for soft-deleted records matching the resource's title attribute upon form submission.

```php
<?php

namespace App\Filament\Resources\UserResource\Pages;

use App\Filament\Resources\UserResource;
use Filament\Resources\Pages\CreateRecord;
use MartinPetricko\FilamentRestoreOrCreate\Concerns\CreateRecord\CheckDeleted;

class CreateUser extends CreateRecord
{
    use CheckDeleted;

    protected static string $resource = UserResource::class;
}
// When the user submits the create form, the plugin checks for soft-deleted
// User records matching the resource's title attribute. If found, the form
// submission is halted and a restore confirmation modal is shown automatically.
```

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

### Run Plugin Tests

Source: https://github.com/martinpetricko/filament-restore-or-create/blob/main/README.md

Execute the plugin's test suite using Composer.

```bash
composer test
```

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

### Publish Translation Files

Source: https://github.com/martinpetricko/filament-restore-or-create/blob/main/README.md

Optionally, publish the translation files for the plugin using the Artisan command.

```bash
php artisan vendor:publish --tag="filament-restore-or-create-translations"
```

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

### Integrate with Custom beforeCreate Logic

Source: https://github.com/martinpetricko/filament-restore-or-create/blob/main/README.md

When overriding `beforeCreate`, ensure the `CheckDeleted` trait's `beforeCreate` method is called to maintain restore functionality.

```php
class CreateUser extends CreateRecord
{
    use CheckDeleted { 
        beforeCreate as checkDeletedBeforeCreate;
    }

    protected function beforeCreate(): void
    {
        $this->checkDeletedBeforeCreate();
        
        // Your custom logic
    }
}
```

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

### Configure Standalone CheckDeletedAction

Source: https://context7.com/martinpetricko/filament-restore-or-create/llms.txt

Configure the `CheckDeletedAction` directly by overriding `checkDeletedAction()`. This allows customization of the modal's schema, redirect URL, notification, and labels.

```php
<?php

namespace App\Filament\Resources\UserResource\Pages;

use App\Filament\Resources\UserResource;
use Filament\Actions\Action;
use Filament\Notifications\Notification;
use Filament\Resources\Pages\CreateRecord;
use Illuminate\Database\Eloquent\Model;
use MartinPetricko\FilamentRestoreOrCreate\Actions\CheckDeletedAction;
use MartinPetricko\FilamentRestoreOrCreate\Concerns\CreateRecord\CheckDeleted;

class CreateUser extends CreateRecord
{
    use CheckDeleted;

    protected static string $resource = UserResource::class;

    protected function checkDeletedAction(): Action
    {
        return CheckDeletedAction::make()
            ->schema($this->getRestoreSchema())                          // Info list schema shown in modal
            ->restoreRedirectUrl(fn (Model $record) => $this->getRestoreRedirectUrl($record))
            ->successNotification(
                Notification::make()->success()->title('Restored!')
            )
            ->modalHeading('Duplicate Found')
            ->modalDescription('A deleted record with similar details was found. Restore it?')
            ->modalSubmitActionLabel('Yes, Restore');
    }
}
```

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

### Control Modal Display Fields with showDeletedAttributes()

Source: https://context7.com/martinpetricko/filament-restore-or-create/llms.txt

Override the `showDeletedAttributes()` method to specify which model attributes are displayed in the restore confirmation modal. Returning `null` will display all attributes.

```php
<?php

namespace App\Filament\Resources\UserResource\Pages;

use App\Filament\Resources\UserResource;
use Filament\Resources\Pages\CreateRecord;
use MartinPetricko\FilamentRestoreOrCreate\Concerns\CreateRecord\CheckDeleted;

class CreateUser extends CreateRecord
{
    use CheckDeleted;

    protected static string $resource = UserResource::class;

    // Only these fields will be shown in the modal's info list.
    // Keys are automatically converted to headline format (e.g., 'deleted_at' → 'Deleted At').
    protected function showDeletedAttributes(): ?array
    {
        return ['name', 'email', 'phone', 'address', 'deleted_at'];
    }
}
```

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

### Define Attributes for Duplicate Detection

Source: https://github.com/martinpetricko/filament-restore-or-create/blob/main/README.md

Customize which fields are used to detect similar soft-deleted records by overriding the `checkDeletedAttributes` method.

```php
protected function checkDeletedAttributes(): array
{
    return ['name', 'email', 'phone'];
}
```

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

### Customize Redirect After Restore

Source: https://github.com/martinpetricko/filament-restore-or-create/blob/main/README.md

Control the redirect URL after a record is restored by overriding the `getRestoreRedirectUrl` method.

```php
protected function getRestoreRedirectUrl(Model $record): string
{
    /** @var class-string<Resource> $resource */
    $resource = static::getResource();

    if ($resource::hasPage('edit') && $resource::canEdit($record)) {
        return $resource::getUrl('edit', ['record' => $record]);
    }

    return $resource::getUrl();
}
```

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

### Specify Attributes for Confirmation Modal

Source: https://github.com/martinpetricko/filament-restore-or-create/blob/main/README.md

Control which attributes are displayed in the confirmation modal when a potential duplicate is found by overriding `showDeletedAttributes`.

```php
protected function showDeletedAttributes(): ?array
{
    return ['name', 'email', 'phone', 'address', 'deleted_at'];
}
```

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

### Preserve `beforeCreate` Override with Trait Aliasing

Source: https://context7.com/martinpetricko/filament-restore-or-create/llms.txt

When overriding `beforeCreate()`, use trait aliasing to ensure the plugin's detection logic runs alongside your custom code. Call the aliased trait method first.

```php
<?php

namespace App\Filament\Resources\UserResource\Pages;

use App\Filament\Resources\UserResource;
use Filament\Resources\Pages\CreateRecord;
use MartinPetricko\FilamentRestoreOrCreate\Concerns\CreateRecord\CheckDeleted;

class CreateUser extends CreateRecord
{
    // Alias the trait's beforeCreate so it can be called explicitly.
    use CheckDeleted {
        beforeCreate as checkDeletedBeforeCreate;
    }

    protected static string $resource = UserResource::class;

    protected function beforeCreate(): void
    {
        // Must call the trait's method first to retain restore detection.
        $this->checkDeletedBeforeCreate();

        // Your own pre-creation logic runs after.
        $this->data['created_by'] = auth()->id();
        $this->data['ip_address'] = request()->ip();
    }
}
```

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

### Custom Query Logic for Deleted Models

Source: https://github.com/martinpetricko/filament-restore-or-create/blob/main/README.md

Override the `checkDeletedModel` method to define custom logic for finding matching soft-deleted records.

```php
protected function checkDeletedModel(array $data): ?Model
{
    return static::getResource()::getEloquentQuery()
        ->whereLike('name', '%' . $data['name'] . '%')
        ->onlyTrashed()
        ->latest()
        ->first();
}
```

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

### Configure Match Fields with checkDeletedAttributes()

Source: https://context7.com/martinpetricko/filament-restore-or-create/llms.txt

Override the `checkDeletedAttributes()` method to specify which form fields are used for querying soft-deleted records. By default, it uses the resource's title attribute.

```php
<?php

namespace App\Filament\Resources\UserResource\Pages;

use App\Filament\Resources\UserResource;
use Filament\Resources\Pages\CreateRecord;
use MartinPetricko\FilamentRestoreOrCreate\Concerns\CreateRecord\CheckDeleted;

class CreateUser extends CreateRecord
{
    use CheckDeleted;

    protected static string $resource = UserResource::class;

    // Match on name, email, AND phone — all three values from the submitted
    // form data are used in an orWhere query against onlyTrashed() records.
    protected function checkDeletedAttributes(): array
    {
        return ['name', 'email', 'phone'];
    }
}
```

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

### Use CheckDeleted Trait in Filament Resource

Source: https://github.com/martinpetricko/filament-restore-or-create/blob/main/README.md

Add the `CheckDeleted` trait to your Filament resource's `CreateRecord` page to enable duplicate detection.

```php
use MartinPetricko\FilamentRestoreOrCreate\Concerns\CreateRecord\CheckDeleted;

class CreateUser extends CreateRecord
{
    use CheckDeleted;

    protected static string $resource = UserResource::class;
}
```

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

### Customize Restore Notification

Source: https://github.com/martinpetricko/filament-restore-or-create/blob/main/README.md

Customize the success notification shown after a record is restored by overriding the `getRestoredNotification` method.

```php
protected function getRestoredNotification(): ?Notification
{
    return Notification::make()
        ->success()
        ->title('Restored');
}
```

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

### Custom Query Logic with checkDeletedModel()

Source: https://context7.com/martinpetricko/filament-restore-or-create/llms.txt

Override the `checkDeletedModel()` method to implement custom Eloquent query logic for matching soft-deleted records, such as using LIKE queries or additional scopes. This method should return the most recently deleted match or null.

```php
<?php

namespace App\Filament\Resources\UserResource\Pages;

use App\Filament\Resources\UserResource;
use Filament\Resources\Pages\CreateRecord;
use Illuminate\Database\Eloquent\Model;
use MartinPetricko\FilamentRestoreOrCreate\Concerns\CreateRecord\CheckDeleted;

class CreateUser extends CreateRecord
{
    use CheckDeleted;

    protected static string $resource = UserResource::class;

    /**
     * @param array<string, mixed> $data Submitted form data.
     */
    protected function checkDeletedModel(array $data): ?Model
    {
        // Use a LIKE query on name instead of exact match.
        // Returns the most recently deleted match, or null if none found.
        return UserResource::getEloquentQuery()
            ->whereLike('name', '%' . $data['name'] . '%')
            ->onlyTrashed()
            ->latest('deleted_at')
            ->first();
    }
}
```
Tokens:
Raw