chore(deprecation): remove class aliases

api-platform · Jun 29, 2022 · e2df259 · e2df259
1 parent 6889fd3
commit e2df259
Show file tree

Hide file tree

Showing 14 changed files with 47 additions and 353 deletions.
diff --git a/AbstractCollectionNormalizer.php b/AbstractCollectionNormalizer.php
@@ -155,5 +155,3 @@ abstract protected function getPaginationData($object, array $context = []): arr
      */
     abstract protected function getItemsData($object, string $format = null, array $context = []): array;
 }
-
-class_alias(AbstractCollectionNormalizer::class, \ApiPlatform\Core\Serializer\AbstractCollectionNormalizer::class);
diff --git a/AbstractConstraintViolationListNormalizer.php b/AbstractConstraintViolationListNormalizer.php
@@ -85,5 +85,3 @@ protected function getMessagesAndViolations(ConstraintViolationListInterface $co
         return [$messages, $violations];
     }
 }
-
-class_alias(AbstractConstraintViolationListNormalizer::class, \ApiPlatform\Core\Serializer\AbstractConstraintViolationListNormalizer::class);
diff --git a/AbstractItemNormalizer.php b/AbstractItemNormalizer.php
@@ -15,14 +15,6 @@
 
 use ApiPlatform\Api\IriConverterInterface;
 use ApiPlatform\Api\UrlGeneratorInterface;
-use ApiPlatform\Core\Api\IriConverterInterface as LegacyIriConverterInterface;
-use ApiPlatform\Core\Bridge\Symfony\Messenger\DataTransformer as MessengerDataTransformer;
-use ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
-use ApiPlatform\Core\DataTransformer\DataTransformerInitializerInterface;
-use ApiPlatform\Core\DataTransformer\DataTransformerInterface;
-use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface as LegacyPropertyMetadataFactoryInterface;
-use ApiPlatform\Core\Metadata\Property\PropertyMetadata;
-use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
 use ApiPlatform\Exception\InvalidArgumentException;
 use ApiPlatform\Exception\InvalidValueException;
 use ApiPlatform\Exception\ItemNotFoundException;
@@ -78,16 +70,15 @@ abstract class AbstractItemNormalizer extends AbstractObjectNormalizer
     protected $resourceClassResolver;
     protected $resourceAccessChecker;
     protected $propertyAccessor;
-    protected $itemDataProvider;
     protected $allowPlainIdentifiers;
     protected $dataTransformers = [];
     protected $localCache = [];
 
-    public function __construct(PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, $propertyMetadataFactory, $iriConverter, $resourceClassResolver, PropertyAccessorInterface $propertyAccessor = null, NameConverterInterface $nameConverter = null, ClassMetadataFactoryInterface $classMetadataFactory = null, ItemDataProviderInterface $itemDataProvider = null, bool $allowPlainIdentifiers = false, array $defaultContext = [], iterable $dataTransformers = [], $resourceMetadataFactory = null, ResourceAccessCheckerInterface $resourceAccessChecker = null)
+    public function __construct(PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, $propertyMetadataFactory, $iriConverter, $resourceClassResolver, PropertyAccessorInterface $propertyAccessor = null, NameConverterInterface $nameConverter = null, ClassMetadataFactoryInterface $classMetadataFactory = null, array $defaultContext = [], ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory = null, ResourceAccessCheckerInterface $resourceAccessChecker = null)
     {
         if (!isset($defaultContext['circular_reference_handler'])) {
             $defaultContext['circular_reference_handler'] = function ($object) {
-                return $this->iriConverter instanceof LegacyIriConverterInterface ? $this->iriConverter->getIriFromItem($object) : $this->iriConverter->getIriFromResource($object);
+                return $this->iriConverter->getIriFromResource($object);
             };
         }
         if (!interface_exists(AdvancedNameConverterInterface::class) && method_exists($this, 'setCircularReferenceHandler')) {
@@ -98,36 +89,9 @@ public function __construct(PropertyNameCollectionFactoryInterface $propertyName
 
         $this->propertyNameCollectionFactory = $propertyNameCollectionFactory;
         $this->propertyMetadataFactory = $propertyMetadataFactory;
-
-        if ($iriConverter instanceof LegacyIriConverterInterface) {
-            trigger_deprecation('api-platform/core', '2.7', sprintf('Use an implementation of "%s" instead of "%s".', IriConverterInterface::class, LegacyIriConverterInterface::class));
-        }
-
         $this->iriConverter = $iriConverter;
         $this->resourceClassResolver = $resourceClassResolver;
         $this->propertyAccessor = $propertyAccessor ?: PropertyAccess::createPropertyAccessor();
-        $this->itemDataProvider = $itemDataProvider;
-
-        if (true === $allowPlainIdentifiers) {
-            @trigger_error(sprintf('Allowing plain identifiers as argument of "%s" is deprecated since API Platform 2.7 and will not be possible anymore in API Platform 3.', self::class), \E_USER_DEPRECATED);
-        }
-        $this->allowPlainIdentifiers = $allowPlainIdentifiers;
-
-        $this->dataTransformers = $dataTransformers;
-
-        // Just skip our data transformer to trigger a proper deprecation
-        $customDataTransformers = array_filter(\is_array($dataTransformers) ? $dataTransformers : iterator_to_array($dataTransformers), function ($dataTransformer) {
-            return !$dataTransformer instanceof MessengerDataTransformer;
-        });
-
-        if (\count($customDataTransformers)) {
-            trigger_deprecation('api-platform/core', '2.7', 'The DataTransformer pattern is deprecated, use a Provider or a Processor and either use your input or return a new output there.');
-        }
-
-        if ($resourceMetadataFactory && !$resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
-            trigger_deprecation('api-platform/core', '2.7', sprintf('Use "%s" instead of "%s".', ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));
-        }
-
         $this->resourceMetadataFactory = $resourceMetadataFactory;
         $this->resourceAccessChecker = $resourceAccessChecker;
     }
@@ -188,7 +152,7 @@ public function normalize($object, $format = null, array $context = [])
         if (isset($context['iri'])) {
             $iri = $context['iri'];
         } else {
-            $iri = $this->iriConverter instanceof LegacyIriConverterInterface ? $this->iriConverter->getIriFromItem($object) : $this->iriConverter->getIriFromResource($object, UrlGeneratorInterface::ABS_URL, $context['operation'] ?? null, $context);
+            $iri = $this->iriConverter->getIriFromResource($object, UrlGeneratorInterface::ABS_URL, $context['operation'] ?? null, $context);
         }
 
         $context['iri'] = $iri;
@@ -245,71 +209,25 @@ public function denormalize($data, $class, $format = null, array $context = [])
         $context['api_denormalize'] = true;
         $context['resource_class'] = $resourceClass;
 
-        if (null !== $inputClass = $this->getInputClass($resourceClass, $context)) {
-            if (null !== $dataTransformer = $this->getDataTransformer($data, $resourceClass, $context)) {
-                $dataTransformerContext = $context;
-
-                unset($context['input']);
-                unset($context['resource_class']);
-
-                if (!$this->serializer instanceof DenormalizerInterface) {
-                    throw new LogicException('Cannot denormalize the input because the injected serializer is not a denormalizer');
-                }
-
-                if ($dataTransformer instanceof DataTransformerInitializerInterface) {
-                    $context[AbstractObjectNormalizer::OBJECT_TO_POPULATE] = $dataTransformer->initialize($inputClass, $context);
-                    $context[AbstractObjectNormalizer::DEEP_OBJECT_TO_POPULATE] = true;
-                }
-
-                try {
-                    $denormalizedInput = $this->serializer->denormalize($data, $inputClass, $format, $context);
-                } catch (NotNormalizableValueException $e) {
-                    throw new UnexpectedValueException('The input data is misformatted.', $e->getCode(), $e);
-                }
-
-                if (!\is_object($denormalizedInput)) {
-                    throw new UnexpectedValueException('Expected denormalized input to be an object.');
-                }
-
-                return $dataTransformer->transform($denormalizedInput, $resourceClass, $dataTransformerContext);
-            }
-
-            // Are we in a Request context?
-            if ($context['operation'] ?? $context['operation_type'] ?? false) {
-                $resourceClass = $inputClass;
-                $context['resource_class'] = $inputClass;
-            }
+        if (
+            $inputClass = $this->getInputClass($resourceClass, $context)
+            &&
+            ($context['operation'] ?? $context['operation_type'] ?? false) // Are we in a Request context?
+        ) {
+            $resourceClass = $inputClass;
+            $context['resource_class'] = $inputClass;
         }
 
-        $supportsPlainIdentifiers = $this->supportsPlainIdentifiers();
-
         if (\is_string($data)) {
             try {
-                return $this->iriConverter instanceof LegacyIriConverterInterface ? $this->iriConverter->getItemFromIri($data, $context + ['fetch_data' => true]) : $this->iriConverter->getResourceFromIri($data, $context + ['fetch_data' => true]);
+                return $this->iriConverter->getResourceFromIri($data, $context + ['fetch_data' => true]);
             } catch (ItemNotFoundException $e) {
-                if (!$supportsPlainIdentifiers) {
-                    throw new UnexpectedValueException($e->getMessage(), $e->getCode(), $e);
-                }
+                throw new UnexpectedValueException($e->getMessage(), $e->getCode(), $e);
             } catch (InvalidArgumentException $e) {
-                if (!$supportsPlainIdentifiers) {
-                    throw new UnexpectedValueException(sprintf('Invalid IRI "%s".', $data), $e->getCode(), $e);
-                }
+                throw new UnexpectedValueException(sprintf('Invalid IRI "%s".', $data), $e->getCode(), $e);
             }
         }
 
-        if (!\is_array($data)) {
-            if (!$supportsPlainIdentifiers) {
-                throw new UnexpectedValueException(sprintf('Expected IRI or document for resource "%s", "%s" given.', $resourceClass, \gettype($data)));
-            }
-
-            $item = $this->itemDataProvider->getItem($resourceClass, $data, null, $context + ['fetch_data' => true]);
-            if (null === $item) {
-                throw new ItemNotFoundException(sprintf('Item not found for resource "%s" with id "%s".', $resourceClass, $data));
-            }
-
-            return $item;
-        }
-
         $previousObject = null !== $objectToPopulate ? clone $objectToPopulate : null;
         $object = parent::denormalize($data, $resourceClass, $format, $context);
 
@@ -598,19 +516,13 @@ protected function denormalizeCollection(string $attribute, $propertyMetadata, T
      */
     protected function denormalizeRelation(string $attributeName, $propertyMetadata, string $className, $value, ?string $format, array $context)
     {
-        $supportsPlainIdentifiers = $this->supportsPlainIdentifiers();
-
         if (\is_string($value)) {
             try {
-                return $this->iriConverter instanceof LegacyIriConverterInterface ? $this->iriConverter->getItemFromIri($value, $context + ['fetch_data' => true]) : $this->iriConverter->getResourceFromIri($value, $context + ['fetch_data' => true]);
+                return $this->iriConverter->getResourceFromIri($value, $context + ['fetch_data' => true]);
             } catch (ItemNotFoundException $e) {
-                if (!$supportsPlainIdentifiers) {
-                    throw new UnexpectedValueException($e->getMessage(), $e->getCode(), $e);
-                }
+                throw new UnexpectedValueException($e->getMessage(), $e->getCode(), $e);
             } catch (InvalidArgumentException $e) {
-                if (!$supportsPlainIdentifiers) {
-                    throw new UnexpectedValueException(sprintf('Invalid IRI "%s".', $value), $e->getCode(), $e);
-                }
+                throw new UnexpectedValueException(sprintf('Invalid IRI "%s".', $value), $e->getCode(), $e);
             }
         }
 
@@ -629,23 +541,12 @@ protected function denormalizeRelation(string $attributeName, $propertyMetadata,
 
                 return $item;
             } catch (InvalidValueException $e) {
-                if (!$supportsPlainIdentifiers) {
-                    throw $e;
-                }
+                throw $e;
             }
         }
 
         if (!\is_array($value)) {
-            if (!$supportsPlainIdentifiers) {
-                throw new UnexpectedValueException(sprintf('Expected IRI or nested document for attribute "%s", "%s" given.', $attributeName, \gettype($value)));
-            }
-
-            $item = $this->itemDataProvider->getItem($className, $value, null, $context + ['fetch_data' => true]);
-            if (null === $item) {
-                throw new ItemNotFoundException(sprintf('Item not found for resource "%s" with id "%s".', $className, $value));
-            }
-
-            return $item;
+            throw new UnexpectedValueException(sprintf('Expected IRI or nested document for attribute "%s", "%s" given.', $attributeName, \gettype($value)));
         }
 
         throw new UnexpectedValueException(sprintf('Nested documents for attribute "%s" are not allowed. Use IRIs instead.', $attributeName));
@@ -859,50 +760,14 @@ protected function normalizeRelation($propertyMetadata, $relatedObject, string $
         return $iri;
     }
 
-    /**
-     * Finds the first supported data transformer if any.
-     *
-     * @param object|array $data object on normalize / array on denormalize
-     */
-    protected function getDataTransformer($data, string $to, array $context = []): ?DataTransformerInterface
-    {
-        foreach ($this->dataTransformers as $dataTransformer) {
-            if ($dataTransformer->supportsTransformation($data, $to, $context)) {
-                return $dataTransformer;
-            }
-        }
-
-        return null;
-    }
-
-    /**
-     * For a given resource, it returns an output representation if any
-     * If not, the resource is returned.
-     *
-     * @param mixed $object
-     */
-    protected function transformOutput($object, array $context = [], string $outputClass = null)
-    {
-        if (null === $outputClass) {
-            $outputClass = $this->getOutputClass($this->getObjectClass($object), $context);
-        }
-
-        if (null !== $outputClass && null !== $dataTransformer = $this->getDataTransformer($object, $outputClass, $context)) {
-            return $dataTransformer->transform($object, $outputClass, $context);
-        }
-
-        return $object;
-    }
-
     private function createAttributeValue($attribute, $value, $format = null, array $context = [])
     {
         if (!$this->resourceClassResolver->isResourceClass($context['resource_class'])) {
             return $value;
         }
 
-        /** @var ApiProperty|PropertyMetadata */
         $propertyMetadata = $this->propertyMetadataFactory->create($context['resource_class'], $attribute, $this->getFactoryOptions($context));
-        $type = $propertyMetadata instanceof PropertyMetadata ? $propertyMetadata->getType() : ($propertyMetadata->getBuiltinTypes()[0] ?? null);
+        $type = $propertyMetadata->getBuiltinTypes()[0] ?? null;
 
         if (null === $type) {
             // No type provided, blindly return the value
@@ -1040,16 +905,4 @@ private function setValue($object, string $attributeName, $value)
             // Properties not found are ignored
         }
     }
-
-    /**
-     * TODO: to remove in 3.0.
-     *
-     * @deprecated since 2.7
-     */
-    private function supportsPlainIdentifiers(): bool
-    {
-        return $this->allowPlainIdentifiers && null !== $this->itemDataProvider;
-    }
 }
-
-class_alias(AbstractItemNormalizer::class, \ApiPlatform\Core\Serializer\AbstractItemNormalizer::class);
diff --git a/CacheKeyTrait.php b/CacheKeyTrait.php
@@ -34,5 +34,3 @@ private function getCacheKey(?string $format, array $context)
         }
     }
 }
-
-class_alias(CacheKeyTrait::class, \ApiPlatform\Core\Serializer\CacheKeyTrait::class);
diff --git a/ContextTrait.php b/ContextTrait.php
@@ -31,5 +31,3 @@ private function initContext(string $resourceClass, array $context): array
         ]);
     }
 }
-
-class_alias(ContextTrait::class, \ApiPlatform\Core\Serializer\ContextTrait::class);
diff --git a/Filter/GroupFilter.php b/Filter/GroupFilter.php
@@ -75,5 +75,3 @@ public function getDescription(string $resourceClass): array
         ];
     }
 }
-
-class_alias(GroupFilter::class, \ApiPlatform\Core\Serializer\Filter\GroupFilter::class);
diff --git a/Filter/PropertyFilter.php b/Filter/PropertyFilter.php
@@ -168,5 +168,3 @@ private function denormalizePropertyName($property)
         return null !== $this->nameConverter ? $this->nameConverter->denormalize($property) : $property;
     }
 }
-
-class_alias(PropertyFilter::class, \ApiPlatform\Core\Serializer\Filter\PropertyFilter::class);
diff --git a/InputOutputMetadataTrait.php b/InputOutputMetadataTrait.php
@@ -85,5 +85,3 @@ private function getInputOutputMetadata(string $class, string $inputOrOutput, ar
         return $metadata->getAttribute($inputOrOutput)['class'] ?? null;
     }
 }
-
-class_alias(InputOutputMetadataTrait::class, \ApiPlatform\Core\Serializer\InputOutputMetadataTrait::class);
-Original file line number
+Diff line change
@@ Expand Up @@
          */
         abstract protected function getItemsData($object, string $format = null, array $context = []): array;
     }
-    class_alias(AbstractCollectionNormalizer::class, \ApiPlatform\Core\Serializer\AbstractCollectionNormalizer::class);