ApiPlatform\Hydra\Serializer\CollectionNormalizer

This normalizer handles collections.

class ApiPlatform\Hydra\Serializer\CollectionNormalizer extends ApiPlatform\Serializer\AbstractCollectionNormalizer implements Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface, Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface, Symfony\Component\Serializer\Normalizer\NormalizerInterface
{
    public __construct(ApiPlatform\JsonLd\ContextBuilderInterface $contextBuilder, ApiPlatform\Api\ResourceClassResolverInterface $resourceClassResolver, ApiPlatform\Api\IriConverterInterface $iriConverter, null|ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, array $defaultContext)
    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 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
    public setNormalizer(Symfony\Component\Serializer\Normalizer\NormalizerInterface $normalizer)
}

class ApiPlatform\Hydra\Serializer\CollectionNormalizer extends ApiPlatform\Serializer\AbstractCollectionNormalizer implements Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface, Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface, Symfony\Component\Serializer\Normalizer\NormalizerInterface
{
    public __construct(ApiPlatform\JsonLd\ContextBuilderInterface $contextBuilder, ApiPlatform\Api\ResourceClassResolverInterface $resourceClassResolver, ApiPlatform\Api\IriConverterInterface $iriConverter, null|ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, array $defaultContext)
    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 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
    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\JsonLd\ContextBuilderInterface $contextBuilder, ApiPlatform\Api\ResourceClassResolverInterface $resourceClassResolver, ApiPlatform\Api\IriConverterInterface $iriConverter, null|ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, array $defaultContext)

public __construct(ApiPlatform\JsonLd\ContextBuilderInterface $contextBuilder, ApiPlatform\Api\ResourceClassResolverInterface $resourceClassResolver, ApiPlatform\Api\IriConverterInterface $iriConverter, null|ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, array $defaultContext)

Parameters

contextBuilder	ApiPlatform\JsonLd\ContextBuilderInterface
resourceClassResolver	ApiPlatform\Api\ResourceClassResolverInterface
iriConverter	ApiPlatform\Api\IriConverterInterface
resourceMetadataCollectionFactory	ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface
defaultContext	array

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

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

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

Parameters

resourceClass	string
context	array

Returns

array