vendor/symfony/serializer/Normalizer/BackedEnumNormalizer.php line 28

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.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. namespace Symfony\Component\Serializer\Normalizer;
  14. use Symfony\Component\PropertyInfo\Type;
  15. use Symfony\Component\Serializer\Exception\InvalidArgumentException;
  16. use Symfony\Component\Serializer\Exception\NotNormalizableValueException;
  18. /**
  19.  * Normalizes a {@see \BackedEnum} enumeration to a string or an integer.
  20.  *
  21.  * @author Alexandre Daubois <alex.daubois@gmail.com>
  22.  */
  23. final class BackedEnumNormalizer implements NormalizerInterface, DenormalizerInterface, CacheableSupportsMethodInterface
  24. {
  25.     /**
  26.      * {@inheritdoc}
  27.      */
  28.     public function normalize(mixed $object, string $format = null, array $context = []): int|string
  29.     {
  30.         if (!$object instanceof \BackedEnum) {
  31.             throw new InvalidArgumentException('The data must belong to a backed enumeration.');
  32.         }
  34.         return $object->value;
  35.     }
  37.     /**
  38.      * {@inheritdoc}
  39.      */
  40.     public function supportsNormalization(mixed $data, string $format = null, array $context = []): bool
  41.     {
  42.         return $data instanceof \BackedEnum;
  43.     }
  45.     /**
  46.      * {@inheritdoc}
  47.      *
  48.      * @throws NotNormalizableValueException
  49.      */
  50.     public function denormalize(mixed $data, string $type, string $format = null, array $context = []): mixed
  51.     {
  52.         if (!is_subclass_of($type, \BackedEnum::class)) {
  53.             throw new InvalidArgumentException('The data must belong to a backed enumeration.');
  54.         }
  56.         if (!\is_int($data) && !\is_string($data)) {
  57.             throw NotNormalizableValueException::createForUnexpectedDataType('The data is neither an integer nor a string, you should pass an integer or a string that can be parsed as an enumeration case of type '.$type.'.', $data, [Type::BUILTIN_TYPE_INT, Type::BUILTIN_TYPE_STRING], $context['deserialization_path'] ?? null, true);
  58.         }
  60.         try {
  61.             return $type::from($data);
  62.         } catch (\ValueError $e) {
  63.             throw new InvalidArgumentException('The data must belong to a backed enumeration of type '.$type);
  64.         }
  65.     }
  67.     /**
  68.      * {@inheritdoc}
  69.      */
  70.     public function supportsDenormalization(mixed $data, string $type, string $format = null, array $context = []): bool
  71.     {
  72.         return is_subclass_of($type, \BackedEnum::class);
  73.     }
  75.     /**
  76.      * {@inheritdoc}
  77.      */
  78.     public function hasCacheableSupportsMethod(): bool
  79.     {
  80.         return true;
  81.     }
  82. }