laravel-fluent - GitLite

KO | EN

gitlite — search

#javascript #python #typescript #go #rust #deep-learning #awesome #vue #pytorch #security #mcp #ios #openai #open-source

laravel-fluent

(★ 559)

No description available.

File Explorer

Download Latest Version (.zip)

- - ci.yml
- FUNDING.yml
- - AbstractCaster.php
  - AsDate.php
  - AsDecimal.php
  - Cast.php
- - AbstractRelation.php
  - BelongsTo.php
  - BelongsToMany.php
  - HasMany.php
  - HasManyThrough.php
  - HasOne.php
  - HasOneThrough.php
  - MorphMany.php
  - MorphOne.php
  - MorphToMany.php
  - OneRelation.php
  - Relation.php
- Fluent.php
- FluentServiceProvider.php
- HasProperties.php
- HasRelations.php
- - AttributesTest.php
  - CastsTest.php
  - RelationsTest.php
- Pest.php
- TestCase.php
.gitattributes
.gitignore
.php-cs-fixer.php
check
composer.json
docker-compose.yml
LICENSE
phpstan.neon
phpunit.xml
README.md

# Installation Guide

1. Get the code

git clone https://github.com/lepikhinb/laravel-fluent

Downloads the entire project code from GitHub to your computer.

cd laravel-fluent

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker compose up -d --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. PHP (Composer)

Easy

Prerequisites

Git Needed to download the project code from GitHub.
PHP A PHP runtime is required.
Composer The package manager used to install PHP libraries.

composer require based/laravel-fluent

Type this command into your terminal and run it.

composer test

Type this command into your terminal and run it.

✅ Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Laravel Fluent

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
<?php

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

After:
```php
<?php

class Product extends Model
{
    use Fluent;

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

## Installation

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

```bash
composer require based/laravel-fluent
```

Then, add the `Based\Fluent\Fluent` trait to your models:
```php
<?php

class User extends Model
{
    use Fluent;
}
```

### Model attributes
Define the public properties. `laravel-fluent` supports all native types and Laravel primitive casts:
```php
<?php

class Order extends Model
{
    use Fluent;

public int $amount;
    public Carbon $expires_at;

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

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

### Relations
The package also handles relationships.

```php
<?php

class Product extends Model
{
    use Fluent;

#[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);
    }
}
```

Relations method declaration is still required for proper autocompletion. However, the package can automatically resolve relations from attributes.

```php
<?php

class Product extends Model
{
    use Fluent;

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

## Testing

```bash
composer test
```

## Todo
- [ ] Migration generator

## Credits

- [Boris Lepikhin](https://github.com/lepikhinb)
- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.