Base collection normalizer.
class ApiPlatform\Serializer\AbstractCollectionNormalizer implements Symfony\Component\Serializer\Normalizer\NormalizerInterface, Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface, ApiPlatform\Serializer\CacheableSupportsMethodInterface
{
public __construct(|`<a href="/docs/main/references/Api/ResourceClassResolverInterface">ApiPlatform\Api\ResourceClassResolverInterface</a>` $resourceClassResolver, string $pageParameterName, null|`<a href="/docs/main/references/Metadata/Resource/Factory/ResourceMetadataCollectionFactoryInterface">ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory)
public supportsNormalization($data, null|string $format, array $context): bool
public hasCacheableSupportsMethod(): bool
public getSupportedTypes(null|string $format): array
public normalize(null|iterable $object, null|string $format, array $context): ArrayObject|array|string|int|float|bool
protected normalizeRawCollection(iterable $object, null|string $format, array $context): ArrayObject|array
protected getPaginationConfig(iterable $object, array $context): array
protected getOperation(array $context): ApiPlatform\Metadata\Operation
protected getPaginationData(iterable $object, array $context): array
protected getItemsData(iterable $object, null|string $format, array $context): array
protected initContext(string $resourceClass, array $context): array
public setNormalizer(Symfony\Component\Serializer\Normalizer\NormalizerInterface $normalizer): null
protected createOperationContext(array $context, null|string $resourceClass): array
}|`<a href="/docs/main/references/Api/ResourceClassResolverInterface">ApiPlatform\Api\ResourceClassResolverInterface $resourceClassResolverstring $pageParameterNameApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataFactorySymfony\Component\Serializer\Normalizer\NormalizerInterface $normalizerpublic __construct(|`<a href="/docs/main/references/Api/ResourceClassResolverInterface">ApiPlatform\Api\ResourceClassResolverInterface</a>` $resourceClassResolver, string $pageParameterName, null|`<a href="/docs/main/references/Metadata/Resource/Factory/ResourceMetadataCollectionFactoryInterface">ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory)| resourceClassResolver | `ApiPlatform\Metadata\ResourceClassResolverInterface` `ApiPlatform\Api\ResourceClassResolverInterface` | |
| pageParameterName | string | |
| resourceMetadataFactory | `ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface` |
Checks whether the given class is supported for normalization by this normalizer.
public supportsNormalization($data, null|string $format, array $context): bool| data | ||
| format | string | |
| context | array |
bool
public hasCacheableSupportsMethod(): boolbool
public getSupportedTypes(null|string $format): array| format | string |
array
Normalizes an object into a set of arrays/scalars.
public normalize(null|iterable $object, null|string $format, array $context): ArrayObject|array|string|int|float|bool| object | iterable | |
| format | string | |
| context | array |
ArrayObject
array
string
int
float
bool
Normalizes a raw collection (not API resources).
protected normalizeRawCollection(iterable $object, null|string $format, array $context): ArrayObject|array| object | iterable | |
| format | string | |
| context | array |
ArrayObject
array
Gets the pagination configuration.
protected getPaginationConfig(iterable $object, array $context): array| object | iterable | |
| context | array |
array
protected getOperation(array $context): ApiPlatform\Metadata\Operation| context | array |
<a href="/docs/main/references/Metadata/Operation">ApiPlatform\Metadata\Operation</a>
Gets the pagination data.
protected getPaginationData(iterable $object, array $context): array| object | iterable | |
| context | array |
array
Gets items data.
protected getItemsData(iterable $object, null|string $format, array $context): array| object | iterable | |
| format | string | |
| context | array |
array
Initializes the context.
protected initContext(string $resourceClass, array $context): array| resourceClass | string | |
| context | array |
array
public setNormalizer(Symfony\Component\Serializer\Normalizer\NormalizerInterface $normalizer): null| normalizer | Symfony\Component\Serializer\Normalizer\NormalizerInterface |
null
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| context | array | |
| resourceClass | string |
array
Made with love by
Les-Tilleuls.coop can help you design and develop your APIs and web projects, and train your teams in API Platform, Symfony, Next.js, Kubernetes and a wide range of other technologies.
Learn more