borisnedovis/eloquent-presenter

Presentation standard for Eloquent models

1.0.0 2021-06-27 14:32 UTC

Requires

• php: ^7.4
• illuminate/support: 5.*|6.*|7.*

MIT

• Boris Nedovis

• model
• laravel
• presenter
• eloquent
• decorator

README

Install

composer require borisnedovis/eloquent-presenter

Usage

Create presenter class and extend it from aaboris\EloquentPresenter\AbstractPresenter. And specify $attributes keys, which presenter should use from model:

namespace App\Presenters;

use BorisNedovis\EloquentPresenter\AbstractPresenter;

class UserPresenter extends AbstractPresenter
{
    /**
     * @var \App\Models\User
     */
    protected $model;
    
    protected $attributes = [
        'first_name',
        'last_name'
    ];
}

Additionally you can add method for getting specific values:

protected $attributes = [
    'first_name',
    'last_name',
    'full_name', // <- a virtual key, that model doesnt contain
];

// Get virtual value. Just studly case your key and surround it with 'get' and 'Attribute'.
public function getFullNameAttribute()
{
    return "{$this->model->first_name} {$this->model->last_name}";
}

Include trait BorisNedovis\EloquentPresenter\Presenter in your model. And specify presenter class.

use BorisNedovis\EloquentPresenter\Presenter;

class User
{
    use Presenter;
    // ...

    protected $presenter = \App\Presenters\UserPresenter::class;

}

Or override getPresenterClass method, if you dont like protected attribute, or just need some extra logic:

class User
{
    use Presenter;
    // ...

    public function getPresenterClass()
    {
        if ($this->isBlocked()) {
            return \App\Presenters\BlockedUserPresenter::class;
        }

        return \App\Presenters\UserPresenter::class;
    }

}

And just send it to output:

$user = User::first();

return response()->json(compact('user'));

{
    "first_name": "Boris",
    "last_name": "Nedovis",
    "full_name": "Boris Nedovis",
}

License

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