dezer32/dto

Data transfer object.

v1.3.5 2023-01-01 16:23 UTC

Requires

• php: ^8.0
• phpbench/phpbench: ^1.2

Requires (Dev)

• fakerphp/faker: ^1.20
• phpunit/phpunit: ^9.5
• rector/rector: ^0.14.8
• vimeo/psalm: ^5.4

MIT

• Dezer

README

Introduce

Library for use DataTransferObject on your projects.

P.S.: For test we need generate DTO.. I have solution: dezer32/dto-faker

Installation

1. Install package

composer require dezer32/dto

2. Profit!

Usage

Dto:

<?php

declare(strict_types=1);

use Dezer32\Libraries\Dto\DataTransferObject;

class TestDto extends DataTransferObject
{
    public function __construct(
        private string $text,
    ) {
    }
    
    public function getText(): string
    {
        return $this->text;
    }
}

or

<?php

declare(strict_types=1);

use Dezer32\Libraries\Dto\Attributes\DataTransferObject;

#[DataTransferObject]
class TestDto
{
    public function __construct(
        private string $text,
    ) {
    }
    
    public function getText(): string
    {
        return $this->text;
    }
}

Code:

<?php

declare(strict_types=1);

use Dezer32\Libraries\Dto\Transformer;

$parameters = [
    'text' => 'test'
];
$dto = Transformer::transform(TestDto::class, $parameters);
//or
$dto = new TestDto('test');

Casting

#[Cast()]

<?php

declare(strict_types=1);

use Dezer32\Libraries\Dto\Contracts\CasterInterface;

class CasterClass implements CasterInterface
{
    public function cast(mixed $value): string
    {
        return 'New string and ' . $value;
    }
}

<?php

declare(strict_types=1);

use Dezer32\Libraries\Dto\Attributes\Cast;

class TestDto
{
    public function __construct(
        #[Cast(CasterClass::class)]
        private string $text,
    ) {
    }

    public function getText(): string
    {
        return $this->text;
    }
}

<?php

declare(strict_types=1);

use Dezer32\Libraries\Dto\Transformer;

$dto = Transformer::transform(TestDto::class, ['text' => 'test text.']);

echo $dto->getText(); //New string and test text.

#[DefaultCast()]

<?php

declare(strict_types=1);

use Dezer32\Libraries\Dto\Attributes\DefaultCast;
use Dezer32\Libraries\Dto\Contracts\CasterInterface;
use Dezer32\Libraries\Dto\Transformer;

class DefaultCasterClass implements CasterInterface
{
    public function cast(mixed $value): AnotherClass
    {
        return new AnotherClass('New string and ' . $value);
    }
}

class AnotherClass
{
    public function __construct(
        private string $text
    ) {
    }

    public function getText(): string
    {
        return $this->text;
    }
}

#[DefaultCast(AnotherClass::class, DefaultCasterClass::class)]
class TestDto
{
    public function __construct(
        private AnotherClass $object,
    ) {
    }

    public function getObject(): AnotherClass
    {
        return $this->object;
    }
}

$dto = Transformer::transform(TestDto::class, ['text' => 'test text.']);

echo $dto->getObject()->getText(); //New string and test text.

<?php

declare(strict_types=1);

use Dezer32\Libraries\Dto\Contracts\CasterInterface;

class DefaultCasterClass implements CasterInterface
{
    public function cast(mixed $value): AnotherClass
    {
        return new AnotherClass('New string and ' . $value);
    }
}

<?php

declare(strict_types=1);

class AnotherClass
{
    public function __construct(
        private string $text
    ) {
    }

    public function getText(): string
    {
        return $this->text;
    }
}

<?php

declare(strict_types=1);

use Dezer32\Libraries\Dto\Attributes\DefaultCast;

#[DefaultCast(AnotherClass::class, DefaultCasterClass::class)]
#[DataTransferObject]
class TestDto
{
    public function __construct(
        private AnotherClass $object,
    ) {
    }

    public function getObject(): AnotherClass
    {
        return $this->object;
    }
}

<?php

declare(strict_types=1);

use Dezer32\Libraries\Dto\Transformer;

$dto = Transformer::transform(TestDto::class, ['text' => 'test text.']);

echo $dto->getObject()->getText(); //New string and test text.

List of DTOs #[Cast(ArrayCast::class, ConcreteDto::class)]

<?php

declare(strict_types=1);

use Dezer32\Libraries\Dto\Attributes\DataTransferObject;

#[DataTransferObject]
class SimpleDto
{
    public function __construct(
        private string $text
    ) {
    }

    public function getText(): string
    {
        return $this->text;
    }
}

<?php

declare(strict_types=1);

use Dezer32\Libraries\Dto\Attributes\Cast;
use Dezer32\Libraries\Dto\Attributes\DataTransferObject;
use Dezer32\Libraries\Dto\Casters\ArrayCaster;

#[DataTransferObject]
class SimpleListDto
{
    public function __construct(
        #[Cast(ArrayCaster::class, SimpleDto::class)]
        private array $list
    ) {
    }

    /** @return SimpleDto[] */
    public function getList(): array
    {
        return $this->list;
    }
}