05-edit

---

title: Edit action

---

Introduction

Platform includes an action that is able to edit Eloquent records. When the trigger button is clicked, a modal will open with a form inside. The user fills the form, and that data is validated and saved into the database. You may use it like so:

use Webkernel\Platform\Actions\EditAction;
use Webkernel\Platform\Forms\Components\TextInput;

EditAction::make()
    ->schema([
        TextInput::make('title')
            ->required()
            ->maxLength(255),
        // ...
    ])

<AutoScreenshot name="actions/edit-action/modal" alt="Edit action modal" />

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:

use Webkernel\Platform\Actions\EditAction;

EditAction::make()
    ->mutateRecordDataUsing(function (array $data): array {
        $data['user_id'] = auth()->id();

        return $data;
    })

<UtilityInjection set="actions">As well as $data, the mutateRecordDataUsing() function can inject various utilities as parameters.</UtilityInjection>

<Aside variant="warning"> Platform fills the form using the record's array representation, which is sent to the browser as part of the Livewire request. If your model has a column containing binary data that is not valid UTF-8, such as a geometry, point, or blob column, it cannot be serialized to JSON and the modal will fail to open, often with no error in the Laravel log.

To resolve this, add the column to the $hidden array on your model, which excludes it from the model's array and JSON representations:

``php protected $hidden = ['location']; ``

This applies equally to the View and Replicate actions. </Aside>

Customizing data before saving

Sometimes, you may wish to modify form data before it is finally saved to the database. To do this, you may use the mutateDataUsing() method, which has access to the $data as an array, and returns the modified version:

use Webkernel\Platform\Actions\EditAction;

EditAction::make()
    ->mutateDataUsing(function (array $data): array {
        $data['last_edited_by_id'] = auth()->id();

        return $data;
    })

<UtilityInjection set="actions">As well as $data, the mutateDataUsing() function can inject various utilities as parameters.</UtilityInjection>

Customizing the saving process

You can tweak how the record is updated with the using() method:

use Webkernel\Platform\Actions\EditAction;
use Webkernel\ORM\Model;

EditAction::make()
    ->using(function (Model $record, array $data): Model {
        $record->update($data);

        return $record;
    })

<UtilityInjection set="actions">As well as $record and $data, the using() function can inject various utilities as parameters.</UtilityInjection>

Redirecting after saving

You may set up a custom redirect when the form is submitted using the successRedirectUrl() method:

use Webkernel\Platform\Actions\EditAction;

EditAction::make()
    ->successRedirectUrl(route('posts.list'))

If you want to redirect using the created record, use the $record parameter:

use Webkernel\Platform\Actions\EditAction;
use Webkernel\ORM\Model;

EditAction::make()
    ->successRedirectUrl(fn (Model $record): string => route('posts.view', [
        'post' => $record,
    ]))

<UtilityInjection set="actions">As well as $record, the successRedirectUrl() function can inject various utilities as parameters.</UtilityInjection>

Customizing the save notification

When the record is successfully updated, 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:

use Webkernel\Platform\Actions\EditAction;

EditAction::make()
    ->successNotificationTitle('User updated')

<UtilityInjection set="actions">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:

use Webkernel\Platform\Actions\EditAction;
use Webkernel\Platform\Notifications\Notification;

EditAction::make()
    ->successNotification(
       Notification::make()
            ->success()
            ->title('User updated')
            ->body('The user has been saved successfully.'),
    )

<UtilityInjection set="actions" extras="Notification;;Webkernel\Platform\Notifications\Notification;;$notification;;The default notification object, which could be a useful starting point for customization.">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:

use Webkernel\Platform\Actions\EditAction;

EditAction::make()
    ->successNotification(null)

Lifecycle hooks

Hooks may be used to execute code at various points within the action's lifecycle, like before a form is saved.

There are several available hooks:

use Webkernel\Platform\Actions\EditAction;

EditAction::make()
    ->beforeFormFilled(function () {
        // Runs before the form fields are populated from the database.
    })
    ->afterFormFilled(function () {
        // Runs after the form fields are populated from the database.
    })
    ->beforeFormValidated(function () {
        // Runs before the form fields are validated when the form is saved.
    })
    ->afterFormValidated(function () {
        // Runs after the form fields are validated when the form is saved.
    })
    ->before(function () {
        // Runs before the form fields are saved to the database.
    })
    ->after(function () {
        // Runs after the form fields are saved to the database.
    })

<UtilityInjection set="actions">These hook functions can inject various utilities as parameters.</UtilityInjection>

Halting the saving process

At any time, you may call $action->halt() from inside a lifecycle hook or mutation method, which will halt the entire saving process:

use App\Models\Post;
use Webkernel\Platform\Actions\Action;
use Webkernel\Platform\Actions\EditAction;
use Webkernel\Platform\Notifications\Notification;

EditAction::make()
    ->before(function (EditAction $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:

$action->cancel();