ArmCM / laravel-presentable

Create presenters for Eloquent Models

Laravel Presentable

This package allows the information to be presented in a different way by means of methods that can be defined in the model's presenter class.

Installation

You can install the package via composer:

Laravel	Version
6, 7, 8	0.0.1
9	0.0.2

composer require datacreativa/laravel-presentable

Usage

Use the HasPresentable trait in any Eloquent Model, you must also add the $presenter property.

use App\Models\Presenters\UserPresenter;
use TheHiveTeam\Presentable\HasPresentable;

class User extends Model
{
    use HasPresentable;

    protected $presenter = UserPresenter::class;
}

You can generate a class presenter with this command:

php artisan make:presenter UserPresenter

In this class you can define any method, for example:

namespace App\Models\Presenters;

use TheHiveTeam\Presentable\Presenter;

class UserPresenter extends Presenter
{
    public function name()
    {
        return ucwords($this->model->name);
    }
}

Now you have available the present() method in Eloquent Model.

$user = (new User)->setAttribute('name', 'john doe');
$user->present()->name;
// John Doe

Enjoy it!

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Credits

• Jonathan Zarate
• All Contributors

License

The MIT License (MIT). Please see License File for more information.