Refactor EntityMetadata and EntityConfigurator to remove targetEntityDisplayField and simplify display logic

Author: dragosprotung

psalm.baseline.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="6.14.2@bbd217fc98c0daa0a13aea2a7f119d03ba3fc9a0">
+<files psalm-version="6.14.3@d0b040a91f280f071c1abcb1b77ce3822058725a">
   <file src="src/Controller/BaseCrudController.php">
     <ArgumentTypeCoercion>
       <code><![CDATA[$apply]]></code>
@@ -43,6 +43,10 @@
       <code><![CDATA[$entityInstance]]></code>
     </PossiblyNullArgument>
     <PossiblyNullReference>
+      <code><![CDATA[getActionsConfig]]></code>
+      <code><![CDATA[getActionsConfig]]></code>
+      <code><![CDATA[getEditFormOptions]]></code>
+      <code><![CDATA[getNewFormOptions]]></code>
       <code><![CDATA[setFieldAssets]]></code>
       <code><![CDATA[setFieldAssets]]></code>
     </PossiblyNullReference>
@@ -74,14 +78,6 @@
       <code><![CDATA[$field->getValue()]]></code>
     </MixedArgument>
   </file>
-  <file src="src/Field/Configurator/EntityConfigurator/EntityMetadata.php">
-    <MismatchingDocblockParamType>
-      <code><![CDATA[string|(callable(object):string|TranslatableInterface|null)|null]]></code>
-    </MismatchingDocblockParamType>
-    <MismatchingDocblockReturnType>
-      <code><![CDATA[string|(callable(object):string|TranslatableInterface|null)|null]]></code>
-    </MismatchingDocblockReturnType>
-  </file>
   <file src="src/Form/DataTransformer/EntityFieldDataTransformer.php">
     <MissingTemplateParam>
       <code><![CDATA[DataTransformerInterface]]></code>

src/Field/Configurator/EntityConfigurator.php

@@ -82,7 +82,6 @@ public function configure(FieldDto $field, EntityDto $entityDto, AdminContext $c
             Type\class_string(DashboardControllerInterface::class)->coerce($context->getDashboardControllerFqcn()),
             $targetCrudControllerFqcn,
             $targetEntityFqcn,
-            EntityField::getEntityDisplayField($field),
             $field->getValue(),
         );
 
@@ -98,10 +97,10 @@ public function configure(FieldDto $field, EntityDto $entityDto, AdminContext $c
             throw new RuntimeException('Unknown association type.');
         }
 
-        if ($entityMetadata->targetEntityDisplayField() !== null) {
-            // even if the entity has __toString method EntityType form type will not use it if option value is set to NULL.
-            $field->setFormTypeOption('choice_label', $entityMetadata->targetEntityDisplayField());
-        }
+        $field->setFormTypeOption(
+            'choice_label',
+            fn (object $targetEntityInstance): string|null => EntityField::formatAsString($targetEntityInstance, $field, $this->translator),
+        );
 
         $autocompleteMode = Type\bool()->coerce($field->getCustomOption(EntityField::OPTION_AUTOCOMPLETE));
         $widgetMode       = Type\string()->coerce($field->getCustomOption(EntityField::OPTION_WIDGET));

src/Field/Configurator/EntityConfigurator/EntityMetadata.php

@@ -6,7 +6,6 @@
 
 use EasyCorp\Bundle\EasyAdminBundle\Contracts\Controller\CrudControllerInterface;
 use EasyCorp\Bundle\EasyAdminBundle\Contracts\Controller\DashboardControllerInterface;
-use Symfony\Contracts\Translation\TranslatableInterface;
 
 /**
  * @psalm-immutable
@@ -27,33 +26,27 @@ final class EntityMetadata
     /** @var class-string */
     private string $targetEntityFqcn;
 
-    /** @var string|(callable(object):string|TranslatableInterface|null)|null */
-    private $targetEntityDisplayField;
-
     private object|int|string|null $targetEntityId;
 
     /**
-     * @param class-string<CrudControllerInterface>                            $sourceCrudControllerFqcn
-     * @param class-string<DashboardControllerInterface>                       $targetDashboardControllerFqcn
-     * @param class-string<CrudControllerInterface>                            $targetCrudControllerFqcn
-     * @param class-string                                                     $targetEntityFqcn
-     * @param string|(callable(object):string|TranslatableInterface|null)|null $targetEntityDisplayField
+     * @param class-string<CrudControllerInterface>      $sourceCrudControllerFqcn
+     * @param class-string<DashboardControllerInterface> $targetDashboardControllerFqcn
+     * @param class-string<CrudControllerInterface>      $targetCrudControllerFqcn
+     * @param class-string                               $targetEntityFqcn
      */
     public function __construct(
         object|int|string|null $sourceEntityId,
         string $sourceCrudControllerFqcn,
         string $targetDashboardControllerFqcn,
         string $targetCrudControllerFqcn,
         string $targetEntityFqcn,
-        string|callable|null $targetEntityDisplayField,
         object|int|string|null $targetEntityId,
     ) {
         $this->sourceEntityId                = $sourceEntityId;
         $this->sourceCrudControllerFqcn      = $sourceCrudControllerFqcn;
         $this->targetDashboardControllerFqcn = $targetDashboardControllerFqcn;
         $this->targetCrudControllerFqcn      = $targetCrudControllerFqcn;
         $this->targetEntityFqcn              = $targetEntityFqcn;
-        $this->targetEntityDisplayField      = $targetEntityDisplayField;
         $this->targetEntityId                = $targetEntityId;
     }
 
@@ -94,14 +87,6 @@ public function targetEntityFqcn(): string
         return $this->targetEntityFqcn;
     }
 
-    /**
-     * @return string|(callable(object):string|TranslatableInterface|null)|null
-     */
-    public function targetEntityDisplayField(): string|callable|null
-    {
-        return $this->targetEntityDisplayField;
-    }
-
     public function targetEntityId(): object|int|string|null
     {
         return $this->targetEntityId;