https://github.com/zolex/vom
Versatile Object Mapper for PHP. Map arbitrary data to strictly typed models using attributes.
https://github.com/zolex/vom
data-structures hydration mapping normalization transformation
Last synced: 22 days ago
JSON representation
Versatile Object Mapper for PHP. Map arbitrary data to strictly typed models using attributes.
- Host: GitHub
- URL: https://github.com/zolex/vom
- Owner: zolex
- License: mit
- Created: 2024-01-29T09:32:42.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2026-01-15T14:01:09.000Z (2 months ago)
- Last Synced: 2026-01-27T05:21:21.259Z (about 2 months ago)
- Topics: data-structures, hydration, mapping, normalization, transformation
- Language: PHP
- Homepage:
- Size: 811 KB
- Stars: 19
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Versatile Object Mapper
[](https://github.com/zolex/vom/actions/workflows/release.yaml)
[](https://packagist.org/packages/zolex/vom)
[](https://github.com/zolex/vom/actions/workflows/integration.yaml)
[](https://codecov.io/gh/zolex/vom)
[](./LICENSE)
[](https://packagist.org/packages/zolex/vom)
The Versatile Object Mapper - or in short VOM - is a PHP library to transform any data structure into strictly typed models (and back) by adding PHP 8 attributes.
It extends symfony/serializer functionality and is heavily inspired by doctrine and API-Platform, so that advanced mappings can simply be defined on the model classes instead of writing normalizer decorators.
- [Documentation](https://zolex.github.io/vom/)
- [Examples repository](https://github.com/zolex/vom-examples).
## Installation
VOM is available on packagist. To install, simply require it via composer.
```bash
composer require zolex/vom ^2.0
```
## Quickstart
To give you a basic idea of what VOM does, here is a first short example.
Given, your application receives the following array of values from somewhere.
```php
$data = [
'firstname' => 'Jane',
'surname' => 'Doe',
'street' => 'Samplestreet 123',
'city' => 'Worsthausen',
'zip' => '12345',
'country_name' => 'United Kingdom',
'email_address' => 'jane.doe@mailprovider.net',
'phone' => '0123456789'
];
```
Usually you would write some code that creates the model instances, sets their properties and nests them properly.
In very simple scenarios, writing the transformation logic as code might be a good choice, but it can be a pain when it comes to very huge models, the input data structures
and/or application models change while still in development, or if you want to reuse the transformation logic in other projects too, because it receives the same inputs and/or uses the same models.
### How it works using VOM
Instead of writing business logic that feeds your models, with VOM you simply configure the models using PHP attributes.
```php
use Zolex\VOM\Mapping as VOM;
#[VOM\Model]
class Person
{
#[VOM\Property]
public string $firstname;
#[VOM\Property('[surname]')]
public string $lastname;
#[VOM\Property(accessor: false)]
public Address $address;
#[VOM\Property(accessor: false)]
public Contact $contact;
}
#[VOM\Model]
class Address
{
#[VOM\Property]
public string $street;
#[VOM\Property('[zip]')]
public string $zipCode;
#[VOM\Property]
public string $city;
#[VOM\Property('[country_name]')]
public string $country;
}
#[VOM\Model]
class Contact
{
#[VOM\Property('[email_address]')]
public string $email;
#[VOM\Property]
public string $phone;
}
```
To create instances of your models, you simply pass the data to the `denormalize()` method.
```php
$person = $objectMapper->denormalize($data, Person::class);
```
You may have noticed, that some property attributes have arguments while others don't. For all details on that, head to the [full documentation](https://zolex.github.io/vom/).
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contributors
Andreas Linden
Javier Caballero
## Special thanks
Blackfire for supporting this project with a free license, leading to VOM performance gains.
## Alternatives
There are many Mapping/Transformation/Hydration libraries out there. In case you don't want to rely on `symfony/serializer`, `symfony/proerty-access`, `symfony/type-info` and `phpdocumentor/reflection-docblock` which VOM depends on, here are some alternative packages that cover the same topic with quite different approaches and features.
- [jms/serializer](https://github.com/schmittjoh/serializer)
- [CuyZ/Valinor](https://github.com/CuyZ/Valinor)
- [rekalogika/mapper](https://github.com/rekalogika/mapper)
- [Crell/Serde](https://github.com/Crell/Serde)
- [thephpleague/object-mapper](https://github.com/thephpleague/object-mapper)
- [eventsauce/object-hydrator](https://github.com/EventSaucePHP/ObjectHydrator)
- [spatie/laravel-data](https://github.com/spatie/laravel-data)