Configure Entities

So far, Doctrine offers a wide range of functionality to map your entities to the database, save your data, and retrieve it. However, in an application based on the OroPlatform, you usually want to control how entities are presented to the user.

OroPlatform includes EntityConfigBundle, which lets you configure additional metadata for your entities and their fields. For example, you can configure the icons and labels shown for an entity in the UI, or set up access levels that control how entities are viewed and modified.

Configure Entities and Their Fields

Entities are not configurable by default. Tag them as configurable so the system can apply entity config options:

The #[Config] attribute enables entity-level configuration.
Use the #[ConfigField] attribute to enable config options for selected fields.

Tip

The bundles from OroPlatform offer a large set of predefined options that you can use in your entities to configure them and control their behavior. Take a look at the entity_config.yml files that can be found in many bundles and read their dedicated documentation.

The `#[Config]` Attribute

To make the Document entity from the first part of the chapter configurable, import the Oro\Bundle\EntityConfigBundle\Metadata\Attribute\Config attribute and use it:

src/Acme/Bundle/DemoBundle/Entity/Document.php

 namespace Acme\Bundle\DemoBundle\Entity;

 use Doctrine\ORM\Mapping as ORM;
 use Oro\Bundle\EntityConfigBundle\Metadata\Attribute\Config;

 #[ORM\Entity]
 #[ORM\Table(name: 'acme_demo_document')]
 #[Config]
 class Document
 {
     // ...
 }

You can also change the default value of each configurable option using the defaultValues argument:

src/Acme/Bundle/DemoBundle/Entity/Document.php

namespace Acme\Bundle\DemoBundle\Entity;

use Doctrine\ORM\Mapping as ORM;
use Oro\Bundle\EntityConfigBundle\Attribute\Entity\AttributeFamily;

/**
 * ORM Entity Document.
 */
#[ORM\Table(name: 'acme_demo_document')]
#[Config(
    defaultValues: [
        'dataaudit' => ['auditable' => true],
    ]
)]

The `#[ConfigField]` Attribute

Similar to the #[Config] attribute for entities, you can use the Oro\Bundle\EntityConfigBundle\Metadata\Attribute\ConfigField attribute to make properties of an entity configurable. You can change default values the same way as at the entity level:

src/Acme/Bundle/DemoBundle/Entity/Document.php

    // ...
    #[ORM\Column(name: 'subject', type: 'string', length: 255, nullable: false)]
    #[ConfigField(defaultValues: ['dataaudit' => ['auditable' => true], 'importexport' => ['identity' => true]])]
    private $subject;
    // ...

Console Commands

Update Configuration Data

To update configurable entities, use the following:

php bin/console oro:entity-config:update

Run this command only in ‘dev’ mode, when a new configuration attribute or the whole configuration scope is added.

Clearing Up Cache

To remove all data related to configurable entities from the application cache, use:

php bin/console oro:entity-config:cache:clear

To skip warming up the cache after cleaning, use the --no-warmup command:

php bin/console oro:entity-config:cache:clear --no-warmup

Warming Up the Cache

To warm up the entity config cache, use the oro:entity-config:cache:warmup command:

php bin/console oro:entity-config:cache:warmup

Debugging Configuration Data

Use the oro:entity-config:debug command to get different types of configuration data and to add, remove, or update entity configuration. To see all available options, run it with the --help option.

The example shows all configuration data for the User entity:

php bin/console oro:entity-config:debug "Acme\Bundle\DemoBundle\Entity\Document"

Note

Check out the Attributes topic to learn how to assign functionality to an entity to create and manipulate attributes.

Configure Entities