https://github.com/picamator/transfer-object

A modern Symfony-compatible Transfer Object Generator with property hooks, FixedArray, and asymmetric visibilities.
https://github.com/picamator/transfer-object

automation code-generator data-transfer-object definition-generator dto dto-generator generator php symfony symfony-console transfer-object transfer-object-generator

Last synced: 2 months ago
JSON representation

A modern Symfony-compatible Transfer Object Generator with property hooks, FixedArray, and asymmetric visibilities.

Host: GitHub
URL: https://github.com/picamator/transfer-object
Owner: picamator
License: mit
Created: 2024-12-10T18:49:29.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2026-01-11T14:14:42.000Z (2 months ago)
Last Synced: 2026-01-11T16:05:01.471Z (2 months ago)
Topics: automation, code-generator, data-transfer-object, definition-generator, dto, dto-generator, generator, php, symfony, symfony-console, transfer-object, transfer-object-generator
Language: PHP
Homepage:
Size: 2.62 MB
Stars: 12
Watchers: 1
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

          ![Transfer Object Generator](.github/transfer-object-generator.jpg)

[![CI workflow](https://github.com/picamator/transfer-object/actions/workflows/ci.yml/badge.svg?event=push)](https://github.com/picamator/transfer-object/actions)

[![License](https://poser.pugx.org/picamator/transfer-object/license)](https://packagist.org/packages/picamator/transfer-object)

[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/11465/badge)](https://www.bestpractices.dev/projects/11465)

[![PHP Version Require](https://poser.pugx.org/picamator/transfer-object/require/php)](https://packagist.org/packages/picamator/transfer-object)

[![Symfony Compatibility](https://img.shields.io/badge/Symfony-%5E8.0-blue)](https://github.com/picamator/transfer-object/tree/development?tab=readme-ov-file#key-features)

[![Wiki](https://img.shields.io/badge/wiki-available-brightgreen)](https://github.com/picamator/transfer-object/wiki)

[![Latest Stable Version](https://poser.pugx.org/picamator/transfer-object/v)](https://packagist.org/packages/picamator/transfer-object)

Transfer Object Generator

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

Would you like to build Symfony-compatible Transfer Objects?

You're in the right place! 🎉

Imagine you have a Rest API response:

```json

{

    "firstName": "Jan",

    "lastName": "Kowalski"

}

```

Running the following interactive [console command](https://github.com/picamator/transfer-object/wiki/Console-Commands#definition-generate):

```console

$ ./vendor/bin/definition-generate

```

Generates a `YML` [definition file](https://github.com/picamator/transfer-object/wiki/Definition-File):

```yml

Customer:

  firstName:

    type: string

  lastName:

    type: string

```

Then, running [console command](https://github.com/picamator/transfer-object/wiki/Console-Commands#transfer-generate):

```console

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

```

Builds the Transfer Object:

```php

$customerTransfer = new CustomerTransfer();

$customerTransfer->firstName = 'Jan';

$customerTransfer->lastName = 'Kowalski';

```

Key Features

------------

**Symfony Compatability:**

 * Provides Symfony console command:

   * [TransferGeneratorCommand](/src/Command/TransferGeneratorCommand.php)

   * [TransferGeneratorBulkCommand](/src/Command/TransferGeneratorBulkCommand.php)

   * [DefinitionGeneratorCommand](/src/Command/DefinitionGeneratorCommand.php)

 * Includes Symfony services:

   * [TransferGeneratorFacade](/src/TransferGenerator/TransferGeneratorFacade.php)

   * [DefinitionGeneratorFacade](/src/DefinitionGenerator/DefinitionGeneratorFacade.php)

 * Enables automatic Symfony request query data mapping

 * Supports [Symfony validator](https://github.com/symfony/validator) attributes

**Transfer Object:**

* Offers methods:

  * `fromArray()`

  * `toArray()`

* Implements standard interfaces:

  * `IteratorAggregate`

  * `JsonSerializable`

  * `Countable`

* Handles embedded and collection Transfer Objects.

* Works with PHP primitive data types.

* Extends compatibility to advanced types:

  * `BackedEnum`

  * `DateTime`

  * `DateTimeImmutable`

  * `BcMath\Number`

* Supports asymmetric property visibility.

* Integrates with external Transfer Objects.

Installation

------------

Composer installation:

```console

$ composer require picamator/transfer-object

```

| Version | PHP | Symfony |

|-------|-----|---------|

| 4.0.0 | 8.4 | 7.3     |

| 5.0.0 | 8.5 | 8.0     |

Examples

---------

* [Definition Generator](/examples/try-definition-generator.php)

* [Transfer Generator](/examples/try-transfer-generator.php)

* [Advanced Transfer Generator](/examples/try-advanced-transfer-generator.php)

Usage Tests

-----------

Definition Files and Transfer Object generators have been tested against the following APIs:

* [NASA Open Api](https://api.nasa.gov/neo/rest/v1/neo/2465633?api_key=DEMO_KEY)

* [OpenWeather](https://openweathermap.org/current#example_JSON)

* [Content API for Shopping](https://developers.google.com/shopping-content/guides/products/products-api?hl=en)

* [Frankfurter is a free, open-source currency data API](https://api.frankfurter.dev/v1/latest)

* [Tagesschau API](https://tagesschau.api.bund.dev)

* [Statistisches Bundesamt (Destatis)](https://www-genesis.destatis.de/genesisWS/swagger-ui/index.html#/find/findPost)

### Scenario

1. Rest API response is used as a blueprint to generate Definition Files

2. Transfer Objects are generated based on Definition Files

3. Transfer Object instance is created with the API response

4. Transfer Object is converted back to the array

5. The converted array is compared with the API response

For all APIs, data are ✅ matched.

For detailed information, please check [DefinitionGeneratorFacadeTest](/tests/integration/DefinitionGenerator/DefinitionGeneratorFacadeTest.php).

Documentation

-------------

For more details, please visit [project's wiki](https://github.com/picamator/transfer-object/wiki).

Publications

------------

1. [Sergii Pryz, "Data Transfer Objects and Property Hooks" PHP Architect Magazine, June 2025](https://www.phparch.com/article/2025-06-data-transfer-objects-and-property-hooks/)

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](CONTRIBUTING.md).

This project is released with a [Code of Conduct](CODE_OF_CONDUCT.md).

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](LICENSE) file.

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/picamator/transfer-object

Awesome Lists containing this project

README