References CollectionNormalizer
Reference
C
Class

ApiPlatform\JsonApi\Serializer\CollectionNormalizer

Normalizes collections in the JSON API format.

class ApiPlatform\JsonApi\Serializer\CollectionNormalizer extends implements `<a href="/docs/main/references/Serializer/CacheableSupportsMethodInterface">ApiPlatform\Serializer\CacheableSupportsMethodInterface, Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface, Symfony\Component\Serializer\Normalizer\NormalizerInterface
{
    public __construct(|`<a href="/docs/main/references/Api/ResourceClassResolverInterface">ApiPlatform\Api\ResourceClassResolverInterface</a>` $resourceClassResolver, string $pageParameterName, `<a href="/docs/main/references/Metadata/Resource/Factory/ResourceMetadataCollectionFactoryInterface">ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory)
    protected getPaginationData($object, array $context): array
    protected getItemsData($object, null|string $format, array $context): array
    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 initContext(string $resourceClass, array $context): array
    public setNormalizer(Symfony\Component\Serializer\Normalizer\NormalizerInterface $normalizer): null
    protected createOperationContext(array $context, null|string $resourceClass): array
}

Properties

resourceClassResolver

pageParameterName

string $pageParameterName

resourceMetadataFactory

normalizer

Symfony\Component\Serializer\Normalizer\NormalizerInterface $normalizer

Methods

__construct

Parameters

resourceClassResolver`ApiPlatform\Metadata\ResourceClassResolverInterface`
`ApiPlatform\Api\ResourceClassResolverInterface`
pageParameterNamestring
resourceMetadataFactory`ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface`

getPaginationData

Gets the pagination data.

protected getPaginationData($object, array $context): array

Parameters

object
contextarray

Returns

array

getItemsData

Gets items data.

protected getItemsData($object, null|string $format, array $context): array

Parameters

object
formatstring
contextarray

Returns

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

Copyright © 2023 Kévin Dunglas

Sponsored by Les-Tilleuls.coop