Some checks failed
CI / PHP 8.3 / mariadb:10.6 (pull_request) Successful in 1m14s
CI / PHP 8.4 / mariadb:10.6 (pull_request) Successful in 1m12s
CI / PHP 8.4 / mariadb:11.4 (pull_request) Successful in 1m7s
CI / PHP 8.3 / mariadb:11.4 (pull_request) Successful in 1m19s
CI / PHP 8.3 / mysql:8.0 (pull_request) Successful in 1m32s
CI / PHP 8.4 / mysql:8.0 (pull_request) Successful in 1m22s
CI / PHP 8.4 / mysql:8.4 (pull_request) Successful in 1m32s
CI / PHP 8.3 / mysql:8.4 (pull_request) Successful in 1m35s
CI / Build-Artefakte aktuell (pull_request) Failing after 1m7s
- Laravel 13 mit Filament 5 (Admin), Inertia 3 + Vue 3 + Vuetify 4 (Material 3) - Anmeldung über Fortify (Login, Passwort vergessen/ändern), keine Selbstregistrierung - Profil mit Profilbild (WebP in festen Größen), Personenseiten, Header mit Avatar-Menü - Material-3-Farbschema aus der Primärfarbe, hell/dunkel/System pro Person - Basis-Branding (Portalname, Logo, Primärfarbe) im Admin unter „Erscheinungsbild“ - Benutzerverwaltung im Admin, Zugang vorläufig über is_admin - vendor/ (ohne Dev-Pakete) und Frontend-Build mitversioniert, Dev-Pakete in vendor-dev/ - PHPUnit-Tests gegen MySQL/MariaDB, Forgejo-CI-Matrix, Docker-Entwicklungsumgebung - VERSION, CHANGELOG.md und CONTRIBUTING.md mit Release-Ablauf Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
155 lines
5.7 KiB
Markdown
155 lines
5.7 KiB
Markdown
---
|
|
title: Replicate action
|
|
---
|
|
import AutoScreenshot from "@components/AutoScreenshot.astro"
|
|
import UtilityInjection from "@components/UtilityInjection.astro"
|
|
|
|
## Introduction
|
|
|
|
Filament includes an action that is able to [replicate](https://laravel.com/docs/eloquent#replicating-models) Eloquent records. You may use it like so:
|
|
|
|
```php
|
|
use Filament\Actions\ReplicateAction;
|
|
|
|
ReplicateAction::make()
|
|
```
|
|
|
|
<AutoScreenshot name="actions/replicate-action/modal" alt="Replicate action modal" version="5.x" />
|
|
|
|
## Excluding attributes
|
|
|
|
The `excludeAttributes()` method is used to instruct the action which columns should be excluded from replication:
|
|
|
|
```php
|
|
use Filament\Actions\ReplicateAction;
|
|
|
|
ReplicateAction::make()
|
|
->excludeAttributes(['slug'])
|
|
```
|
|
|
|
## Customizing data before filling the form
|
|
|
|
You may wish to modify the data from a record before it is filled into the form. To do this, you may use the `mutateRecordDataUsing()` method to modify the `$data` array, and return the modified version before it is filled into the form:
|
|
|
|
```php
|
|
use Filament\Actions\ReplicateAction;
|
|
|
|
ReplicateAction::make()
|
|
->mutateRecordDataUsing(function (array $data): array {
|
|
$data['user_id'] = auth()->id();
|
|
|
|
return $data;
|
|
})
|
|
```
|
|
|
|
## Redirecting after replication
|
|
|
|
You may set up a custom redirect when the form is submitted using the `successRedirectUrl()` method:
|
|
|
|
```php
|
|
use Filament\Actions\ReplicateAction;
|
|
|
|
ReplicateAction::make()
|
|
->successRedirectUrl(route('posts.list'))
|
|
```
|
|
|
|
<UtilityInjection set="actions" version="5.x" extras="Replica Eloquent record;;Illuminate\Database\Eloquent\Model;;$replica;;The Eloquent model instance that was just created as a replica of the original record.">As well as `$record`, the `successRedirectUrl()` function can inject various utilities as parameters.</UtilityInjection>
|
|
|
|
## Customizing the replicate notification
|
|
|
|
When the record is successfully replicated, a notification is dispatched to the user, which indicates the success of their action.
|
|
|
|
To customize the title of this notification, use the `successNotificationTitle()` method:
|
|
|
|
```php
|
|
use Filament\Actions\ReplicateAction;
|
|
|
|
ReplicateAction::make()
|
|
->successNotificationTitle('Category replicated')
|
|
```
|
|
|
|
<UtilityInjection set="actions" version="5.x" extras="Replica Eloquent record;;Illuminate\Database\Eloquent\Model;;$replica;;The Eloquent model instance that was just created as a replica of the original record.">As well as allowing a static value, the `successNotificationTitle()` method also accepts a function to dynamically calculate it. You can inject various utilities into the function as parameters.</UtilityInjection>
|
|
|
|
You may customize the entire notification using the `successNotification()` method:
|
|
|
|
```php
|
|
use Filament\Actions\ReplicateAction;
|
|
use Filament\Notifications\Notification;
|
|
|
|
ReplicateAction::make()
|
|
->successNotification(
|
|
Notification::make()
|
|
->success()
|
|
->title('Category replicated')
|
|
->body('The category has been replicated successfully.'),
|
|
)
|
|
```
|
|
|
|
<UtilityInjection set="actions" version="5.x" extras="Notification;;Filament\Notifications\Notification;;$notification;;The default notification object, which could be a useful starting point for customization.||Replica Eloquent record;;Illuminate\Database\Eloquent\Model;;$replica;;The Eloquent model instance that was just created as a replica of the original record.">As well as allowing a static value, the `successNotification()` method also accepts a function to dynamically calculate it. You can inject various utilities into the function as parameters.</UtilityInjection>
|
|
|
|
To disable the notification altogether, use the `successNotification(null)` method:
|
|
|
|
```php
|
|
use Filament\Actions\ReplicateAction;
|
|
|
|
ReplicateAction::make()
|
|
->successNotification(null)
|
|
```
|
|
|
|
## Lifecycle hooks
|
|
|
|
Hooks may be used to execute code at various points within the action's lifecycle, like before the replica is saved.
|
|
|
|
```php
|
|
use Filament\Actions\ReplicateAction;
|
|
use Illuminate\Database\Eloquent\Model;
|
|
|
|
ReplicateAction::make()
|
|
->before(function () {
|
|
// Runs before the record has been replicated.
|
|
})
|
|
->beforeReplicaSaved(function (Model $replica): void {
|
|
// Runs after the record has been replicated but before it is saved to the database.
|
|
})
|
|
->after(function (Model $replica): void {
|
|
// Runs after the replica has been saved to the database.
|
|
})
|
|
```
|
|
|
|
<UtilityInjection set="actions" version="5.x" extras="Replica Eloquent record;;Illuminate\Database\Eloquent\Model;;$replica;;The Eloquent model instance that was just created as a replica of the original record.">These hook functions can inject various utilities as parameters.</UtilityInjection>
|
|
|
|
## Halting the replication process
|
|
|
|
At any time, you may call `$action->halt()` from inside a lifecycle hook, which will halt the entire replication process:
|
|
|
|
```php
|
|
use App\Models\Post;
|
|
use Filament\Actions\Action;
|
|
use Filament\Actions\ReplicateAction;
|
|
use Filament\Notifications\Notification;
|
|
|
|
ReplicateAction::make()
|
|
->before(function (ReplicateAction $action, Post $record) {
|
|
if (! $record->team->subscribed()) {
|
|
Notification::make()
|
|
->warning()
|
|
->title('You don\'t have an active subscription!')
|
|
->body('Choose a plan to continue.')
|
|
->persistent()
|
|
->actions([
|
|
Action::make('subscribe')
|
|
->button()
|
|
->url(route('subscribe'), shouldOpenInNewTab: true),
|
|
])
|
|
->send();
|
|
|
|
$action->halt();
|
|
}
|
|
})
|
|
```
|
|
|
|
If you'd like the action modal to close too, you can completely `cancel()` the action instead of halting it:
|
|
|
|
```php
|
|
$action->cancel();
|
|
```
|