tibisoft/autotransformer

A little tool for transforming DTO's to entities and viseversa

0.7.0 2024-05-31 18:46 UTC

Requires

• beberlei/assert: ^3.3

Requires (Dev)

• pestphp/pest: ^2.34
• phpstan/phpstan: ^1.10

MIT

• Willem Turkstra

README

Autotransformer is a little tool which does basic DTO to entity transforming and vise versa.

Installation

composer require tibisoft/autotransformer

Usage

Without any extra configuration the transformer will loop over the properties of the target class/object and will try to find a equally named property in the source.

class User {
    public function __construct(
        private string $email,
        private string $plainPassword,
        private int $age,
    ) {
    
    }
}

class UserDTO {
    public function __construct(
        private string $email,
        private int $age,
    ) {
    
    }
}

$user = new User('[e-mail]', 'someSecretPassword', 25);

$transformer = new \Tibisoft\AutoTransformer\AutoTransformer();
$userDTO = $transformer->transform($user, UserDTO::class);

//output:
object(UserDTO)#8 (2) {
  ["email":"UserDTO":private]=>
  string(17) "[e-mail]"
  ["age":"UserDTO":private]=>
  int(25)
}

Manipulate Transforming

If the default transforming process is not enough you can add attributes to the target object/class and customise the output.

Synonyms

class User {
    public function __construct(
        private string $email,
        private string $plainPassword,
        private int $age,
    ) {
    
    }
}

class UserDTO {
    public function __construct(
        private string $email, 
        #[\Tibisoft\AutoTransformer\Attribute\Synonyms(['age'])] 
        private int $yearsLive,
    ) {
    
    }
}

$user = new User('[e-mail]', 'someSecretPassword', 25);

$transformer = new \Tibisoft\AutoTransformer\AutoTransformer();
$userDTO = $transformer->transform($user, UserDTO::class);

//output:
object(UserDTO)#8 (2) {
  ["email":"UserDTO":private]=>
  string(17) "[e-mail]"
  ["yearsLive":"UserDTO":private]=>
  int(25)
}

Count

class User {
    public function __construct(
        private string $email, 
        private array $comments,
    ) {
    
    }
}

class UserDTO {
    public function __construct(
        private string $email,
        #[\Tibisoft\AutoTransformer\Attribute\Count]
        private int $comments,
    ) {
    
    }
}

$user = new User('[e-mail]', ['Comment #1', 'Comment #2', 'Comment #3', 'Comment #4']);

$transformer = new \Tibisoft\AutoTransformer\AutoTransformer();
$userDTO = $transformer->transform($user, UserDTO::class);

//output:
object(UserDTO)#8 (2) {
  ["email":"UserDTO":private]=>
  string(17) "[e-mail]"
  ["comments":"UserDTO":private]=>
  int(4)
}

InArray

class InArrayClass
{
    public function __construct(
        public array $roles = [],
    ) {

    }
}

class InArrayDTO
{
    public function __construct(
        #[\Tibisoft\AutoTransformer\Attribute\InArray(property: 'roles', value: 'ROLE_TEAMLEADER')]
        public bool $isTeamleader,
    ) {

    }
}

$object = new InArrayClass(['ROLE_USER', 'ROLE_TEAMLEADER']);

$transformer = new \Tibisoft\AutoTransformer\AutoTransformer();
$inArrayDTO = $transformer->transform($object, InArrayDTO::class);

//output:
object(InArrayDTO)#8 (1) {
  ["isTeamleader"]=>
  bool(true)
}