valeryq/dto

Laravel array formatter similarity DTO

Laravel array formatter similarity DTO

Introduction

Laravel can serialize EloquentModel or EloquentCollection to array, but it can't get only certain data (for example: return JSON from controller). DTO can return to response only certain data large nested., _(*1)

Installation

Require this package in your composer.json and update composer. This will download the package., _(*2)

"valeryq/dto": "1.0.0"

After updating composer, add the ServiceProvider to the providers array in app/config/app.php, _(*3)

'Valeryq\DTO\DTOServiceProvider',

You can use the facade for shorter code. Add this to your aliases:, _(*4)

'DTO' => 'Valeryq\DTO\DTOFacade',

How it use

Eloquent model example:, _(*5)

class UserController extends \BaseController 
{
    public function getUser() 
    {
        $user = UserModel::find(1);

        return DTO::make($user)->only(['id', 'firstname']);

        or

        return DTO::make($user)->except(['lastname']);
    }   
}

Eloquent collection example:, _(*6)

class UserController extends \BaseController 
{
    public function getUser() 
    {
        $user = UserModel::where('firstname', 'Test')->get();

        return DTO::make($user)->only(['id', 'firstname']);

        or

        return DTO::make($user)->except(['lastname']);
    }   
}

Nested objects:, _(*7)

class UserController extends \BaseController 
{
    public function getUser() 
    {
        $user = UserModel::with('posts')->find(1);

        return DTO::make($user)->only(['id', 'firstname', 'posts.id', 'posts.body']);

        or

        return DTO::make($user)->except(['lastname', 'posts.body']);
    }   
}