Entities management – Best practices

I seek to understand what are the good practices surrounding the management of entities, whether they are created or extended.

Referring to the documentation, I notice that I can set up configuration for an entity or a field in different places:

In the migration scheme via options array
In the entity through annotations
In a yml configuration file (oro/entity_config. yml)

What is the best choice, if there is one? What are the most relevant practices depending on the context, entity creation or extension?

Thanks for the reading

Best regards

Topic

[Viacheslav BemzaParticipant]

Hello, Gmustiere!

At first, need to know that all configs are stored in database, in oro_entity_config and oro_entity_config_field tables. So all actions with config were saves in db.
If you create a new entity – it would be better to use annotations as a default values for entity config without passing them in migration file. But if you need to change configs for exiting entities – you should create a migration. You can use this queries in such migrations:
https://github.com/oroinc/platform/blob/2.5.0/src/Oro/Bundle/EntityConfigBundle/Migration/UpdateEntityConfigEntityValueQuery.php
https://github.com/oroinc/platform/blob/2.5.0/src/Oro/Bundle/EntityConfigBundle/Migration/UpdateEntityConfigFieldValueQuery.php

Also you can change some config values via UI. See documentation for entity management.

In a yml configuration file (oro/entity_config.yml)

This configuration describes a config structure for all entities and fields, but does not specify a value for a particular entity.

Note: If you need to reset all changes from UI and from migration to default values that described in entity annotation – you can use oro:entity-config:update command. But be careful with using this command on prod.

[Author]

Replies