Important

You are browsing upcoming documentation for version 5.1 of OroCommerce, OroCRM, and OroPlatform, scheduled for release in March 2023. Read version 5.0 (the latest LTS version) of the Oro documentation to get up-to-date information.

See our Release Process documentation for more information on the currently supported and upcoming releases.

Entity Structure Data Provider

Namespace: Oro\Bundle\EntityBundle\Provider\EntityStructureDataProvider

It provides data of all configurable entities. Collects the following data (see Oro\Bundle\EntityBundle\Model\EntityStructure):

  • Entity aliases
  • Entity labels (translated)
  • Entity fields (see Oro\Bundle\EntityBundle\Model\EntityFieldStructure)
  • Entity options (for example, auditable)
  • Entity routes.

For every field, the following information is provided:

  • name
  • type
  • label (translated)
  • type of relation (oneToMany, manyToMany and so on)
  • options (for example [configurable: true, auditable: false]).

This data can be returned by API.

This data can be extended or modified using an event (see Entity Structure Options Event).