vendor/api-platform/core/src/GraphQl/Serializer/ItemNormalizer.php line 66

  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\GraphQl\Serializer;
  16. use ApiPlatform\Api\IdentifiersExtractorInterface;
  17. use ApiPlatform\Api\IriConverterInterface;
  18. use ApiPlatform\Api\ResourceClassResolverInterface;
  19. use ApiPlatform\Metadata\ApiProperty;
  20. use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
  21. use ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
  22. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  23. use ApiPlatform\Metadata\Util\ClassInfoTrait;
  24. use ApiPlatform\Serializer\ItemNormalizer as BaseItemNormalizer;
  25. use ApiPlatform\Symfony\Security\ResourceAccessCheckerInterface;
  26. use Psr\Log\LoggerInterface;
  27. use Psr\Log\NullLogger;
  28. use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
  29. use Symfony\Component\Serializer\Exception\UnexpectedValueException;
  30. use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface;
  31. use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
  33. /**
  34.  * GraphQL normalizer.
  35.  *
  36.  * @author Kévin Dunglas <dunglas@gmail.com>
  37.  */
  38. final class ItemNormalizer extends BaseItemNormalizer
  39. {
  40.     use ClassInfoTrait;
  42.     public const FORMAT = 'graphql';
  43.     public const ITEM_RESOURCE_CLASS_KEY = '#itemResourceClass';
  44.     public const ITEM_IDENTIFIERS_KEY = '#itemIdentifiers';
  46.     public function __construct(PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, IriConverterInterface $iriConverter, private readonly IdentifiersExtractorInterface $identifiersExtractor, ResourceClassResolverInterface $resourceClassResolver, PropertyAccessorInterface $propertyAccessor = null, NameConverterInterface $nameConverter = null, ClassMetadataFactoryInterface $classMetadataFactory = null, LoggerInterface $logger = null, ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory = null, ResourceAccessCheckerInterface $resourceAccessChecker = null)
  47.     {
  48.         parent::__construct($propertyNameCollectionFactory, $propertyMetadataFactory, $iriConverter, $resourceClassResolver, $propertyAccessor, $nameConverter, $classMetadataFactory, $logger ?: new NullLogger(), $resourceMetadataCollectionFactory, $resourceAccessChecker);
  49.     }
  51.     /**
  52.      * {@inheritdoc}
  53.      */
  54.     public function supportsNormalization(mixed $data, string $format = null, array $context = []): bool
  55.     {
  56.         return self::FORMAT === $format && parent::supportsNormalization($data, $format, $context);
  57.     }
  59.     /**
  60.      * {@inheritdoc}
  61.      *
  62.      * @param array<string, mixed> $context
  63.      *
  64.      * @throws UnexpectedValueException
  65.      */
  66.     public function normalize(mixed $object, string $format = null, array $context = []): array|string|int|float|bool|\ArrayObject|null
  67.     {
  68.         $resourceClass = $this->getObjectClass($object);
  70.         if ($this->getOutputClass($context)) {
  71.             $context['graphql_identifiers'] = [
  72.                 self::ITEM_RESOURCE_CLASS_KEY => $context['operation']->getClass(),
  73.                 self::ITEM_IDENTIFIERS_KEY => $this->identifiersExtractor->getIdentifiersFromItem($object, $context['operation'] ?? null),
  74.             ];
  76.             return parent::normalize($object, $format, $context);
  77.         }
  79.         unset($context['operation_name'], $context['operation']);
  80.         $data = parent::normalize($object, $format, $context);
  81.         if (!\is_array($data)) {
  82.             throw new UnexpectedValueException('Expected data to be an array.');
  83.         }
  85.         if (isset($context['graphql_identifiers'])) {
  86.             $data += $context['graphql_identifiers'];
  87.         } elseif (!($context['no_resolver_data'] ?? false)) {
  88.             $data[self::ITEM_RESOURCE_CLASS_KEY] = $resourceClass;
  89.             $data[self::ITEM_IDENTIFIERS_KEY] = $this->identifiersExtractor->getIdentifiersFromItem($object, $context['operation'] ?? null);
  90.         }
  92.         return $data;
  93.     }
  95.     /**
  96.      * {@inheritdoc}
  97.      */
  98.     protected function normalizeCollectionOfRelations(ApiProperty $propertyMetadata, iterable $attributeValue, string $resourceClass, ?string $format, array $context): array
  99.     {
  100.         // to-many are handled directly by the GraphQL resolver
  101.         return [];
  102.     }
  104.     /**
  105.      * {@inheritdoc}
  106.      */
  107.     public function supportsDenormalization(mixed $data, string $type, string $format = null, array $context = []): bool
  108.     {
  109.         return self::FORMAT === $format && parent::supportsDenormalization($data, $type, $format, $context);
  110.     }
  112.     /**
  113.      * {@inheritdoc}
  114.      */
  115.     protected function getAllowedAttributes(string|object $classOrObject, array $context, bool $attributesAsString = false): array|bool
  116.     {
  117.         $allowedAttributes = parent::getAllowedAttributes($classOrObject, $context, $attributesAsString);
  119.         if (($context['api_denormalize'] ?? false) && \is_array($allowedAttributes) && false !== ($indexId = array_search('id', $allowedAttributes, true))) {
  120.             $allowedAttributes[] = '_id';
  121.             array_splice($allowedAttributes, (int) $indexId, 1);
  122.         }
  124.         return $allowedAttributes;
  125.     }
  127.     /**
  128.      * {@inheritdoc}
  129.      */
  130.     protected function setAttributeValue($object, $attribute, $value, $format = null, array $context = []): void
  131.     {
  132.         if ('_id' === $attribute) {
  133.             $attribute = 'id';
  134.         }
  136.         parent::setAttributeValue($object, $attribute, $value, $format, $context);
  137.     }
  138. }