https://github.com/rekalogika/reconstitutor

Provides a thin layer that sits above Doctrine events to help you reconstitute/hydrate your entities. It lets you augment Doctrine's hydration with your logic in a concise and expressive class.
https://github.com/rekalogika/reconstitutor

doctrine hydration php reconstitution symfony symfony-bundle

Last synced: 3 months ago
JSON representation

Provides a thin layer that sits above Doctrine events to help you reconstitute/hydrate your entities. It lets you augment Doctrine's hydration with your logic in a concise and expressive class.

• Host: GitHub
• URL: https://github.com/rekalogika/reconstitutor
• Owner: rekalogika
• License: mit
• Created: 2023-09-03T14:39:40.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-21T13:25:45.000Z (4 months ago)
• Last Synced: 2024-09-30T16:20:11.780Z (3 months ago)
• Topics: doctrine, hydration, php, reconstitution, symfony, symfony-bundle
• Language: PHP
• Homepage: https://rekalogika.dev/reconstitutor
• Size: 59.6 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# rekalogika/reconstitutor

This library provides a thin layer that sits above Doctrine events to help you

reconstitute/hydrate your entities. It lets you augment Doctrine's hydration

with your logic in a concise and expressive class.

After Doctrine hydrates an object from the database, this framework gives you

the control to hydrate additional properties not handled by Doctrine, without

having to deal with the peculiarities of Doctrine events and Unit of Work. Then,

after Doctrine persists the changes to the database, it lets you do similarly

with the properties.

The most common case of this type of tasks is for handling file uploads, of

which many specialized libraries have already been written. But plenty of other

cases exist:

* A lazy-loading proxy that fetches the real resource using an API call.

* Linking objects that are managed by different object managers, or non-Doctrine

  entities.

These days we usually call the process *hydration*. *Reconstitution* is the term

used by Eric Evans in *"Domain-Driven Design: Tackling Complexity in the Heart of

Software"*.

## Features

* Simple declaration in a class. You can create a reconstitutor class to handle

  the reconstitution of a specific entity class, entities that implement a

  specific interface, entities in a class hierarchy, or those with a specific

  PHP attribute.

* Our abstract classes provide `get()` and `set()` methods as a convenience.

  They let you work with the properties directly, bypassing getters and setters.

  It is the best practice in reconstitutions as it frees you to have business

  logic in the getters and setters.

* The `get()` and `set()` methods are forwarders to a custom implementation of

  Symfony's `PropertyAccessorInterface`. Therefore, you can use the same

  exceptions defined in `PropertyAccessorInterface`.

* It has what we think is the correct behavior. It asks your reconstitutor to

  save only after Doctrine has successfully saved the object. It doesn't rely on

  Doctrine seeing the object being dirty before `flush()`-ing. i.e. your

  entities don't have to modify a Doctrine-managed property —like

  `$lastUpdated`— just to make sure the correct Doctrine event will be fired.

## Documentation

[rekalogika.dev/reconstitutor](https://rekalogika.dev/reconstitutor)

## License

MIT

## Contributing

Issues and pull requests should be filed in the GitHub repository

[rekalogika/reconstitutor](https://github.com/rekalogika/reconstitutor).