Important

You are browsing upcoming documentation for version 7.1 of OroCommerce, scheduled for release in 2027. Read the documentation for the latest LTS version to get up-to-date information.

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

Entity Class Name Provider

This service provides a human-readable representation in English of an entity class name. OroPlatform uses it to describe REST API resources generated on the fly. See DictionaryEntityApiDocHandler for details.

Interface of an entity class name provider

The entity class name provider service is a “chain” service. It asks a set of prioritized providers for a human-readable representation of an entity class name. Each child service must implement EntityClassNameProviderInterface, which declares the following methods:

• getEntityClassName - returns a human-readable representation for an entity class.

• getEntityClassPluralName - returns a human-readable representation in plural for an entity class.

Create custom entity class name provider

To create your own provider, create a class implementing EntityClassNameProviderInterface and register it in the DI container with the tag oro_entity.class_name_provider. You can also use the existing abstract provider as a superclass.

src/Acme/Bundle/DemoBundle/Provider/AcmeClassNameProvider.php

namespace Acme\Bundle\DemoBundle\Provider;

use Acme\Bundle\DemoBundle\Entity\Priority;
use Oro\Bundle\EntityBundle\Provider\AbstractEntityClassNameProvider;
use Oro\Bundle\EntityBundle\Provider\EntityClassNameProviderInterface;

/**
 * The default implementation of a service to get human-readable names in English of entity classes.
 */
class AcmeClassNameProvider extends AbstractEntityClassNameProvider implements EntityClassNameProviderInterface
{
    #[\Override]
    public function getEntityClassName(string $entityClass): ?string
    {
        // add your implementation here
        if ($entityClass !== Priority::class) {
            return null;
        }

        return "PRIORITY";
    }

    #[\Override]
    public function getEntityClassPluralName(string $entityClass): ?string
    {
        // add your implementation here
        return $this->getName($entityClass, true);
    }
}

src/Acme/Bundle/DemoBundle/Resources/config/services.yml

services:
    acme_demo.priority_entity_name_provider:
        class: Acme\Bundle\DemoBundle\Provider\AcmeClassNameProvider
        arguments:
            - "@oro_entity_config.config_manager"
            - "@translator"
            - '@Doctrine\Inflector\Inflector'
        tags:
            - { name: oro_entity.class_name_provider, priority: 100 }

Specify a priority to move the provider up or down the chain. The higher the priority number, the earlier the provider runs. The priority value is optional and defaults to 0.