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-04-22 (9 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.9.0		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
Number 4

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\CredentialsTransfer;

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



/** @var string $value */

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());



echo <<<'STORY'

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

             Try protected properties (partly immutable)

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



STORY;

$credentialsTransfer = new CredentialsTransfer([

    CredentialsTransfer::LOGIN => 'jan.kowalski',

    CredentialsTransfer::TOKEN => 'some-random-token',

]);



echo "Login: $credentialsTransfer->login\n";

echo "Token: $credentialsTransfer->token\n";

Details

Transfer Object Generator

Would you like to build Symfony-compatible Transfer Objects easily?

You're in the right place! ?

Build Transfer Object by Blueprint

Imagine you have a Rest API response:

{
    "firstName": "Jan",
    "lastName": "Kowalski"
}

Running the following interactive console command:

$ ./vendor/bin/definition-generate

Generates a YML definition file:

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

Then, running another console command:

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

Builds the Transfer Object:

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

Key Features

Symfony-compatible: * includes Symfony console commands: TransferGeneratorCommand and DefinitionGeneratorCommand * includes Symfony services: TransferGeneratorFacade and DefinitionGeneratorFacade * Transfer Objects are mappable with Symfony request
Transfer Object: * implements methods: `fromArray()`, `toArray()`, and `toFilterArray()` * implements standard interfaces: `IteratorAggregate`, `JsonSerializable`, and `Countable` * supports embedded Transfer Objects, collections as well as `BackedEnum`, nullable and not nullable property types * supports asymmetric property visibility * supports custom Data Transfer Object (DTO)

Installation

Composer installation:

$ composer require picamator/transfer-object

Usage Tests

Definition Files and Transfer Object generators have been tested against API responses such as:

Test Scenario

Rest API response is used as a blueprint to generate Definition Files
Transfer Objects are generated based on Definition Files
Transfer Object instance is created with the API response
Transfer Object is converted back to the array
The converted array is compared with the API response

In all cases, data 100% are matched ?.

For detailed information, please check DefinitionGeneratorFacadeTest.

Service Samples

Practice

Definition Files and Transfer Objects generators use Transfer Objects.

Acknowledgment

Many thanks for your contribution, support, feedback and simply using the Transfer Object Generator! ??

Contribution

If you find this project useful, please ? star 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
Submit a pull request

Here is a Contribution Guide.

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 (510)

File	Role	Description
`.github` (6 files, 2 directories)
`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
`.env.dist`	Data	Auxiliary data
`.env.dist`	Data	Auxiliary data
`.env.dist`	Data	Auxiliary data
`.env.dist`	Data	Auxiliary data
`.env.dist`	Data	Auxiliary data
`.env.dist`	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
`ISSUE_TEMPLATE` (18 files)
`workflows` (1 file)
`pull_request_template.md`	Data	Auxiliary data
`pull_request_template.md`	Data	Auxiliary data
`pull_request_template.md`	Data	Auxiliary data
`pull_request_template.md`	Data	Auxiliary data
`pull_request_template.md`	Data	Auxiliary data
`pull_request_template.md`	Data	Auxiliary data

File	Role	Description
`01-bug.yml`	Data	Auxiliary data
`01-bug.yml`	Data	Auxiliary data
`01-bug.yml`	Data	Auxiliary data
`01-bug.yml`	Data	Auxiliary data
`01-bug.yml`	Data	Auxiliary data
`01-bug.yml`	Data	Auxiliary data
`02-feature-request.yml`	Data	Auxiliary data
`02-feature-request.yml`	Data	Auxiliary data
`02-feature-request.yml`	Data	Auxiliary data
`02-feature-request.yml`	Data	Auxiliary data
`02-feature-request.yml`	Data	Auxiliary data
`02-feature-request.yml`	Data	Auxiliary data
`config.yml`	Data	Auxiliary data
`config.yml`	Data	Auxiliary data
`config.yml`	Data	Auxiliary data
`config.yml`	Data	Auxiliary data
`config.yml`	Data	Auxiliary data
`config.yml`	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, 5 directories)
`Dependency` (2 files, 4 directories)
`Exception` (1 file)
`Generated` (16 files)
`Transfer` (4 files, 2 directories)
`TransferGenerator` (2 files, 5 directories)

File	Role	Description
`Builder` (15 files, 2 directories)
`Exception` (1 file)
`Generator` (1 file, 2 directories)
`Render` (2 files)
`Validator` (6 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
`DefinitionContentBuilder.php`	Class	Class source
`DefinitionContentBuilder.php`	Class	Class source
`DefinitionContentBuilder.php`	Class	Class source
`DefinitionContentBuilder.php`	Class	Class source
`DefinitionContentBuilder.php`	Class	Class source
`DefinitionContentBuilder.php`	Class	Class source
`DefinitionContentBuilderInterface.php`	Class	Class source
`DefinitionContentBuilderInterface.php`	Class	Class source
`DefinitionContentBuilderInterface.php`	Class	Class source
`DefinitionContentBuilderInterface.php`	Class	Class source
`DefinitionContentBuilderInterface.php`	Class	Class source
`DefinitionContentBuilderInterface.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
`VariableValidatorTrait.php`	Class	Class source
`VariableValidatorTrait.php`	Class	Class source
`VariableValidatorTrait.php`	Class	Class source
`VariableValidatorTrait.php`	Class	Class source
`VariableValidatorTrait.php`	Class	Class source
`VariableValidatorTrait.php`	Class	Class source

File	Role	Description
`Exception` (4 files)
`Filesystem` (14 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
`FileAppender.php`	Class	Class source
`FileAppender.php`	Class	Class source
`FileAppender.php`	Class	Class source
`FileAppender.php`	Class	Class source
`FileAppender.php`	Class	Class source
`FileAppender.php`	Class	Class source
`FileAppenderInterface.php`	Class	Class source
`FileAppenderInterface.php`	Class	Class source
`FileAppenderInterface.php`	Class	Class source
`FileAppenderInterface.php`	Class	Class source
`FileAppenderInterface.php`	Class	Class source
`FileAppenderInterface.php`	Class	Class source
`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

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