DTO Data Transfer Objects

dto 1.php

<?php

use Spatie\DataTransferObject\DataTransferObject;

class Customer extends DataTransferObject
{
    /** @var int|string $id */
    public $id;
    public string $alias;
    public string $name;
    public string $email;
}

new Customer([
    "id" => 3, 
    "alias" => "jdoe", 
    "name" => "John Doe", 
    "email" => "jdoe@example.local",
]);

^ Customer {#282 ▼
    #exceptKeys: []
    #onlyKeys: []
    +id: 3
    +alias: "jdoe"
    +name: "John Doe"
    +email: "jdoe@example.local"
}

dto 2.php

<?php

use Spatie\DataTransferObject\DataTransferObject;

class Address extends DataTransferObject
{
    public string $country;
    public string $region;
    public string $district;
    public string $street;
}

class Customer extends DataTransferObject
{
    /** @var int|string $id */
    public $id;
    public string $alias;
    public string $name;
    public string $email;
    public array $address;
}

new Customer([
    "id" => 3,
    "alias" => "jdoe",
    "name" => "John Doe",
    "email" => "jdoe@example.local",
    "address" => [
        "counrty" => "Uganda",
        "region" => "Central",
        "district" => "Kampala",
        "street" => "1st street Industrial Area.",
    ],
]);

^ Customer {#282 ▼
    #exceptKeys: []
    #onlyKeys: []
    +id: 3
    +alias: "jdoe"
    +name: "John Doe"
    +email: "jdoe@example.local"
    +address: array:4 [▼
        "counrty" => "Uganda"
        "region" => "Central"
        "district" => "Kampala"
        "street" => "1st street Industrial Area."
    ]
}

dto 3.php

<?php

use Spatie\DataTransferObject\DataTransferObject;

class Address extends DataTransferObject
{
    public string $country;
    public string $region;
    public string $district;
    public string $street;
}

class Customer extends DataTransferObject
{
    /** @var int|string $id */
    public $id;
    public string $alias;
    public string $name;
    public string $email;
    public Address $address;
}

new Customer([
    "id" => 3,
    "alias" => "jdoe",
    "name" => "John Doe",
    "email" => "jdoe@example.local",
    "address" => [
        "country" => "Uganda",
        "region" => "Central",
        "district" => "Kampala",
        "street" => "1st street Industrial Area.",
    ],
]);

^ Customer {#282 ▼
    #exceptKeys: []
    #onlyKeys: []
    +id: 3
    +alias: "jdoe"
    +name: "John Doe"
    +email: "jdoe@example.local"
    +address: Address {#300 ▼
        #exceptKeys: []
        #onlyKeys: []
        +country: "Uganda"
        +region: "Central"
        +district: "Kampala"
        +street: "1st street Industrial Area."
    }
}

dto 4.php

<?php

use Spatie\DataTransferObject\DataTransferObject;

class Address extends DataTransferObject
{
    public string $country;
    public string $region;
    public string $district;
    public string $street;
}

class Customer extends DataTransferObject
{
    /** @var int|string $id */
    public $id;
    public string $alias;
    public string $name;
    public string $email;
    /** @var Address[] $addresses */
    public array $addresses;
}

new Customer([
    "id" => 3,
    "alias" => "jdoe",
    "name" => "John Doe",
    "email" => "jdoe@example.local",
    "addresses" => [
        [
            "country" => "Uganda",
            "region" => "Central",
            "district" => "Kampala",
            "street" => "1st street Industrial Area.",
        ],
    ],
]);

^ Customer {#282 ▼
    #exceptKeys: []
    #onlyKeys: []
    +id: 3
    +alias: "jdoe"
    +name: "John Doe"
    +email: "jdoe@example.local"
    +addresses: array:1 [▼
        0 => array:4 [▼
            "country" => "Uganda"
            "region" => "Central"
            "district" => "Kampala"
            "street" => "1st street Industrial Area."
        ]
    ]
}

dto 5.php

<?php

use Spatie\DataTransferObject\Caster;
use Spatie\DataTransferObject\DataTransferObject;
use Spatie\DataTransferObject\Attributes\CastWith;

class Address extends DataTransferObject
{
    public string $country;
    public string $region;
    public string $district;
    public string $street;
}

class AddressArrayCaster implements Caster
{
    public function cast(mixed $values): array
    {
        if (!\is_array($values)) {
            throw new \Exception('Can only cast arrays to Address');
        }

        return array_map(function ($value) {
            return new Address($value);
        }, $values);
    }
}

class Customer extends DataTransferObject
{
    /** @var int|string $id */
    public $id;
    public string $alias;
    public string $name;
    public string $email;
    #[CastWith(AddressArrayCaster::class)]
    public array $addresses;
}

$customer = new Customer([
    "id" => 3,
    "alias" => "jdoe",
    "name" => "John Doe",
    "email" => "jdoe@example.local",
    "addresses" => [
        [
            "country" => "Uganda",
            "region" => "Central",
            "district" => "Kampala",
            "street" => "1st street Industrial Area.",
        ],
    ],
]);

^ Customer {#282 ▼
    #exceptKeys: []
    #onlyKeys: []
    +id: 3
    +alias: "jdoe"
    +name: "John Doe"
    +email: "jdoe@example.local"
    +addresses: array:1 [▼
        0 => Address {#307 ▼
            #exceptKeys: []
            #onlyKeys: []
            +country: "Uganda"
            +region: "Central"
            +district: "Kampala"
            +street: "1st street Industrial Area."
        }
    ]
}