troelskn/laravel-fillable-relations

Provides HasFillableRelations trait to Eloquent models

dev-master 2021-10-29 14:50 UTC

Requires

• illuminate/database: >=5.3

Requires (Dev)

• mockery/mockery: ^0.9.4
• orchestra/database: 3.3.1
• orchestra/testbench: 3.3
• phpunit/phpunit: ~5.7

MIT

• Troels Knak-Nielsen

README

This library provides a trait for mixing in to an Eloquent Model. Doing so will enable support for fillable relations.

To use, first require in your composer file:

composer require troelskn/laravel-fillable-relations

Then, in your code:

<?php
namespace MyApp\Models;

use Illuminate\Database\Eloquent\Model;
use LaravelFillableRelations\Eloquent\Concerns\HasFillableRelations;

class Foo extends Model
{
    use HasFillableRelations;
    protected $fillable_relations = ['bar'];

    function bar()
    {
        return $this->hasOne(Bar::class);
    }
}

class Bar extends Model
{
    use HasFillableRelations;
    protected $fillable_relations = ['foos'];

    function foos()
    {
        return $this->hasMany(Foo::class);
    }
}

And you can now fill relations, like so:

$foo = new Foo(
    [
        'cuux' => 42,
        'bar' => [
            'id' => 42
        ]
    ]
);

Or perhaps:

$foo = new Foo(
    [
        'cuux' => 42,
        'bar' => [
            'name' => "Ye Olde Pubbe"
        ]
    ]
);

And also:

$bar = new Bar(
    [
        'name' => "Ye Olde Pubbe",
        'foos' => [
            [
                'cuux' => 42
            ],
            [
                'cuux' => 1337
            ]
        ]
    ]
);

In order to automatically detach empty relations, pass an empty array:

$bar->fill([
    'foos' => [] // Detach all foos
]);

$bar->save();

You can use Laravel validator array rule to preserve empty arrays passed to the request:

class UpdateRequest extends FormRequest
{
    public function rules()
    {
        return [
            'foos' => [
                'array',
            ],
        ];
    }
}

And then update attributes and relations in one line in the controller:

public function update(UpdateRequest $request, Bar $bar)
{
    $bar->fill($request->validated())->save();
}