Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. UidNormalizer.php

class UidNormalizer

Hierarchy

  • class \Symfony\Component\Serializer\Normalizer\UidNormalizer implements \Symfony\Component\Serializer\Normalizer\NormalizerInterface, \Symfony\Component\Serializer\Normalizer\DenormalizerInterface

Expanded class hierarchy of UidNormalizer

1 file declares its use of UidNormalizer
UidNormalizerContextBuilder.php in vendor/symfony/serializer/Context/Normalizer/UidNormalizerContextBuilder.php

File

vendor/symfony/serializer/Normalizer/UidNormalizer.php, line 18

Namespace

Symfony\Component\Serializer\Normalizer
View source
final class UidNormalizer implements NormalizerInterface, DenormalizerInterface {
    public const NORMALIZATION_FORMAT_KEY = 'uid_normalization_format';
    public const NORMALIZATION_FORMAT_CANONICAL = 'canonical';
    public const NORMALIZATION_FORMAT_BASE58 = 'base58';
    public const NORMALIZATION_FORMAT_BASE32 = 'base32';
    public const NORMALIZATION_FORMAT_RFC4122 = 'rfc4122';
    public const NORMALIZATION_FORMAT_RFC9562 = self::NORMALIZATION_FORMAT_RFC4122;
    // RFC 9562 obsoleted RFC 4122 but the format is the same
    public const NORMALIZATION_FORMATS = [
        self::NORMALIZATION_FORMAT_CANONICAL,
        self::NORMALIZATION_FORMAT_BASE58,
        self::NORMALIZATION_FORMAT_BASE32,
        self::NORMALIZATION_FORMAT_RFC4122,
    ];
    private array $defaultContext = [
        self::NORMALIZATION_FORMAT_KEY => self::NORMALIZATION_FORMAT_CANONICAL,
    ];
    public function __construct(array $defaultContext = []) {
        $this->defaultContext = array_merge($this->defaultContext, $defaultContext);
    }
    public function getSupportedTypes(?string $format) : array {
        return [
            AbstractUid::class => true,
        ];
    }
    
    /**
     * @param AbstractUid $object
     */
    public function normalize(mixed $object, ?string $format = null, array $context = []) : array|string|int|float|bool|\ArrayObject|null {
        return match ($context[self::NORMALIZATION_FORMAT_KEY] ?? $this->defaultContext[self::NORMALIZATION_FORMAT_KEY]) {    self::NORMALIZATION_FORMAT_CANONICAL => (string) $object,
            self::NORMALIZATION_FORMAT_BASE58 => $object->toBase58(),
            self::NORMALIZATION_FORMAT_BASE32 => $object->toBase32(),
            self::NORMALIZATION_FORMAT_RFC4122 => $object->toRfc4122(),
            default => throw new LogicException(\sprintf('The "%s" format is not valid.', $context[self::NORMALIZATION_FORMAT_KEY] ?? $this->defaultContext[self::NORMALIZATION_FORMAT_KEY])),
        
        };
    }
    public function supportsNormalization(mixed $data, ?string $format = null, array $context = []) : bool {
        return $data instanceof AbstractUid;
    }
    public function denormalize(mixed $data, string $type, ?string $format = null, array $context = []) : mixed {
        try {
            return $type::fromString($data);
        } catch (\InvalidArgumentException|\TypeError) {
            throw NotNormalizableValueException::createForUnexpectedDataType(\sprintf('The data is not a valid "%s" string representation.', $type), $data, [
                'string',
            ], $context['deserialization_path'] ?? null, true);
        }
    }
    public function supportsDenormalization(mixed $data, string $type, ?string $format = null, array $context = []) : bool {
        return is_subclass_of($type, AbstractUid::class, true);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
DenormalizerInterface::COLLECT_DENORMALIZATION_ERRORS public constant
UidNormalizer::$defaultContext private property
UidNormalizer::denormalize public function Denormalizes data back into an object of the given class. Overrides DenormalizerInterface::denormalize
UidNormalizer::getSupportedTypes public function Returns the types potentially supported by this normalizer. Overrides NormalizerInterface::getSupportedTypes
UidNormalizer::NORMALIZATION_FORMATS public constant
UidNormalizer::NORMALIZATION_FORMAT_BASE32 public constant
UidNormalizer::NORMALIZATION_FORMAT_BASE58 public constant
UidNormalizer::NORMALIZATION_FORMAT_CANONICAL public constant
UidNormalizer::NORMALIZATION_FORMAT_KEY public constant
UidNormalizer::NORMALIZATION_FORMAT_RFC4122 public constant
UidNormalizer::NORMALIZATION_FORMAT_RFC9562 public constant
UidNormalizer::normalize public function Overrides NormalizerInterface::normalize
UidNormalizer::supportsDenormalization public function Checks whether the given class is supported for denormalization by this normalizer. Overrides DenormalizerInterface::supportsDenormalization
UidNormalizer::supportsNormalization public function Checks whether the given class is supported for normalization by this normalizer. Overrides NormalizerInterface::supportsNormalization
UidNormalizer::__construct public function
RSS feed
Powered by Drupal