isakzhanov-r/laravel-dto

Data Transfer Object for VO

v1.2.5 2023-12-27 08:10 UTC

Requires

• php: ^7.4|^8.0
• ext-json: *
• ext-pdo: *
• illuminate/support: ^7.0|^8.0|^9.0|^10.0
• illuminate/validation: ^7.0|^8.0|^9.0|^10.0

Requires (Dev)

• isakzhanov-r/laravel-value-object: ^1
• mockery/mockery: ^0.9|^1.0
• orchestra/testbench: ^5.0|^6.0|^7.0|^9.0
• phpunit/phpunit: ^8.0|^9.0

MIT

• isakzhanov-r

README

Allows you to pass data in the specified typing, namely in IsakzhanovR\ValueObject or in a primitive type. The same type can be a DTO

Contents

• Installation
• Usage
• License

Installation

To get the latest version of Laravel Data Transfer Object package, simply require the project using Composer:

$ composer require isakzhanov-r/laravel-dto

Instead, you can, of course, manually update the dependency block require in composer.json and run composer update if you want to:

{
    "require-dev": {
        "isakzhanov-r/laravel-dto": "^1.0"
    }
}

Usage

To use DTO, you need to create a class that will inherit from the abstract DataTransferObject class, and declare the public variables in the class with the desired type

use IsakzhanovR\DataTransferObject\DataTransferObject;
use IsakzhanovR\ValueObject\Email  // example

class UserData extends DataTransferObject 
{
    public $id;
    
    public string $name;
    
    /**
    * @var \IsakzhanovR\ValueObject\Email
    * @throws \App\Exceptions\EmailDataExeption
    */
    public Email $email;
    
    /**
    * @var IsakzhanovR\DataTransferObject\FiledDTO[] - example
    */
    public array $fields;
}

You can also create a DTO object from an array, from a FormRequest, from an Object and from a JSON string

$dto = new UserData(['id' => 1,'name' => 'Example',' email' => '[e-mail]']);

$array = ['id' => 1,'name' => 'Example',' email' => '[e-mail]'];

$dto = UserData::fromArray($array);

$object = new stdClass();
$object->id = 1;
$object->name = 'Example';
$object->email = '[e-mail]';

$dto = UserData::fromObject($object);

$dto = UserData::fromRequest($request);

$dto = UserData::fromJson(json_encode($array));

It also happens that you need to reverse transformation into an array , for this there is a get method:

$dto->get()

or a method with recursive transformation into an array

$dto->toArray()

License

This package is released under the MIT License.