Guides
Tutorials
Normalizes collections in the HAL format.
class ApiPlatform\Hal\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\Api\ResourceClassResolverInterface $resourceClassResolver, string $pageParameterName, ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory)
protected getPaginationData(iterable $object, array $context): array
protected getItemsData(iterable $object, null|string $format, 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
protected initContext(string $resourceClass, array $context): array
public setNormalizer(Symfony\Component\Serializer\Normalizer\NormalizerInterface $normalizer)
}class ApiPlatform\Hal\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\Api\ResourceClassResolverInterface $resourceClassResolver, string $pageParameterName, ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory)
protected getPaginationData(iterable $object, array $context): array
protected getItemsData(iterable $object, null|string $format, 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
protected initContext(string $resourceClass, array $context): array
public setNormalizer(Symfony\Component\Serializer\Normalizer\NormalizerInterface $normalizer)
}ApiPlatform\Api\ResourceClassResolverInterface $resourceClassResolverApiPlatform\Api\ResourceClassResolverInterface $resourceClassResolverstring $pageParameterNamestring $pageParameterNameApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataFactoryApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataFactorySymfony\Component\Serializer\Normalizer\NormalizerInterface $normalizerSymfony\Component\Serializer\Normalizer\NormalizerInterface $normalizerpublic __construct(ApiPlatform\Api\ResourceClassResolverInterface $resourceClassResolver, string $pageParameterName, ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory)public __construct(ApiPlatform\Api\ResourceClassResolverInterface $resourceClassResolver, string $pageParameterName, ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory)| resourceClassResolver | ApiPlatform\Api\ResourceClassResolverInterface | |
| pageParameterName | string | |
| resourceMetadataFactory | ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface |
Gets the pagination data.
protected getPaginationData(iterable $object, array $context): arrayprotected getPaginationData(iterable $object, array $context): array| object | iterable | |
| context | array |
array
Gets items data.
protected getItemsData(iterable $object, null|string $format, array $context): arrayprotected getItemsData(iterable $object, null|string $format, array $context): array| object | iterable | |
| format | string | |
| context | array |
array