Deprecated FieldDescription::getTargetEntity()

sonata-project · May 24, 2020 · 3ebeb5b · 3ebeb5b
1 parent 472ab29
commit 3ebeb5b
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 14 deletions.
diff --git a/src/Admin/FieldDescription.php b/src/Admin/FieldDescription.php
@@ -35,11 +35,28 @@ public function setAssociationMapping($associationMapping)
         $this->fieldName = $associationMapping['fieldName'];
     }
 
+    /**
+     * NEXT_MAJOR: Remove this method.
+     */
     public function getTargetEntity()
+    {
+        @trigger_error(sprintf(
+            'Method %s() is deprecated since sonata-project/doctrine-orm-admin-bundle 3.x and will be removed in version 4.0.'
+            .' Use %s::getTargetModel() instead.',
+            __METHOD__,
+            __CLASS__
+        ), E_USER_DEPRECATED);
+
+        return $this->getTargetModel();
+    }
+
+    public function getTargetModel(): ?string
     {
         if ($this->associationMapping) {
             return $this->associationMapping['targetEntity'];
         }
+
+        return null;
     }
 
     public function setFieldMapping($fieldMapping)

diff --git a/src/Builder/DatagridBuilder.php b/src/Builder/DatagridBuilder.php
@@ -158,7 +158,7 @@ public function addFilter(DatagridInterface $datagrid, $type, FieldDescriptionIn
 
         if (ModelAutocompleteFilter::class === $type) {
             $fieldDescription->mergeOption('field_options', [
-                'class' => $fieldDescription->getTargetEntity(),
+                'class' => $fieldDescription->getTargetModel(),
                 'model_manager' => $fieldDescription->getAdmin()->getModelManager(),
                 'admin_code' => $admin->getCode(),
                 'context' => 'filter',

diff --git a/src/Builder/FormContractor.php b/src/Builder/FormContractor.php
@@ -114,7 +114,7 @@ public function getDefaultOptions($type, FieldDescriptionInterface $fieldDescrip
                 ));
             }
 
-            $options['class'] = $fieldDescription->getTargetEntity();
+            $options['class'] = $fieldDescription->getTargetModel();
             $options['model_manager'] = $fieldDescription->getAdmin()->getModelManager();
 
             if ($this->checkFormClass($type, [ModelAutocompleteType::class])) {
@@ -123,7 +123,7 @@ public function getDefaultOptions($type, FieldDescriptionInterface $fieldDescrip
                         'The current field `%s` is not linked to an admin.'
                         .' Please create one for the target entity: `%s`',
                         $fieldDescription->getName(),
-                        $fieldDescription->getTargetEntity()
+                        $fieldDescription->getTargetModel()
                     ));
                 }
             }
@@ -133,7 +133,7 @@ public function getDefaultOptions($type, FieldDescriptionInterface $fieldDescrip
                     'The current field `%s` is not linked to an admin.'
                     .' Please create one for the target entity : `%s`',
                     $fieldDescription->getName(),
-                    $fieldDescription->getTargetEntity()
+                    $fieldDescription->getTargetModel()
                 ));
             }
 
@@ -165,7 +165,7 @@ public function getDefaultOptions($type, FieldDescriptionInterface $fieldDescrip
                     'The current field `%s` is not linked to an admin.'
                     .' Please create one for the target entity : `%s`',
                     $fieldDescription->getName(),
-                    $fieldDescription->getTargetEntity()
+                    $fieldDescription->getTargetModel()
                 ));
             }
 

diff --git a/src/Model/ModelManager.php b/src/Model/ModelManager.php
@@ -393,12 +393,12 @@ public function getNormalizedIdentifier($entity)
             UnitOfWork::STATE_NEW,
             UnitOfWork::STATE_REMOVED,
         ], true)) {
-                // NEXT_MAJOR: Uncomment the following exception, remove the deprecation and the return statement inside this conditional block.
-                // throw new \InvalidArgumentException(sprintf(
-                //    'Can not get the normalized identifier for %s since it is in state %u.',
-                //    ClassUtils::getClass($entity),
-                //    $this->getEntityManager($entity)->getUnitOfWork()->getEntityState($entity)
-                // ));
+            // NEXT_MAJOR: Uncomment the following exception, remove the deprecation and the return statement inside this conditional block.
+            // throw new \InvalidArgumentException(sprintf(
+            //    'Can not get the normalized identifier for %s since it is in state %u.',
+            //    ClassUtils::getClass($entity),
+            //    $this->getEntityManager($entity)->getUnitOfWork()->getEntityState($entity)
+            // ));
 
             @trigger_error(sprintf(
                 'Passing an object which is in state %u (new) or %u (removed) as argument 1 for %s() is deprecated since sonata-project/doctrine-orm-admin-bundle 3.x'

diff --git a/tests/Admin/FieldDescriptionTest.php b/tests/Admin/FieldDescriptionTest.php
@@ -303,11 +303,11 @@ public function testGetTargetEntity(): void
 
         $field = new FieldDescription();
 
-        $this->assertNull($field->getTargetEntity());
+        $this->assertNull($field->getTargetModel());
 
         $field->setAssociationMapping($assocationMapping);
 
-        $this->assertSame('someValue', $field->getTargetEntity());
+        $this->assertSame('someValue', $field->getTargetModel());
     }
 
     public function testIsIdentifierFromFieldMapping(): void

diff --git a/tests/Builder/FormContractorTest.php b/tests/Builder/FormContractorTest.php
@@ -76,7 +76,7 @@ public function testDefaultOptionsForSonataFormTypes(): void
 
         $fieldDescription = $this->createMock(FieldDescriptionInterface::class);
         $fieldDescription->method('getAdmin')->willReturn($admin);
-        $fieldDescription->method('getTargetEntity')->willReturn($modelClass);
+        $fieldDescription->method('getTargetModel')->willReturn($modelClass);
         $fieldDescription->method('getAssociationAdmin')->willReturn($admin);
         $admin->method('getNewInstance')->willReturn($model);