ApiPlatform\Serializer\AbstractItemNormalizer

Base item normalizer.

class ApiPlatform\Serializer\AbstractItemNormalizer extends Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer implements Symfony\Component\Serializer\Normalizer\NormalizerInterface, Symfony\Component\Serializer\Normalizer\DenormalizerInterface, Symfony\Component\Serializer\SerializerAwareInterface
{
    public __construct($propertyNameCollectionFactory, `<a href="/docs/main/references/Metadata/Property/Factory/PropertyMetadataFactoryInterface">ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface</a>` $propertyMetadataFactory, `<a href="/docs/main/references/Api/IriConverterInterface">ApiPlatform\Api\IriConverterInterface</a>`|`<a href="/docs/main/references/Api/IriConverterInterface">ApiPlatform\Metadata\IriConverterInterface</a>` $iriConverter, `<a href="/docs/main/references/Api/ResourceClassResolverInterface">ApiPlatform\Api\ResourceClassResolverInterface</a>`|`<a href="/docs/main/references/Api/ResourceClassResolverInterface">ApiPlatform\Metadata\ResourceClassResolverInterface</a>` $resourceClassResolver, null|Symfony\Component\PropertyAccess\PropertyAccessorInterface $propertyAccessor, null|Symfony\Component\Serializer\NameConverter\NameConverterInterface $nameConverter, null|Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface $classMetadataFactory, array $defaultContext, null|`<a href="/docs/main/references/Metadata/Resource/Factory/ResourceMetadataCollectionFactoryInterface">ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface</a>` $resourceMetadataCollectionFactory, null|`<a href="/docs/main/references/Metadata/ResourceAccessCheckerInterface">ApiPlatform\Metadata\ResourceAccessCheckerInterface</a>` $resourceAccessChecker, null|`<a href="/docs/main/references/Serializer/TagCollectorInterface">ApiPlatform\Serializer\TagCollectorInterface $tagCollector)
    public supportsNormalization($data, null|string $format, array $context): bool
    public getSupportedTypes(null|string $format): array
    public hasCacheableSupportsMethod(): bool
    public normalize($object, null|string $format, array $context): ArrayObject|array|string|int|float|bool
    public supportsDenormalization($data, string $type, null|string $format, array $context): bool
    public denormalize($data, string $class, null|string $format, array $context)
    protected instantiateObject(array $data, string $class, array $context, ReflectionClass $reflectionClass, array|bool $allowedAttributes, null|string $format): object
    protected getClassDiscriminatorResolvedClass(array $data, string $class, array $context): string
    protected createConstructorArgument($parameterData, string $key, ReflectionParameter $constructorParameter, array $context, null|string $format)
    protected extractAttributes($object, $format, array $context): array&lt;int, string&gt;
    protected getAllowedAttributes(object|string $classOrObject, array $context, bool $attributesAsString): array|bool
    protected isAllowedAttribute(object|string $classOrObject, string $attribute, null|string $format, array $context): bool
    protected canAccessAttribute(null|object $object, string $attribute, array $context): bool
    protected canAccessAttributePostDenormalize(null|object $object, null|object $previousObject, string $attribute, array $context): bool
    protected setAttributeValue(object $object, string $attribute, $value, null|string $format, array $context): null
    protected validateType(string $attribute, Symfony\Component\PropertyInfo\Type $type, $value, null|string $format, array $context): null
    protected denormalizeCollection(string $attribute, ApiPlatform\Metadata\ApiProperty $propertyMetadata, Symfony\Component\PropertyInfo\Type $type, string $className, $value, null|string $format, array $context): array
    protected denormalizeRelation(string $attributeName, ApiPlatform\Metadata\ApiProperty $propertyMetadata, string $className, $value, null|string $format, array $context): object
    protected getFactoryOptions(array $context): array
    protected getAttributeValue(object $object, string $attribute, null|string $format, array $context)
    protected normalizeCollectionOfRelations(ApiPlatform\Metadata\ApiProperty $propertyMetadata, iterable $attributeValue, string $resourceClass, null|string $format, array $context): array
    protected normalizeRelation(ApiPlatform\Metadata\ApiProperty $propertyMetadata, null|object $relatedObject, string $resourceClass, null|string $format, array $context): ArrayObject|array|string
    protected getAttributes(object $object, null|string $format, array $context): array&lt;int, string&gt;
    protected denormalizeParameter(ReflectionClass $class, ReflectionParameter $parameter, string $parameterName, $parameterData, array $context, null|string $format)
    protected createChildContext(array $parentContext, string $attribute, null|string $format): array
    protected isCircularReference(object $object, array $context): bool
    protected handleCircularReference(object $object, null|string $format, array $context)
    protected getGroups(array $context): array
    protected prepareForDenormalization($data): array
    protected getConstructor(array $data, string $class, array $context, ReflectionClass $reflectionClass, array|bool $allowedAttributes): ReflectionMethod
    protected validateCallbackContext(array $context, string $contextType): null
    protected applyCallbacks($value, object|string $object, string $attribute, null|string $format, array $context)
    protected getAttributeNormalizationContext(object $object, string $attribute, array $context): array
    protected getAttributeDenormalizationContext(string $class, string $attribute, array $context): array
    protected getAttributeMetadata(object|string $objectOrClass, string $attribute): Symfony\Component\Serializer\Mapping\AttributeMetadataInterface
    protected extractObjectToPopulate(string $class, array $context, null|string $key): object
    public setSerializer(Symfony\Component\Serializer\SerializerInterface $serializer): null
    public clone($data)
    protected getInputClass(array $context): string
    protected getOutputClass(array $context): string
    protected createOperationContext(array $context, null|string $resourceClass): array
}

Properties

propertyAccessor

Symfony\Component\PropertyAccess\PropertyAccessorInterface $propertyAccessor

localCache

array $localCache

localFactoryOptionsCache

array $localFactoryOptionsCache

resourceAccessChecker

ApiPlatform\Metadata\ResourceAccessCheckerInterface $resourceAccessChecker

propertyNameCollectionFactory

ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory

propertyMetadataFactory

ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface $propertyMetadataFactory

iriConverter

|`<a href="/docs/main/references/Api/IriConverterInterface">ApiPlatform\Metadata\IriConverterInterface $iriConverter

resourceClassResolver

|`<a href="/docs/main/references/Api/ResourceClassResolverInterface">ApiPlatform\Metadata\ResourceClassResolverInterface $resourceClassResolver

tagCollector

ApiPlatform\Serializer\TagCollectorInterface $tagCollector

classDiscriminatorResolver

Symfony\Component\Serializer\Mapping\ClassDiscriminatorResolverInterface $classDiscriminatorResolver

defaultContext

array $defaultContext

classMetadataFactory

Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface $classMetadataFactory

nameConverter

Symfony\Component\Serializer\NameConverter\NameConverterInterface $nameConverter

serializer

Symfony\Component\Serializer\SerializerInterface $serializer

resourceMetadataCollectionFactory

ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory

Methods

__construct

public __construct($propertyNameCollectionFactory, `<a href="/docs/main/references/Metadata/Property/Factory/PropertyMetadataFactoryInterface">ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface</a>` $propertyMetadataFactory, `<a href="/docs/main/references/Api/IriConverterInterface">ApiPlatform\Api\IriConverterInterface</a>`|`<a href="/docs/main/references/Api/IriConverterInterface">ApiPlatform\Metadata\IriConverterInterface</a>` $iriConverter, `<a href="/docs/main/references/Api/ResourceClassResolverInterface">ApiPlatform\Api\ResourceClassResolverInterface</a>`|`<a href="/docs/main/references/Api/ResourceClassResolverInterface">ApiPlatform\Metadata\ResourceClassResolverInterface</a>` $resourceClassResolver, null|Symfony\Component\PropertyAccess\PropertyAccessorInterface $propertyAccessor, null|Symfony\Component\Serializer\NameConverter\NameConverterInterface $nameConverter, null|Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface $classMetadataFactory, array $defaultContext, null|`<a href="/docs/main/references/Metadata/Resource/Factory/ResourceMetadataCollectionFactoryInterface">ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface</a>` $resourceMetadataCollectionFactory, null|`<a href="/docs/main/references/Metadata/ResourceAccessCheckerInterface">ApiPlatform\Metadata\ResourceAccessCheckerInterface</a>` $resourceAccessChecker, null|`<a href="/docs/main/references/Serializer/TagCollectorInterface">ApiPlatform\Serializer\TagCollectorInterface $tagCollector)

Parameters

propertyNameCollectionFactory	`ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface`
propertyMetadataFactory	`ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface`
iriConverter	`ApiPlatform\Api\IriConverterInterface` `ApiPlatform\Metadata\IriConverterInterface`
resourceClassResolver	`ApiPlatform\Api\ResourceClassResolverInterface` `ApiPlatform\Metadata\ResourceClassResolverInterface`
propertyAccessor	Symfony\Component\PropertyAccess\PropertyAccessorInterface
nameConverter	Symfony\Component\Serializer\NameConverter\NameConverterInterface
classMetadataFactory	Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface
defaultContext	array
resourceMetadataCollectionFactory	`ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface`
resourceAccessChecker	`ApiPlatform\Metadata\ResourceAccessCheckerInterface`
tagCollector	`ApiPlatform\Serializer\TagCollectorInterface`

supportsNormalization

Checks whether the given class is supported for normalization by this normalizer.

public supportsNormalization($data, null|string $format, array $context): bool

Parameters

data
format	string
context	array

Returns

bool

getSupportedTypes

public getSupportedTypes(null|string $format): array

Parameters

format

string

Returns

array

hasCacheableSupportsMethod

public hasCacheableSupportsMethod(): bool

Returns

bool

normalize

Normalizes an object into a set of arrays/scalars.

public normalize($object, null|string $format, array $context): ArrayObject|array|string|int|float|bool

Parameters

object
format	string
context	array

Returns

ArrayObject
array
string
int
float
bool

supportsDenormalization

Checks whether the given class is supported for denormalization by this normalizer.

public supportsDenormalization($data, string $type, null|string $format, array $context): bool

Parameters

data
type	string
format	string
context	array

Returns

bool

denormalize

Denormalizes data back into an object of the given class.

public denormalize($data, string $class, null|string $format, array $context)

Parameters

data
class	string
format	string
context	array

Returns

instantiateObject

Method copy-pasted from symfony/serializer. Remove it after symfony/serializer version update @see https://github.com/symfony/symfony/pull/28263.

protected instantiateObject(array $data, string $class, array $context, ReflectionClass $reflectionClass, array|bool $allowedAttributes, null|string $format): object

Parameters

data	array
class	string
context	array
reflectionClass	ReflectionClass
allowedAttributes	array bool
format	string

Returns

object

getClassDiscriminatorResolvedClass

protected getClassDiscriminatorResolvedClass(array $data, string $class, array $context): string

Parameters

data	array
class	string
context	array

Returns

string

createConstructorArgument

protected createConstructorArgument($parameterData, string $key, ReflectionParameter $constructorParameter, array $context, null|string $format)

Parameters

parameterData
key	string
constructorParameter	ReflectionParameter
context	array
format	string

Returns

extractAttributes

Extracts attributes to normalize from the class of the given object, format and context.Unused in this context.

protected extractAttributes($object, $format, array $context): array&lt;int, string&gt;

Parameters

object
format
context	array

Returns

array<int, string>

getAllowedAttributes

Gets attributes to normalize using groups.

protected getAllowedAttributes(object|string $classOrObject, array $context, bool $attributesAsString): array|bool

Parameters

classOrObject	object string
context	array
attributesAsString	bool

Returns

array
bool

isAllowedAttribute

Is this attribute allowed?

protected isAllowedAttribute(object|string $classOrObject, string $attribute, null|string $format, array $context): bool

Parameters

classOrObject	object string
attribute	string
format	string
context	array

Returns

bool

canAccessAttribute

Check if access to the attribute is granted.

protected canAccessAttribute(null|object $object, string $attribute, array $context): bool

Parameters

object	object
attribute	string
context	array

Returns

bool

canAccessAttributePostDenormalize

Check if access to the attribute is granted.

protected canAccessAttributePostDenormalize(null|object $object, null|object $previousObject, string $attribute, array $context): bool

Parameters

object	object
previousObject	object
attribute	string
context	array

Returns

bool

setAttributeValue

protected setAttributeValue(object $object, string $attribute, $value, null|string $format, array $context): null

Parameters

object	object
attribute	string
value
format	string
context	array

Returns

null

validateType

Validates the type of the value. Allows using integers as floats for JSON formats.

protected validateType(string $attribute, Symfony\Component\PropertyInfo\Type $type, $value, null|string $format, array $context): null

Parameters

attribute	string
type	Symfony\Component\PropertyInfo\Type
value
format	string
context	array

Returns

null

denormalizeCollection

Denormalizes a collection of objects.

protected denormalizeCollection(string $attribute, ApiPlatform\Metadata\ApiProperty $propertyMetadata, Symfony\Component\PropertyInfo\Type $type, string $className, $value, null|string $format, array $context): array

Parameters

attribute	string
propertyMetadata	`ApiPlatform\Metadata\ApiProperty`
type	Symfony\Component\PropertyInfo\Type
className	string
value
format	string
context	array

Returns

array

denormalizeRelation

Denormalizes a relation.

protected denormalizeRelation(string $attributeName, ApiPlatform\Metadata\ApiProperty $propertyMetadata, string $className, $value, null|string $format, array $context): object

Parameters

attributeName	string
propertyMetadata	`ApiPlatform\Metadata\ApiProperty`
className	string
value
format	string
context	array

Returns

object

getFactoryOptions

Gets the options for the property name collection / property metadata factories.

protected getFactoryOptions(array $context): array

Parameters

context

array

Returns

array

getAttributeValue

Gets the attribute value.

protected getAttributeValue(object $object, string $attribute, null|string $format, array $context)

Parameters

object	object
attribute	string
format	string
context	array

Returns

normalizeCollectionOfRelations

Normalizes a collection of relations (to-many).

protected normalizeCollectionOfRelations(ApiPlatform\Metadata\ApiProperty $propertyMetadata, iterable $attributeValue, string $resourceClass, null|string $format, array $context): array

Parameters

propertyMetadata	`ApiPlatform\Metadata\ApiProperty`
attributeValue	iterable
resourceClass	string
format	string
context	array

Returns

array

normalizeRelation

Normalizes a relation.

protected normalizeRelation(ApiPlatform\Metadata\ApiProperty $propertyMetadata, null|object $relatedObject, string $resourceClass, null|string $format, array $context): ArrayObject|array|string

Parameters

propertyMetadata	`ApiPlatform\Metadata\ApiProperty`
relatedObject	object
resourceClass	string
format	string
context	array

Returns

ArrayObject
array
string

clone

public clone($data)

Parameters

data

Returns

getInputClass

protected getInputClass(array $context): string

Parameters

context

array

Returns

string

getOutputClass

protected getOutputClass(array $context): string

Parameters

context

array

Returns

string

createOperationContext

This context is created when working on a relation context or items of a collection. It cleans the previously given context as the operation changes.

protected createOperationContext(array $context, null|string $resourceClass): array

Parameters

context	array
resourceClass	string

Returns

array