Creates a machine readable Hydra API documentation.
class ApiPlatform\Hydra\Serializer\DocumentationNormalizer implements Symfony\Component\Serializer\Normalizer\NormalizerInterface, ApiPlatform\Serializer\CacheableSupportsMethodInterface
{
public __construct($resourceMetadataFactory, `<a href="/docs/main/references/Metadata/Property/Factory/PropertyNameCollectionFactoryInterface">ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface</a>` $propertyNameCollectionFactory, `<a href="/docs/main/references/Metadata/Property/Factory/PropertyMetadataFactoryInterface">ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface</a>` $propertyMetadataFactory, `<a href="/docs/main/references/Api/ResourceClassResolverInterface">ApiPlatform\Metadata\ResourceClassResolverInterface</a>`|`<a href="/docs/main/references/Api/ResourceClassResolverInterface">ApiPlatform\Api\ResourceClassResolverInterface</a>` $resourceClassResolver, `<a href="/docs/main/references/Api/UrlGeneratorInterface">ApiPlatform\Metadata\UrlGeneratorInterface</a>`|`<a href="/docs/main/references/Api/UrlGeneratorInterface">ApiPlatform\Api\UrlGeneratorInterface $urlGenerator, null|Symfony\Component\Serializer\NameConverter\NameConverterInterface $nameConverter)
public normalize($object, null|string $format, array $context): ArrayObject|array|string|int|float|bool
public supportsNormalization($data, null|string $format, array $context): bool
public getSupportedTypes($format): array
public hasCacheableSupportsMethod(): bool
}
public __construct($resourceMetadataFactory, `<a href="/docs/main/references/Metadata/Property/Factory/PropertyNameCollectionFactoryInterface">ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface</a>` $propertyNameCollectionFactory, `<a href="/docs/main/references/Metadata/Property/Factory/PropertyMetadataFactoryInterface">ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface</a>` $propertyMetadataFactory, `<a href="/docs/main/references/Api/ResourceClassResolverInterface">ApiPlatform\Metadata\ResourceClassResolverInterface</a>`|`<a href="/docs/main/references/Api/ResourceClassResolverInterface">ApiPlatform\Api\ResourceClassResolverInterface</a>` $resourceClassResolver, `<a href="/docs/main/references/Api/UrlGeneratorInterface">ApiPlatform\Metadata\UrlGeneratorInterface</a>`|`<a href="/docs/main/references/Api/UrlGeneratorInterface">ApiPlatform\Api\UrlGeneratorInterface $urlGenerator, null|Symfony\Component\Serializer\NameConverter\NameConverterInterface $nameConverter)
resourceMetadataFactory | `ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface` | |
propertyNameCollectionFactory | `ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface` | |
propertyMetadataFactory | `ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface` | |
resourceClassResolver | `ApiPlatform\Metadata\ResourceClassResolverInterface` `ApiPlatform\Api\ResourceClassResolverInterface` | |
urlGenerator | `ApiPlatform\Metadata\UrlGeneratorInterface` `ApiPlatform\Api\UrlGeneratorInterface` | |
nameConverter | Symfony\Component\Serializer\NameConverter\NameConverterInterface |
Normalizes an object into a set of arrays/scalars.
public normalize($object, null|string $format, array $context): ArrayObject|array|string|int|float|bool
object | ||
format | string | |
context | array |
ArrayObject
array
string
int
float
bool
Checks whether the given class is supported for normalization by this normalizer.
public supportsNormalization($data, null|string $format, array $context): bool
data | ||
format | string | |
context | array |
bool
public getSupportedTypes($format): array
format |
array
public hasCacheableSupportsMethod(): bool
bool
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