octopyid/data-transfer-object

Simple Laravel Data Transfer Object

dev-main 2022-05-16 17:05 UTC

This package is auto-updated.

Last update: 2024-05-16 21:18:41 UTC


README

Version Downloads License

Simple Data Transfer Object (DTO)

A data transfer object (DTO) is an object that carries data between processes. DTO does not have any behaviour except for storage, retrieval, serialization and deserialization of its own data. DTOs are simple objects that should not contain any business logic but rather be used for transferring data.

This is DTO version based on my OPINION :)

Installation

To install the package, simply follow the steps below.

Install the package using Composer:

composer require octopyid/data-transfer-object:dev-main

Usage

Artisan Command

php artisan make:data UserData

This command will generate DTOs from your models.

php artisan make:data UserData --model=User

Basic DTO

<?php

use Octopy\DTO\DataTransferObject;

class UserData extends DataTransferObject
{
    public function getName() : string
    {
        return $this->get('name');
    }
}

// From Array
$dto = UserData::make([
    'name' => 'John Doe'
]);

// From Request
$dto = UserData::make($request);

// From User Model
$dto = UserData::make($user);

//
echo $dto->getName();

Credits

License

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