Filament Repeater belongsToMany

Hey everyone, I need to be able to handle creation process after submitting my Wizard Form to create Recipe.

Wizard steps:

Recipe Info
Ingredients
Guide

I need to be able to save data in that particular order:

Prepare an array of ingredients that, in its format, will be suitable for saving in a pivot table.
Update/Create Recipe instance using ingredients array to save into pivot table
Store/Update group of steps into GuideStep model

Filament has a lot of automated processes and I'm unclear where and how I can intercept that and apply my own save logic. I’ve seen that mutateFormDataBeforeCreate() and afterCreate() hooks exist — but I’m not sure:

Which is the proper place to run this logic?
Should I avoid using ->relationship() inside the Repeater to disable automatic persistence?
How can I fully bypass Filament’s auto-saving of related data and take control manually?

Recipe.php

class Recipe extends Model
{
    public function ingredients(): BelongsToMany
    {
        return $this->belongsToMany(Ingredient::class)
            ->using(IngredientRecipe::class)
            ->withTimestamps()
            ->withPivot(['quantity', 'unit_id']);
    }
}

IngredientRecipe (pivot model with relationship into another table)

class IngredientRecipe extends Pivot
{
    protected $table = 'ingredient_recipe';

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

Ingredient

class Ingredient extends Model
{
    use EagerLoadPivotTrait;

    protected $fillable = ['name'];

    public function recipes(): BelongsToMany
    {
        return $this->belongsToMany(Recipe::class);
    }
}

Would be grateful for your advices and help

Best regards

AddWebContribution

10 months ago

Level 42

If you're using Repeater::make()->relationship('ingredients'), Filament will automatically persist those records

Use the mutateFormDataBeforeCreate() to clean or prepare the data

Use afterCreate() or afterSave() to do the actual persistence logic.

But for most manual saving, afterCreate() (or afterSave() for update too) is best.

To handle updating the same way, just override the same logic in EditRecipe.php using:

mutateFormDataBeforeSave()
afterSave()

1 like

dmytroshved

10 months ago

Level 6

@AddWebContribution

To handle updating the same way, just override the same logic in EditRecipe.php using: mutateFormDataBeforeSave() and afterSave() <

But then the code in mutateFormDataBeforeCreate() and mutateFormDataBeforeSave() will be duplicated, right? What can I do to avoid code duplication in these places?

AddWebContribution

10 months ago

Level 42

@Dmytro_Shved To avoid duplication, you can extract shared logic into private helper methods inside your CreateRecipe and EditRecipe classes or better yet, into a trait or service class if shared across both.

1 like

dmytroshved

9 months ago

Level 6

Wanna to leave here some useful links and things I got while researching:

Correctly set the Pivot table class according to the docs in Filament: https://filamentphp.com/docs/3.x/forms/fields/repeater#integrating-with-a-belongstomany-eloquent-relationship
Don't forget about $incrementing = true in your Pivot model
If you want to overwrite repeater relationship data before saving it to the DB, there's a method called mutateRelationshipDataBeforeCreateUsing(). Link to the docs: https://filamentphp.com/docs/3.x/forms/fields/repeater#mutating-related-item-data-before-creating

Below I've added example of my own implementation

Relations

Recipe.php model

    // Relation for the Filament Repeater
    public function ingredientRecipe(): HasMany
    {
        return $this->hasMany(IngredientRecipe::class);
    }

    // Regular relation belongsToMany
    public function ingredients(): BelongsToMany
    {
        return $this->belongsToMany(Ingredient::class)
            ->using(IngredientRecipe::class)
            ->withTimestamps()
            ->withPivot(['quantity', 'unit_id']);
    }

IngredientRecipe.php pivot model

    // Set relationships as in the docs (link above)

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

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

Ingredient.php

    public function recipes(): BelongsToMany
    {
        return $this->belongsToMany(Recipe::class);
    }

Filament Code

And then in the Filament Repeater:

        return [
            Repeater::make('ingredientRecipe')
                ->label('ingredients')
                ->relationship()
                ->schema([
                    Grid::make(3)->schema([
                        // Ingredient name
                        TextInput::make('ingredient_name')
                            ->label('Ingredient')
                            ->required()
                            ->string()
                            ->maxLength(255),

                        // Ingredient quantity
                        TextInput::make('quantity')
                            ->label('Quantity')
                            ->required()
                            ->numeric()
                            ->minValue(0.1)
                            ->maxValue(999.99),

                        // Ingredient unit
                        Select::make('unit_id')
                            ->label('Unit')
                            ->options(Unit::pluck('name', 'id'))
                            ->required()
                            ->searchable(),
                    ]),
                ])

                // Mutate Ingredients Before Fill Repeater
                // To see ingredient name in the edit form
                ->mutateRelationshipDataBeforeFillUsing(function (array $data): array {
                    if (isset($data['ingredient_id'])) {
                        $data['ingredient_name'] = Ingredient::find($data['ingredient_id'])->name;
                    }
                    return $data;
                })

                // Mutate Before Store in the DB
                ->mutateRelationshipDataBeforeCreateUsing(function (array $data): array {
                    // Prepare Final Ingredients to save into DB
                    return self::prepareIngredient($data);
                })

                ->addActionLabel('Add ingredient')
                ->addActionAlignment(Alignment::End)
                ->reorderable(false)
                ->minItems(1)
                ->maxItems(99)
                ->defaultItems(1)
                ->columnSpan('full'),
        ];


    // Prepare final Ingredient
    public static function prepareIngredient($ingredientData): array
    {
        // Check if the ingredient exists (get the existed one or create and save to database)
        $newOrExistedIngredient = Ingredient::firstOrCreate([
            'name' => trim($ingredientData['ingredient_name']) // Match by name
        ]);

        // Prepare data for pivot table
        $finalIngredient = [
            'ingredient_id' => $newOrExistedIngredient->id,
            'quantity' => $ingredientData['quantity'],
            'unit_id' => $ingredientData['unit_id'],
        ];

        return $finalIngredient;
    }

Have a good coding

Please or to participate in this conversation.