How to Generate a PHP Data Transfer Object from an Array or YML File Using the Package Transfer Object: Generate transfer objects using property hooks

Recommend this page to a friend!

Download

Info

Example

Screenshots

Files

Install with Composer

Download

Reputation

Support forum

Blog

Links

Last Updated		Ratings				Unique User Downloads		Download Rankings
2025-02-09 (20 days ago)		Not enough user ratings				Total: 25 This week: 3		All time: 11,257 This week: 20

Version		License		PHP version		Categories
`transfer-object` 1.5.4		MIT/X Consortium ...		8.4		Console, Code Generation, Design Patt..., P...

Description

Author

Sergii Pryz

This package can generate transfer objects using property hooks.

It can take a definition of a transfer object as an array or in a file in the YML format and generate a code file for the described transfer object class.

The package uses a template to define the transfer object class code using PHP class property hooks to implement the code of functions that are called to set or get the transfer object class variable values.

Innovation Award

January 2025
Nominee
Vote

A data transfer object is an object that is used in applications to pass information between different processes.

This package can quickly generate data transfer object classes from object class definitions passed as arrays or configuration files in YML format.

It uses PHP property hooks to simplify the definition of the generated data transfer object class.

Manuel Lemos

Sergii Pryz

Performance

Level

Name:	Sergii Pryz `<contact>`
Classes:	11 packages by Sergii Pryz
Country:	Germany

Level 4

Innovation award

Nominee: 5x

Example


<?php



declare(strict_types=1);



use Picamator\Doc\Samples\TransferObject\Enum\CountryEnum;

use Picamator\Doc\Samples\TransferObject\Generated\TransferGenerator\AgentTransfer;

use Picamator\Doc\Samples\TransferObject\Generated\TransferGenerator\CustomerTransfer;

use Picamator\Doc\Samples\TransferObject\Generated\TransferGenerator\MerchantTransfer;

use Picamator\TransferObject\TransferGenerator\TransferGeneratorFacade;



require_once __DIR__ . '/../../vendor/autoload.php';



echo <<<'STORY'

==============================================================

           Generate Transfer Objects

                  with notice

     for demonstration exception handling was skipped

==============================================================



STORY;

$configPath = __DIR__ . '/config/transfer-generator/generator.config.yml';

new TransferGeneratorFacade()->generateTransfersOrFail($configPath);



echo <<<'STORY'

======================================================

        Try newly Generated Transfer Objects

======================================================



STORY;

$customerTransfer = new CustomerTransfer();

$customerTransfer->firstName = 'Jan';

$customerTransfer->lastName = 'Kowalski';



foreach ($customerTransfer as $key => $value) {

    echo "key: $key, value: $value\n";

}



echo "CustomerTransfer properties count: {$customerTransfer->count()}\n}.";



$merchantTransfer = new MerchantTransfer();

$merchantTransfer->merchantReference = 'PL-234-567';

$merchantTransfer->country = CountryEnum::PL;

$merchantTransfer->isActive = true;



var_dump($merchantTransfer->toArray());



echo <<<'STORY'

======================================================

             Try how fromArray() works

======================================================



STORY;

$agentTransfer = new AgentTransfer()

    ->fromArray([

        AgentTransfer::CUSTOMER => [

            CustomerTransfer::FIRST_NAME => 'Max',

            CustomerTransfer::LAST_NAME => 'Mustermann',

        ],

        AgentTransfer::MERCHANTS => [

            [

                MerchantTransfer::COUNTRY => 'DE',

                MerchantTransfer::MERCHANT_REFERENCE => 'DE-234-567',

                MerchantTransfer::IS_ACTIVE => false,

            ], [

                MerchantTransfer::COUNTRY => 'PL',

                MerchantTransfer::MERCHANT_REFERENCE => 'PL-774-444',

                MerchantTransfer::IS_ACTIVE => true,

            ],

        ],

        'uuid' => '123-123-123-123',

    ]);



var_dump($agentTransfer->toArray());

Details

Transfer Object Generator

Would you like to build lightweight Transfer Objects (TO) easily? You're in the right place!

Build TOs Using an Array as Blueprint

Imagine you have an array:

$data = [
    'firstName' => 'Jan',
    'lastName' => 'Kowalski'
];

TO facade method helps to convert array into YML definition file:

Customer:
  firstName:
    type: string
  lastName:
    type: string

Generator console command builds TO based on definition file:

$customerTransfer = new CustomerTransfer();
$customerTransfer->firstName = 'Jan';
$customerTransfer->lastName = 'Kowalski';

How it works in action can be found on Wiki: - Try Sample to generate Definition files - Try Sample to generate TOs - Try Advanced Sample to generate TOs

Key Features

Interface methods: implements `fromArray()`, `toArray()`
Standard interfaces: implements `IteratorAggregate`, `JsonSerializable`, and `Countable`
Lightweight: TO includes only data without any business logic
Nullable: supports both attribute types nullable and not nullable (`required:`)
BackedEnum: supports `BackedEnum`
Adaptable: compatible with custom Data Transfer Object (DTO) implementation

Installation

Composer installation:

$ composer require picamator/transfer-object

Usage

Terminal

Run command bellow to generate Transfer Objects:

$ ./vendor/bin/generate-transfer [-c|--configuration CONFIGURATION]

Please check Wiki for more details: - Command Configuration - Definition File

Facade Interface

Facade interface DefinitionGeneratorFacadeInterface is used to generate YML definition file based on array.

Please check Wiki for more details: - Facade Interfaces - Visualizing Diagrams

Acknowledgment

Many thanks for your contribution, supports, feedback and simply using Transfer Object Generator!

Contribution

If you find this project useful, please add a star to the repository. Follow the project to stay updated with all activities. If you have suggestions for improvements or new features, feel free to create an issue or submit a pull request. Here is a Contribution Guide.

Please note that this project is released with a Code of Conduct. By participating in this project and its community, you agree to abide by those terms.

License

Transfer Object Generator is free and open-source software licensed under the MIT License. For more details, please see the LICENSE file.

Screenshots (2)

Files (337)

File	Role	Description
`.github` (1 directory)
`bin` (1 file)
`config` (1 file, 1 directory)
`doc` (1 directory)
`docker` (1 file, 1 directory)
`src` (7 directories)
`tests` (2 directories)
`.editorconfig`	Data	Auxiliary data
`captainhook.json`	Data	Auxiliary data
`CODE_OF_CONDUCT.md`	Data	Auxiliary data
`composer.json`	Data	Auxiliary data
`composer.lock`	Data	Auxiliary data
`CONTRIBUTING.md`	Data	Auxiliary data
`docker-compose.yml`	Data	Auxiliary data
`LICENSE`	Lic.	License text
`phpcs.xml`	Data	Auxiliary data
`phpstan.neon`	Data	Auxiliary data
`phpunit.xml`	Data	Auxiliary data
`README.md`	Doc.	Documentation
`SECURITY.md`	Data	Auxiliary data

File	Role	Description
`definition` (3 files)
`generator.config.yml`	Data	Auxiliary data

File	Role	Description
`definition-generator.transfer.yml`	Data	Auxiliary data
`template.transfer.yml`	Data	Auxiliary data
`transfer-generator.transfer.yml`	Data	Auxiliary data

File	Role	Description
`Advanced` (1 file)
`config` (3 directories)
`Enum` (1 file)
`Generated` (3 directories)
`try-advanced-transfer-generator.php`	Example	Example script
`try-definition-generator.php`	Example	Example script
`try-transfer-generator.php`	Example	Example script

File	Role	Description
`advanced-transfer-generator` (1 file, 1 directory)
`definition-generator` (1 file, 1 directory)
`transfer-generator` (1 file, 1 directory)

File	Role	Description
`definition` (1 file)
`generator.config.yml`	Data	Auxiliary data

File	Role	Description
`agent.transfer.yml`	Data	Auxiliary data
`customer.transfer.yml`	Data	Auxiliary data
`merchant.transfer.yml`	Data	Auxiliary data

File	Role	Description
`AdvancedTransferGenerator` (1 file)
`DefinitionGenerator` (8 files)
`TransferGenerator` (3 files)

File	Role	Description
`AvailabilitiesTransfer.php`	Class	Class source
`BoxTransfer.php`	Class	Class source
`DeliveryOptionsTransfer.php`	Class	Class source
`DetailsTransfer.php`	Class	Class source
`LabelsTransfer.php`	Class	Class source
`MeasurementUnitTransfer.php`	Class	Class source
`PaletteTransfer.php`	Class	Class source
`ProductTransfer.php`	Class	Class source

File	Role	Description
`AgentTransfer.php`	Class	Class source
`CustomerTransfer.php`	Class	Class source
`MerchantTransfer.php`	Class	Class source

File	Role	Description
`Command` (1 file)
`DefinitionGenerator` (2 files, 4 directories)
`Dependency` (2 files, 4 directories)
`Exception` (1 file)
`Generated` (16 files)
`Transfer` (5 files, 2 directories)
`TransferGenerator` (2 files, 5 directories)

File	Role	Description
`Builder` (4 files, 2 directories)
`Exception` (1 file)
`Generator` (1 file, 2 directories)
`Render` (2 files)
`DefinitionGeneratorFacade.php`	Class	Class source
`DefinitionGeneratorFacadeInterface.php`	Class	Class source

File	Role	Description
`Enum` (2 files)
`Expander` (6 files)
`BuilderContentInterface.php`	Class	Class source
`DefinitionBuilder.php`	Class	Class source
`DefinitionBuilderInterface.php`	Class	Class source
`DefinitionBuilderTrait.php`	Class	Class source

File	Role	Description
`GetTypeEnum.php`	Aux.	Configuration script
`ObjectTypeEnum.php`	Aux.	Configuration script

File	Role	Description
`AbstractBuilderExpander.php`	Class	Class source
`BuilderExpanderInterface.php`	Class	Class source
`BuilderExpanderTrait.php`	Class	Class source
`BuildInTypeBuilderExpander.php`	Class	Class source
`CollectionTypeBuilderExpander.php`	Class	Class source
`TransferTypeBuilderExpander.php`	Class	Class source

File	Role	Description
`Filesystem` (2 files)
`Generator` (2 files)
`DefinitionGeneratorFactory.php`	Class	Class source

File	Role	Description
`DefinitionFilesystem.php`	Class	Class source
`DefinitionFilesystemInterface.php`	Class	Class source

File	Role	Description
`DefinitionGenerator.php`	Class	Class source
`DefinitionGeneratorInterface.php`	Class	Class source

File	Role	Description
`DefinitionRender.php`	Class	Class source
`DefinitionRenderInterface.php`	Class	Class source

File	Role	Description
`Exception` (4 files)
`Filesystem` (2 files)
`Finder` (4 files)
`YmlParser` (2 files)
`DependencyContainer.php`	Class	Class source
`DependencyFactoryTrait.php`	Class	Class source

File	Role	Description
`DependencyNotFoundException.php`	Class	Class source
`FilesystemException.php`	Class	Class source
`FinderException.php`	Class	Class source
`YmlParserException.php`	Class	Class source

File	Role	Description
`FilesystemBridge.php`	Class	Class source
`FilesystemInterface.php`	Class	Class source

File	Role	Description
`FinderBridge.php`	Class	Class source
`FinderInterface.php`	Class	Class source
`FinderIterator.php`	Class	Class source
`SplFileInfoBridge.php`	Class	Class source

File	Role	Description
`YmlParserBridge.php`	Class	Class source
`YmlParserInterface.php`	Class	Class source

File	Role	Description
`ConfigContentTransfer.php`	Class	Class source
`ConfigTransfer.php`	Class	Class source
`ConfigValidatorTransfer.php`	Class	Class source
`DefinitionBuilderTransfer.php`	Class	Class source
`DefinitionContentTransfer.php`	Class	Class source
`DefinitionEmbeddedTypeTransfer.php`	Class	Class source
`DefinitionFilesystemTransfer.php`	Class	Class source
`DefinitionGeneratorContentTransfer.php`	Class	Class source
`DefinitionGeneratorTransfer.php`	Class	Class source
`DefinitionNamespaceTransfer.php`	Class	Class source
`DefinitionPropertyTransfer.php`	Class	Class source
`DefinitionTransfer.php`	Class	Class source
`DefinitionValidatorTransfer.php`	Class	Class source
`TemplateTransfer.php`	Class	Class source
`TransferGeneratorTransfer.php`	Class	Class source
`ValidatorMessageTransfer.php`	Class	Class source

File	Role	Description
`Attribute` (6 files)
`Exception` (1 file)
`AbstractTransfer.php`	Class	Class source
`AttributeTransferTrait.php`	Class	Class source
`DummyTransferAdapterTrait.php`	Class	Class source
`TransferInterface.php`	Class	Class source
`TransferTrait.php`	Class	Class source

File	Role	Description
`ArrayObjectPropertyTypeAttribute.php`	Class	Class source
`ArrayPropertyTypeAttribute.php`	Class	Class source
`CollectionPropertyTypeAttribute.php`	Class	Class source
`EnumPropertyTypeAttribute.php`	Class	Class source
`PropertyTypeAttribute.php`	Class	Class source
`PropertyTypeAttributeInterface.php`	Class	Class source

File	Role	Description
`Config` (2 files, 8 directories)
`Definition` (1 file, 5 directories)
`Exception` (3 files)
`Generator` (1 file, 4 directories)
`Validator` (7 files)
`TransferGeneratorFacade.php`	Class	Class source
`TransferGeneratorFacadeInterface.php`	Class	Class source

File	Role	Description
`Config` (3 files)
`Enum` (1 file)
`Environment` (2 files)
`Exception` (1 file)
`Loader` (2 files)
`Parser` (4 files)
`Reader` (2 files)
`Validator` (2 files, 2 directories)
`ConfigFactory.php`	Class	Class source
`ConfigFactoryTrait.php`	Class	Class source

File	Role	Description
`Config.php`	Class	Class source
`ConfigInterface.php`	Class	Class source
`ConfigProxy.php`	Class	Class source

File	Role	Description
`ConfigEnvironmentRender.php`	Class	Class source
`ConfigEnvironmentRenderInterface.php`	Class	Class source