References CollectionFiltersNormalizer
Reference
C
Class

ApiPlatform\Hydra\Serializer\CollectionFiltersNormalizer

Enhances the result of collection by adding the filters applied on collection.

class ApiPlatform\Hydra\Serializer\CollectionFiltersNormalizer implements Symfony\Component\Serializer\Normalizer\NormalizerInterface, Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface, ApiPlatform\Serializer\CacheableSupportsMethodInterface
{
    public __construct(Symfony\Component\Serializer\Normalizer\NormalizerInterface $collectionNormalizer, $resourceMetadataCollectionFactory, `<a href="/docs/main/references/Api/ResourceClassResolverInterface">ApiPlatform\Api\ResourceClassResolverInterface</a>`|`<a href="/docs/main/references/Api/ResourceClassResolverInterface">ApiPlatform\Metadata\ResourceClassResolverInterface $resourceClassResolver, Psr\Container\ContainerInterface $filterLocator)
    public supportsNormalization($data, null|string $format, array $context): bool
    public getSupportedTypes($format): array
    public hasCacheableSupportsMethod(): bool
    public normalize($object, null|string $format, array $context): ArrayObject|array|string|int|float|bool
    public setNormalizer(Symfony\Component\Serializer\Normalizer\NormalizerInterface $normalizer): null
}

Methods

__construct

Parameters

collectionNormalizerSymfony\Component\Serializer\Normalizer\NormalizerInterface
resourceMetadataCollectionFactory`ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface`
resourceClassResolver`ApiPlatform\Api\ResourceClassResolverInterface`
`ApiPlatform\Metadata\ResourceClassResolverInterface`
filterLocatorPsr\Container\ContainerInterfaceThe new filter locator or the deprecated filter collection

supportsNormalization

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

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

Parameters

data
formatstring
contextarray

Returns

bool

getSupportedTypes

public getSupportedTypes($format): array

Parameters

format

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
formatstring
contextarray

Returns

ArrayObject
array
string
int
float
bool

setNormalizer

Sets the owning Normalizer object.

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

Parameters

normalizerSymfony\Component\Serializer\Normalizer\NormalizerInterface

Returns

null

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