ApiPlatform\Serializer\AbstractCollectionNormalizer

Base collection normalizer.

class ApiPlatform\Serializer\AbstractCollectionNormalizer implements Symfony\Component\Serializer\Normalizer\NormalizerInterface, Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface, Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface
{
    public __construct(ApiPlatform\Api\ResourceClassResolverInterface $resourceClassResolver, string $pageParameterName, null|ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory)
    public supportsNormalization($data, null|string $format, array $context): bool
    public hasCacheableSupportsMethod(): bool
    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)
}

class ApiPlatform\Serializer\AbstractCollectionNormalizer implements Symfony\Component\Serializer\Normalizer\NormalizerInterface, Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface, Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface
{
    public __construct(ApiPlatform\Api\ResourceClassResolverInterface $resourceClassResolver, string $pageParameterName, null|ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory)
    public supportsNormalization($data, null|string $format, array $context): bool
    public hasCacheableSupportsMethod(): bool
    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)
}

Properties

resourceClassResolver

ApiPlatform\Api\ResourceClassResolverInterface $resourceClassResolver

ApiPlatform\Api\ResourceClassResolverInterface $resourceClassResolver

pageParameterName

string $pageParameterName

string $pageParameterName

resourceMetadataFactory

ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory

ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory

normalizer

Symfony\Component\Serializer\Normalizer\NormalizerInterface $normalizer

Symfony\Component\Serializer\Normalizer\NormalizerInterface $normalizer

Methods

__construct

public __construct(ApiPlatform\Api\ResourceClassResolverInterface $resourceClassResolver, string $pageParameterName, null|ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory)

public __construct(ApiPlatform\Api\ResourceClassResolverInterface $resourceClassResolver, string $pageParameterName, null|ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory)

Parameters

resourceClassResolver	ApiPlatform\Api\ResourceClassResolverInterface
pageParameterName	string
resourceMetadataFactory	ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface

supportsNormalization

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

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

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

Parameters

data
format	string
context	array

Returns

bool

hasCacheableSupportsMethod

public hasCacheableSupportsMethod(): bool

public hasCacheableSupportsMethod(): bool

Returns

bool

normalize

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

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

Parameters

object	iterable
format	string
context	array

Returns

ArrayObject
array
string
int
float
bool

normalizeRawCollection

Normalizes a raw collection (not API resources).

protected normalizeRawCollection(iterable $object, null|string $format, array $context): ArrayObject|array

protected normalizeRawCollection(iterable $object, null|string $format, array $context): ArrayObject|array

Parameters

object	iterable
format	string
context	array

Returns

ArrayObject
array

getPaginationConfig

Gets the pagination configuration.

protected getPaginationConfig(iterable $object, array $context): array

protected getPaginationConfig(iterable $object, array $context): array

Parameters

object	iterable
context	array

Returns

array

getOperation

protected getOperation(array $context): ApiPlatform\Metadata\Operation

protected getOperation(array $context): ApiPlatform\Metadata\Operation

Parameters

context

array

Returns

ApiPlatform\Metadata\Operation

getPaginationData

Gets the pagination data.

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

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

Parameters

object	iterable
context	array

Returns

array

getItemsData

Gets items data.

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

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

Parameters

object	iterable
format	string
context	array

Returns

array

initContext

Initializes the context.

protected initContext(string $resourceClass, array $context): array

protected initContext(string $resourceClass, array $context): array

Parameters

resourceClass	string
context	array

Returns

array

setNormalizer

public setNormalizer(Symfony\Component\Serializer\Normalizer\NormalizerInterface $normalizer)

public setNormalizer(Symfony\Component\Serializer\Normalizer\NormalizerInterface $normalizer)

Parameters

normalizer

Symfony\Component\Serializer\Normalizer\NormalizerInterface