README

The package provides an expressive "fluent" way to define model attributes. It automatically builds casts at the runtime and adds a native autocompletion to the models' properties.

Introduction

With laravel-fluent, you can define Model attributes as you would do with any other class. The values will be transformed to the corresponding types depending on the native types of the properties.

Before:

<?php

/**
 * @property Collection $features
 * @property float $price
 * @property int $available
 */
class Product extends Model
{
    protected $casts = [
        'features' => 'collection',
        'price' => 'float',
        'available' => 'integer',
    ];
}

After:

<?php

class Product extends Model
{
    use HasFluentBindings;

    public Collection $features;
    public float $price;
    public int $available;
}

Installation

This version supports PHP 8.0. You can install the package via composer:

composer require based/laravel-fluent

Then, add the Based\Fluent\Fluent trait to your models:

<?php

class User extends Model
{
    use HasFluentBindings;
}

Model attributes

Define the public properties. laravel-fluent supports all native types and Laravel primitive casts:

<?php

class Order extends Model
{
    use HasFluentBindings;

    public int $amount;
    public Carbon $expires_at;

    #[AsDecimal(2)]
    public float $total;

    #[Cast('encrypted:array')]
    public array $payload;
}

Fillable and guarded

Any property being managed by the library can be marked as fillable or guarded by annotating it with an attribute.

<?php

class Order extends Model
{
    use HasFluentBindings;

    #[Guarded]
    public int $id;

    #[Fillable]
    public int $amount;

    #[Fillable]
    #[AsDecimal(2)]
    public float $total;

    #[Cast('encrypted:array')]
    public array $payload;
}

These attributes can also be specified at the class level, and they will affect multiple properties.

<?php

/*
 * All properties will be marked as fillable.
 * See Fillable's documentation for more nuanced controls.
 */
#[Fillable(Fillable::INCLUDE_ALL)]
class Order extends Model
{

    use HasFluentBindings;

    public int $id;
    public int $amount;

    #[AsDecimal(2)]
    public float $total;
}

Relations

The package also handles relationships.

<?php

class Product extends Model
{
    use HasFluentBindings;

    #[Relation]
    public Collection $features;
    public Category $category;

    public function features(): HasMany
    {
        return $this->hasMany(Feature::class);
    }

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

The package can automatically resolve relations from attributes, but be aware that there will be no autocompletion for the associated laravel-style methods.

<?php

class Product extends Model
{
    use HasFluentBindings;

    #[HasMany(Feature::class)]
    public Collection $features;
    #[BelongsTo]
    public Category $category;

    /*
     * The Laravel-style methods `features()` and `category()` will
     * be simulated under the hood, but will lack IDE autocompletion.
     */
}

Testing

composer test

adelaide / laravel-fluent

Maintainers

Details