opensource/filament
3
0
Fork 0
mirror of https://github.com/filamentphp/filament.git synced 2026-10-28 03:44:19 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #16083 from filamentphp/fix/saving-layout-relationships

Browse Source 
fix: Saving relationships within layout relationships, and `MorphTo` layout relationships
This commit is contained in:
Dan Harrin
2025-04-19 14:53:38 +01:00
committed by GitHub
parent 284fc5c9aa af339e039e
commit 876fdd7358
2 changed files with 36 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/forms/docs/01-overview.md
+23 -3
View File
@@ -1546,11 +1546,31 @@ Group::make()
])
```
### Saving data to a `BelongsTo` relationship
### Saving data to a `BelongsTo` or `MorphTo` relationship
Please note that if you are saving the data to a `BelongsTo` relationship, then the foreign key column in your database must be `nullable()`. This is because Filament saves the schema first, before saving the relationship. Since the schema is saved first, the foreign ID does not exist yet, so it must be nullable. Immediately after the schema is saved, Filament saves the relationship, which will then fill in the foreign ID and save it again.
Please note that if you are saving the data to a `BelongsTo` or `MorphTo` relationship, then the foreign key column in your database must be `nullable()`. This is because Filament saves the schema first, before saving the relationship. Since the schema is saved first, the foreign ID does not exist yet, so it must be nullable. Immediately after the schema is saved, Filament saves the relationship, which will then fill in the foreign ID and save it again.
It is worth noting that if you have an observer on your schema model, then you may need to adapt it to ensure that it does not depend on the relationship existing when it it created. For example, if you have an observer that sends an email to a related record when a schema is created, you may need to switch to using a different hook that runs after the relationship is attached, like `updated()`.
It is worth noting that if you have an observer on your schema model, then you may need to adapt it to ensure that it does not depend on the relationship existing when it is created. For example, if you have an observer that sends an email to a related record when a schema is created, you may need to switch to using a different hook that runs after the relationship is attached, like `updated()`.
#### Specifying the related model for a `MorphTo` relationship
If you are using a `MorphTo` relationship, and you want Filament to be able to create `MorphTo` records instead of just updating them, you need to specify the related model using the `relatedModel` parameter of the `relationship()` method:
```php
use App\Models\Organization;
use Filament\Forms\Components\TextInput;
use Filament\Schemas\Components\Group;
Group::make()
->relationship('customer', relatedModel: Organization::class)
->schema([
// ...
])
```
In this example, `customer` is a `MorphTo` relationship, and could be an `Individual` or `Organization`. By specifying the `relatedModel` parameter, Filament will be able to create `Organization` records when the form is submitted. If you do not specify this parameter, Filament will only be able to update existing records.
<UtilityInjection set="formFields" version="4.x">The `relatedModel` parameter also accepts a function that returns the related model class name. This is useful if you want to dynamically determine the related model based on the current state of the form. You can inject various utilities into this function.</UtilityInjection>
### Conditionally saving data to a relationship
packages/schemas/src/Components/Concerns/EntanglesStateWithSingularRelationship.php
+13 -48
View File
@@ -19,15 +19,18 @@ trait EntanglesStateWithSingularRelationship
protected ?string $relationship = null;
protected string | Closure | null $relatedModel = null;
protected ?Closure $mutateRelationshipDataBeforeCreateUsing = null;
protected ?Closure $mutateRelationshipDataBeforeFillUsing = null;
protected ?Closure $mutateRelationshipDataBeforeSaveUsing = null;
public function relationship(string $name, bool | Closure $condition = true): static
public function relationship(string $name, bool | Closure $condition = true, string | Closure | null $relatedModel = null): static
{
$this->relationship = $name;
$this->relatedModel = $relatedModel;
$this->statePath($name);
$this->loadStateFromRelationshipsUsing(static function (Component | CanEntangleWithSingularRelationships $component): void {
@@ -45,43 +48,7 @@ trait EntanglesStateWithSingularRelationship
return;
}
if ($record) {
return;
}
$relationship = $component->getRelationship();
if ($relationship instanceof BelongsTo) {
return;
}
$data = $component->getChildSchema()->getState(shouldCallHooksBefore: false);
$data = $component->mutateRelationshipDataBeforeCreate($data);
$relatedModel = $component->getRelatedModel();
$translatableContentDriver = $livewire->makeFilamentTranslatableContentDriver();
if ($translatableContentDriver) {
$record = $translatableContentDriver->makeRecord($relatedModel, $data);
} else {
$record = new $relatedModel;
$record->fill($data);
}
$relationship->save($record);
$component->cachedExistingRecord($record);
});
$this->saveRelationshipsUsing(static function (Component | CanEntangleWithSingularRelationships $component, LivewireComponent & HasSchemas $livewire) use ($condition): void {
if (! $component->evaluate($condition)) {
return;
}
$data = $component->getChildSchema()->getState(shouldCallHooksBefore: false);
$record = $component->getCachedExistingRecord();
$translatableContentDriver = $livewire->makeFilamentTranslatableContentDriver();
@@ -96,15 +63,10 @@ trait EntanglesStateWithSingularRelationship
}
$relationship = $component->getRelationship();
if (! ($relationship instanceof BelongsTo)) {
return;
}
$relatedModel = $component->getRelatedModel();
$data = $component->mutateRelationshipDataBeforeCreate($data);
$relatedModel = $component->getRelatedModel();
if ($translatableContentDriver) {
$record = $translatableContentDriver->makeRecord($relatedModel, $data);
} else {
@@ -112,10 +74,13 @@ trait EntanglesStateWithSingularRelationship
$record->fill($data);
}
$record->save();
$relationship->associate($record);
$relationship->getParent()->save();
if ($relationship instanceof BelongsTo) {
$record->save();
$relationship->associate($record);
$relationship->getParent()->save();
} else {
$relationship->save($record);
}
$component->cachedExistingRecord($record);
});
@@ -195,7 +160,7 @@ trait EntanglesStateWithSingularRelationship
*/
public function getRelatedModel(): ?string
{
return $this->getRelationship()?->getModel()::class;
return $this->evaluate($this->relatedModel) ?? $this->getRelationship()?->getModel()::class;
}
public function cachedExistingRecord(?Model $record): static