vendor/api-platform/core/src/Core/Identifier/IdentifierConverter.php line 40

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the API Platform project.
  5. *
  6. * (c) Kévin Dunglas <dunglas@gmail.com>
  7. *
  8. * For the full copyright and license information, please view the LICENSE
  9. * file that was distributed with this source code.
  10. */
  12. declare(strict_types=1);
  14. namespace ApiPlatform\Core\Identifier;
  16. use ApiPlatform\Core\Api\IdentifiersExtractorInterface;
  17. use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
  18. use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
  19. use ApiPlatform\Exception\InvalidIdentifierException;
  20. use Symfony\Component\PropertyInfo\Type;
  21. use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
  23. /**
  24. * Identifier converter that chains identifier denormalizers.
  25. *
  26. * @author Antoine Bluchet <soyuka@gmail.com>
  27. */
  28. final class IdentifierConverter implements ContextAwareIdentifierConverterInterface
  29. {
  30. private $propertyMetadataFactory;
  31. private $identifiersExtractor;
  32. private $identifierDenormalizers;
  33. private $resourceMetadataFactory;
  35. /**
  36. * TODO: rename identifierDenormalizers to identifierTransformers in 3.0 and change their interfaces to a IdentifierTransformerInterface.
  37. *
  38. * @param iterable<DenormalizerInterface> $identifierDenormalizers
  39. */
  40. public function __construct(IdentifiersExtractorInterface $identifiersExtractor, PropertyMetadataFactoryInterface $propertyMetadataFactory, iterable $identifierDenormalizers, ResourceMetadataFactoryInterface $resourceMetadataFactory = null)
  41. {
  42. $this->propertyMetadataFactory = $propertyMetadataFactory;
  43. $this->identifiersExtractor = $identifiersExtractor;
  44. $this->identifierDenormalizers = $identifierDenormalizers;
  45. $this->resourceMetadataFactory = $resourceMetadataFactory;
  46. }
  48. /**
  49. * {@inheritdoc}
  50. */
  51. public function convert($data, string $class, array $context = []): array
  52. {
  53. if (!\is_array($data)) {
  54. @trigger_error(sprintf('Not using an array as the first argument of "%s->convert" is deprecated since API Platform 2.6 and will not be possible anymore in API Platform 3', self::class), \E_USER_DEPRECATED);
  55. $data = ['id' => $data];
  56. }
  58. $identifiers = $data;
  60. foreach ($data as $parameter => $value) {
  61. if (null === $type = $this->getIdentifierType($context['identifiers'][$parameter][0] ?? $class, $context['identifiers'][$parameter][1] ?? $parameter)) {
  62. continue;
  63. }
  65. /* @var DenormalizerInterface[] */
  66. foreach ($this->identifierDenormalizers as $identifierTransformer) {
  67. if (!$identifierTransformer->supportsDenormalization($value, $type)) {
  68. continue;
  69. }
  71. try {
  72. $identifiers[$parameter] = $identifierTransformer->denormalize($value, $type);
  73. break;
  74. } catch (InvalidIdentifierException $e) { // @phpstan-ignore-line wrong choice of interface, was fixed in 3.0
  75. throw new InvalidIdentifierException(sprintf('Identifier "%s" could not be denormalized.', $parameter), $e->getCode(), $e);
  76. }
  77. }
  78. }
  80. return $identifiers;
  81. }
  83. private function getIdentifierType(string $resourceClass, string $property): ?string
  84. {
  85. if (!$type = $this->propertyMetadataFactory->create($resourceClass, $property)->getType()) {
  86. return null;
  87. }
  89. return Type::BUILTIN_TYPE_OBJECT === ($builtinType = $type->getBuiltinType()) ? $type->getClassName() : $builtinType;
  90. }
  91. }