isakzhanov-r/laravel-dto

数据传输对象(DTO)用于VO

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

This package is auto-updated.

Last update: 2024-09-27 09:56:55 UTC


README

允许您以指定的类型传递数据,即在 IsakzhanovR\ValueObject 或原始类型中。相同的类型可以是DTO

Total Downloads Latest Stable Version Latest Unstable Version License

内容

安装

要获取Laravel数据传输对象包的最新版本,只需使用 Composer 需求项目即可

$ composer require isakzhanov-r/laravel-dto

当然,如果您想手动更新 composer.json 中的依赖项 require 块并运行 composer update,您也可以这样做

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

用法

要使用 DTO,您需要创建一个继承自抽象数据传输对象类 DataTransferObject 的类,并在类中声明具有所需类型的公共变量

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;
}

您还可以从数组、FormRequest、对象和JSON字符串创建DTO对象

$dto = new UserData(['id' => 1,'name' => 'Example',' email' => 'example@test.com']);

$array = ['id' => 1,'name' => 'Example',' email' => 'example@test.com'];

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

$object = new stdClass();
$object->id = 1;
$object->name = 'Example';
$object->email = 'example@test.com';

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

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

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

有时您还需要进行反向转换到数组,为此有一个 get 方法

$dto->get()

或递归转换到数组的方法

$dto->toArray()

许可

本软件包在 MIT 许可 下发布。