File Content: AbstractNormalizer.php <?php /* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace PerformanceBooster\Symfony\Component\Serializer\Normalizer; use PerformanceBooster\Symfony\Component\Serializer\Exception\CircularReferenceException; use PerformanceBooster\Symfony\Component\Serializer\Exception\InvalidArgumentException; use PerformanceBooster\Symfony\Component\Serializer\Exception\LogicException; use PerformanceBooster\Symfony\Component\Serializer\Exception\MissingConstructorArgumentsException; use PerformanceBooster\Symfony\Component\Serializer\Exception\NotNormalizableValueException; use PerformanceBooster\Symfony\Component\Serializer\Exception\RuntimeException; use PerformanceBooster\Symfony\Component\Serializer\Mapping\AttributeMetadataInterface; use PerformanceBooster\Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface; use PerformanceBooster\Symfony\Component\Serializer\NameConverter\NameConverterInterface; use PerformanceBooster\Symfony\Component\Serializer\SerializerAwareInterface; use PerformanceBooster\Symfony\Component\Serializer\SerializerAwareTrait; /** * Normalizer implementation. * * @author Kévin Dunglas <dunglas@gmail.com> */ abstract class AbstractNormalizer implements NormalizerInterface, DenormalizerInterface, SerializerAwareInterface, CacheableSupportsMethodInterface { use ObjectToPopulateTrait; use SerializerAwareTrait; /* constants to configure the context */ /** * How many loops of circular reference to allow while normalizing. * * The default value of 1 means that when we encounter the same object a * second time, we consider that a circular reference. * * You can raise this value for special cases, e.g. in combination with the * max depth setting of the object normalizer. */ public const CIRCULAR_REFERENCE_LIMIT = 'circular_reference_limit'; /** * Instead of creating a new instance of an object, update the specified object. * * If you have a nested structure, child objects will be overwritten with * new instances unless you set DEEP_OBJECT_TO_POPULATE to true. */ public const OBJECT_TO_POPULATE = 'object_to_populate'; /** * Only (de)normalize attributes that are in the specified groups. */ public const GROUPS = 'groups'; /** * Limit (de)normalize to the specified names. * * For nested structures, this list needs to reflect the object tree. */ public const ATTRIBUTES = 'attributes'; /** * If ATTRIBUTES are specified, and the source has fields that are not part of that list, * either ignore those attributes (true) or throw an ExtraAttributesException (false). */ public const ALLOW_EXTRA_ATTRIBUTES = 'allow_extra_attributes'; /** * Hashmap of default values for constructor arguments. * * The names need to match the parameter names in the constructor arguments. */ public const DEFAULT_CONSTRUCTOR_ARGUMENTS = 'default_constructor_arguments'; /** * Hashmap of field name => callable to (de)normalize this field. * * The callable is called if the field is encountered with the arguments: * * - mixed $attributeValue value of this field * - object|string $object the whole object being normalized or the object's class being denormalized * - string $attributeName name of the attribute being (de)normalized * - string $format the requested format * - array $context the serialization context */ public const CALLBACKS = 'callbacks'; /** * Handler to call when a circular reference has been detected. * * If you specify no handler, a CircularReferenceException is thrown. * * The method will be called with ($object, $format, $context) and its * return value is returned as the result of the normalize call. */ public const CIRCULAR_REFERENCE_HANDLER = 'circular_reference_handler'; /** * Skip the specified attributes when normalizing an object tree. * * This list is applied to each element of nested structures. * * Note: The behaviour for nested structures is different from ATTRIBUTES * for historical reason. Aligning the behaviour would be a BC break. */ public const IGNORED_ATTRIBUTES = 'ignored_attributes'; /** * Require all properties to be listed in the input instead of falling * back to null for nullable ones. */ public const REQUIRE_ALL_PROPERTIES = 'require_all_properties'; /** * @internal */ protected const CIRCULAR_REFERENCE_LIMIT_COUNTERS = 'circular_reference_limit_counters'; protected $defaultContext = [self::ALLOW_EXTRA_ATTRIBUTES => \true, self::CIRCULAR_REFERENCE_HANDLER => null, self::CIRCULAR_REFERENCE_LIMIT => 1, self::IGNORED_ATTRIBUTES => []]; /** * @var ClassMetadataFactoryInterface|null */ protected $classMetadataFactory; /** * @var NameConverterInterface|null */ protected $nameConverter; /** * Sets the {@link ClassMetadataFactoryInterface} to use. */ public function __construct(?ClassMetadataFactoryInterface $classMetadataFactory = null, ?NameConverterInterface $nameConverter = null, array $defaultContext = []) { $this->classMetadataFactory = $classMetadataFactory; $this->nameConverter = $nameConverter; $this->defaultContext = \array_merge($this->defaultContext, $defaultContext); $this->validateCallbackContext($this->defaultContext, 'default'); if (isset($this->defaultContext[self::CIRCULAR_REFERENCE_HANDLER]) && !\is_callable($this->defaultContext[self::CIRCULAR_REFERENCE_HANDLER])) { throw new InvalidArgumentException(\sprintf('Invalid callback found in the "%s" default context option.', self::CIRCULAR_REFERENCE_HANDLER)); } } /** * @deprecated since Symfony 6.3, use "getSupportedTypes()" instead */ public function hasCacheableSupportsMethod() : bool { trigger_deprecation('symfony/serializer', '6.3', 'The "%s()" method is deprecated, implement "%s::getSupportedTypes()" instead.', __METHOD__, \get_debug_type($this)); return \false; } /** * Detects if the configured circular reference limit is reached. * * @throws CircularReferenceException */ protected function isCircularReference(object $object, array &$context) : bool { $objectHash = \spl_object_hash($object); $circularReferenceLimit = $context[self::CIRCULAR_REFERENCE_LIMIT] ?? $this->defaultContext[self::CIRCULAR_REFERENCE_LIMIT]; if (isset($context[self::CIRCULAR_REFERENCE_LIMIT_COUNTERS][$objectHash])) { if ($context[self::CIRCULAR_REFERENCE_LIMIT_COUNTERS][$objectHash] >= $circularReferenceLimit) { unset($context[self::CIRCULAR_REFERENCE_LIMIT_COUNTERS][$objectHash]); return \true; } ++$context[self::CIRCULAR_REFERENCE_LIMIT_COUNTERS][$objectHash]; } else { $context[self::CIRCULAR_REFERENCE_LIMIT_COUNTERS][$objectHash] = 1; } return \false; } /** * Handles a circular reference. * * If a circular reference handler is set, it will be called. Otherwise, a * {@class CircularReferenceException} will be thrown. * * @final * * @throws CircularReferenceException */ protected function handleCircularReference(object $object, ?string $format = null, array $context = []) : mixed { $circularReferenceHandler = $context[self::CIRCULAR_REFERENCE_HANDLER] ?? $this->defaultContext[self::CIRCULAR_REFERENCE_HANDLER]; if ($circularReferenceHandler) { return $circularReferenceHandler($object, $format, $context); } throw new CircularReferenceException(\sprintf('A circular reference has been detected when serializing the object of class "%s" (configured limit: %d).', \get_debug_type($object), $context[self::CIRCULAR_REFERENCE_LIMIT] ?? $this->defaultContext[self::CIRCULAR_REFERENCE_LIMIT])); } /** * Gets attributes to normalize using groups. * * @param bool $attributesAsString If false, return an array of {@link AttributeMetadataInterface} * * @return string[]|AttributeMetadataInterface[]|bool * * @throws LogicException if the 'allow_extra_attributes' context variable is false and no class metadata factory is provided */ protected function getAllowedAttributes(string|object $classOrObject, array $context, bool $attributesAsString = \false) { $allowExtraAttributes = $context[self::ALLOW_EXTRA_ATTRIBUTES] ?? $this->defaultContext[self::ALLOW_EXTRA_ATTRIBUTES]; if (!$this->classMetadataFactory) { if (!$allowExtraAttributes) { throw new LogicException(\sprintf('A class metadata factory must be provided in the constructor when setting "%s" to false.', self::ALLOW_EXTRA_ATTRIBUTES)); } return \false; } $groups = $this->getGroups($context); $allowedAttributes = []; $ignoreUsed = \false; foreach ($this->classMetadataFactory->getMetadataFor($classOrObject)->getAttributesMetadata() as $attributeMetadata) { if ($ignore = $attributeMetadata->isIgnored()) { $ignoreUsed = \true; } // If you update this check, update accordingly the one in Symfony\Component\PropertyInfo\Extractor\SerializerExtractor::getProperties() if (!$ignore && ([] === $groups || \array_intersect(\array_merge($attributeMetadata->getGroups(), ['*']), $groups)) && $this->isAllowedAttribute($classOrObject, $name = $attributeMetadata->getName(), null, $context)) { $allowedAttributes[] = $attributesAsString ? $name : $attributeMetadata; } } if (!$ignoreUsed && [] === $groups && $allowExtraAttributes) { // Backward Compatibility with the code using this method written before the introduction of @Ignore return \false; } return $allowedAttributes; } protected function getGroups(array $context) : array { $groups = $context[self::GROUPS] ?? $this->defaultContext[self::GROUPS] ?? []; return \is_scalar($groups) ? (array) $groups : $groups; } /** * Is this attribute allowed? * * @return bool */ protected function isAllowedAttribute(object|string $classOrObject, string $attribute, ?string $format = null, array $context = []) { $ignoredAttributes = $context[self::IGNORED_ATTRIBUTES] ?? $this->defaultContext[self::IGNORED_ATTRIBUTES]; if (\in_array($attribute, $ignoredAttributes)) { return \false; } $attributes = $context[self::ATTRIBUTES] ?? $this->defaultContext[self::ATTRIBUTES] ?? null; if (isset($attributes[$attribute])) { // Nested attributes return \true; } if (\is_array($attributes)) { return \in_array($attribute, $attributes, \true); } return \true; } /** * Normalizes the given data to an array. It's particularly useful during * the denormalization process. */ protected function prepareForDenormalization(mixed $data) : array { return (array) $data; } /** * Returns the method to use to construct an object. This method must be either * the object constructor or static. */ protected function getConstructor(array &$data, string $class, array &$context, \ReflectionClass $reflectionClass, array|bool $allowedAttributes) : ?\ReflectionMethod { return $reflectionClass->getConstructor(); } /** * Instantiates an object using constructor parameters when needed. * * This method also allows to denormalize data into an existing object if * it is present in the context with the object_to_populate. This object * is removed from the context before being returned to avoid side effects * when recursively normalizing an object graph. * * @return object * * @throws RuntimeException * @throws MissingConstructorArgumentsException */ protected function instantiateObject(array &$data, string $class, array &$context, \ReflectionClass $reflectionClass, array|bool $allowedAttributes, ?string $format = null) { if (null !== ($object = $this->extractObjectToPopulate($class, $context, self::OBJECT_TO_POPULATE))) { unset($context[self::OBJECT_TO_POPULATE]); return $object; } // clean up even if no match unset($context[static::OBJECT_TO_POPULATE]); $constructor = $this->getConstructor($data, $class, $context, $reflectionClass, $allowedAttributes); if ($constructor) { $context['has_constructor'] = \true; if (\true !== $constructor->isPublic()) { return $reflectionClass->newInstanceWithoutConstructor(); } $constructorParameters = $constructor->getParameters(); $missingConstructorArguments = []; $params = []; $unsetKeys = []; foreach ($constructorParameters as $constructorParameter) { $paramName = $constructorParameter->name; $attributeContext = $this->getAttributeDenormalizationContext($class, $paramName, $context); $key = $this->nameConverter ? $this->nameConverter->normalize($paramName, $class, $format, $context) : $paramName; $allowed = \false === $allowedAttributes || \in_array($paramName, $allowedAttributes); $ignored = !$this->isAllowedAttribute($class, $paramName, $format, $context); if ($constructorParameter->isVariadic()) { if ($allowed && !$ignored && (isset($data[$key]) || \array_key_exists($key, $data))) { if (!\is_array($data[$key])) { throw new RuntimeException(\sprintf('Cannot create an instance of "%s" from serialized data because the variadic parameter "%s" can only accept an array.', $class, $constructorParameter->name)); } $variadicParameters = []; foreach ($data[$key] as $parameterKey => $parameterData) { try { $variadicParameters[$parameterKey] = $this->denormalizeParameter($reflectionClass, $constructorParameter, $paramName, $parameterData, $attributeContext, $format); } catch (NotNormalizableValueException $exception) { if (!isset($context['not_normalizable_value_exceptions'])) { throw $exception; } $context['not_normalizable_value_exceptions'][] = $exception; $params[$paramName] = $parameterData; } } $params = \array_merge(\array_values($params), $variadicParameters); $unsetKeys[] = $key; } } elseif ($allowed && !$ignored && (isset($data[$key]) || \array_key_exists($key, $data))) { $parameterData = $data[$key]; if (null === $parameterData && $constructorParameter->allowsNull()) { $params[$paramName] = null; $unsetKeys[] = $key; continue; } try { $params[$paramName] = $this->denormalizeParameter($reflectionClass, $constructorParameter, $paramName, $parameterData, $attributeContext, $format); } catch (NotNormalizableValueException $exception) { if (!isset($context['not_normalizable_value_exceptions'])) { throw $exception; } $context['not_normalizable_value_exceptions'][] = $exception; $params[$paramName] = $parameterData; } $unsetKeys[] = $key; } elseif (\array_key_exists($key, $context[static::DEFAULT_CONSTRUCTOR_ARGUMENTS][$class] ?? [])) { $params[$paramName] = $context[static::DEFAULT_CONSTRUCTOR_ARGUMENTS][$class][$key]; } elseif (\array_key_exists($key, $this->defaultContext[self::DEFAULT_CONSTRUCTOR_ARGUMENTS][$class] ?? [])) { $params[$paramName] = $this->defaultContext[self::DEFAULT_CONSTRUCTOR_ARGUMENTS][$class][$key]; } elseif ($constructorParameter->isDefaultValueAvailable()) { $params[$paramName] = $constructorParameter->getDefaultValue(); } elseif (!($context[self::REQUIRE_ALL_PROPERTIES] ?? $this->defaultContext[self::REQUIRE_ALL_PROPERTIES] ?? \false) && $constructorParameter->hasType() && $constructorParameter->getType()->allowsNull()) { $params[$paramName] = null; } else { if (!isset($context['not_normalizable_value_exceptions'])) { $missingConstructorArguments[] = $constructorParameter->name; continue; } $constructorParameterType = 'unknown'; $reflectionType = $constructorParameter->getType(); if ($reflectionType instanceof \ReflectionNamedType) { $constructorParameterType = $reflectionType->getName(); } $exception = NotNormalizableValueException::createForUnexpectedDataType(\sprintf('Failed to create object because the class misses the "%s" property.', $constructorParameter->name), null, [$constructorParameterType], $attributeContext['deserialization_path'] ?? null, \true); $context['not_normalizable_value_exceptions'][] = $exception; } } if ($missingConstructorArguments) { throw new MissingConstructorArgumentsException(\sprintf('Cannot create an instance of "%s" from serialized data because its constructor requires the following parameters to be present : "$%s".', $class, \implode('", "$', $missingConstructorArguments)), 0, null, $missingConstructorArguments, $class); } if (!$constructor->isConstructor()) { $instance = $constructor->invokeArgs(null, $params); // do not set a parameter that has been set in the constructor foreach ($unsetKeys as $key) { unset($data[$key]); } return $instance; } try { $instance = $reflectionClass->newInstanceArgs($params); // do not set a parameter that has been set in the constructor foreach ($unsetKeys as $key) { unset($data[$key]); } return $instance; } catch (\TypeError $e) { if (!isset($context['not_normalizable_value_exceptions'])) { throw $e; } return $reflectionClass->newInstanceWithoutConstructor(); } } unset($context['has_constructor']); if (!$reflectionClass->isInstantiable()) { throw NotNormalizableValueException::createForUnexpectedDataType(\sprintf('Failed to create object because the class "%s" is not instantiable.', $class), $data, ['unknown'], $context['deserialization_path'] ?? null); } return new $class(); } /** * @internal */ protected function denormalizeParameter(\ReflectionClass $class, \ReflectionParameter $parameter, string $parameterName, mixed $parameterData, array $context, ?string $format = null) : mixed { try { if (($parameterType = $parameter->getType()) instanceof \ReflectionNamedType && !$parameterType->isBuiltin()) { $parameterClass = $parameterType->getName(); new \ReflectionClass($parameterClass); // throws a \ReflectionException if the class doesn't exist if (!$this->serializer instanceof DenormalizerInterface) { throw new LogicException(\sprintf('Cannot create an instance of "%s" from serialized data because the serializer inject in "%s" is not a denormalizer.', $parameterClass, static::class)); } $parameterData = $this->serializer->denormalize($parameterData, $parameterClass, $format, $this->createChildContext($context, $parameterName, $format)); } } catch (\ReflectionException $e) { throw new RuntimeException(\sprintf('Could not determine the class of the parameter "%s".', $parameterName), 0, $e); } catch (MissingConstructorArgumentsException $e) { if (!$parameter->getType()->allowsNull()) { throw $e; } return null; } return $this->applyCallbacks($parameterData, $class->getName(), $parameterName, $format, $context); } /** * @internal */ protected function createChildContext(array $parentContext, string $attribute, ?string $format) : array { if (isset($parentContext[self::ATTRIBUTES][$attribute])) { $parentContext[self::ATTRIBUTES] = $parentContext[self::ATTRIBUTES][$attribute]; } else { unset($parentContext[self::ATTRIBUTES]); } return $parentContext; } /** * Validate callbacks set in context. * * @param string $contextType Used to specify which context is invalid in exceptions * * @throws InvalidArgumentException */ protected final function validateCallbackContext(array $context, string $contextType = '') : void { if (!isset($context[self::CALLBACKS])) { return; } if (!\is_array($context[self::CALLBACKS])) { throw new InvalidArgumentException(\sprintf('The "%s"%s context option must be an array of callables.', self::CALLBACKS, '' !== $contextType ? " {$contextType}" : '')); } foreach ($context[self::CALLBACKS] as $attribute => $callback) { if (!\is_callable($callback)) { throw new InvalidArgumentException(\sprintf('Invalid callback found for attribute "%s" in the "%s"%s context option.', $attribute, self::CALLBACKS, '' !== $contextType ? " {$contextType}" : '')); } } } protected final function applyCallbacks(mixed $value, object|string $object, string $attribute, ?string $format, array $context) : mixed { /** * @var callable|null */ $callback = $context[self::CALLBACKS][$attribute] ?? $this->defaultContext[self::CALLBACKS][$attribute] ?? null; return $callback ? $callback($value, $object, $attribute, $format, $context) : $value; } /** * Computes the normalization context merged with current one. Metadata always wins over global context, as more specific. * * @internal */ protected function getAttributeNormalizationContext(object $object, string $attribute, array $context) : array { if (null === ($metadata = $this->getAttributeMetadata($object, $attribute))) { return $context; } return \array_merge($context, $metadata->getNormalizationContextForGroups($this->getGroups($context))); } /** * Computes the denormalization context merged with current one. Metadata always wins over global context, as more specific. * * @internal */ protected function getAttributeDenormalizationContext(string $class, string $attribute, array $context) : array { $context['deserialization_path'] = $context['deserialization_path'] ?? \false ? $context['deserialization_path'] . '.' . $attribute : $attribute; if (null === ($metadata = $this->getAttributeMetadata($class, $attribute))) { return $context; } return \array_merge($context, $metadata->getDenormalizationContextForGroups($this->getGroups($context))); } /** * @internal */ protected function getAttributeMetadata(object|string $objectOrClass, string $attribute) : ?AttributeMetadataInterface { if (!$this->classMetadataFactory) { return null; } return $this->classMetadataFactory->getMetadataFor($objectOrClass)->getAttributesMetadata()[$attribute] ?? null; } } Submit