Guides
Tutorials
JSON-LD context builder with Input Output DTO support interface.
class ApiPlatform\JsonLd\ContextBuilder implements `<a href="/docs/reference/JsonLd/AnonymousContextBuilderInterface">ApiPlatform\JsonLd\AnonymousContextBuilderInterface</a>`, `<a href="/docs/reference/JsonLd/ContextBuilderInterface">ApiPlatform\JsonLd\ContextBuilderInterface</a>`
{
public __construct(ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory, ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface $propertyMetadataFactory, ApiPlatform\Api\UrlGeneratorInterface $urlGenerator, null|ApiPlatform\Api\IriConverterInterface $iriConverter, null|Symfony\Component\Serializer\NameConverter\NameConverterInterface $nameConverter)
public getBaseContext(int $referenceType): array
public getEntrypointContext(int $referenceType): array
public getResourceContext(string $resourceClass, int $referenceType): array
public getResourceContextUri(string $resourceClass, null|int $referenceType): string
public getAnonymousResourceContext(object $object, array $context, int $referenceType): array
}class ApiPlatform\JsonLd\ContextBuilder implements `<a href="/docs/reference/JsonLd/AnonymousContextBuilderInterface">ApiPlatform\JsonLd\AnonymousContextBuilderInterface</a>`, `<a href="/docs/reference/JsonLd/ContextBuilderInterface">ApiPlatform\JsonLd\ContextBuilderInterface</a>`
{
public __construct(ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory, ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface $propertyMetadataFactory, ApiPlatform\Api\UrlGeneratorInterface $urlGenerator, null|ApiPlatform\Api\IriConverterInterface $iriConverter, null|Symfony\Component\Serializer\NameConverter\NameConverterInterface $nameConverter)
public getBaseContext(int $referenceType): array
public getEntrypointContext(int $referenceType): array
public getResourceContext(string $resourceClass, int $referenceType): array
public getResourceContextUri(string $resourceClass, null|int $referenceType): string
public getAnonymousResourceContext(object $object, array $context, int $referenceType): array
}public __construct(ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory, ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface $propertyMetadataFactory, ApiPlatform\Api\UrlGeneratorInterface $urlGenerator, null|ApiPlatform\Api\IriConverterInterface $iriConverter, null|Symfony\Component\Serializer\NameConverter\NameConverterInterface $nameConverter)public __construct(ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory, ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface $propertyMetadataFactory, ApiPlatform\Api\UrlGeneratorInterface $urlGenerator, null|ApiPlatform\Api\IriConverterInterface $iriConverter, null|Symfony\Component\Serializer\NameConverter\NameConverterInterface $nameConverter)| resourceNameCollectionFactory | ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface | |
| resourceMetadataFactory | ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface | |
| propertyNameCollectionFactory | ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface | |
| propertyMetadataFactory | ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface | |
| urlGenerator | ApiPlatform\Api\UrlGeneratorInterface | |
| iriConverter | ApiPlatform\Api\IriConverterInterface | |
| nameConverter | Symfony\Component\Serializer\NameConverter\NameConverterInterface |
Gets the base context.Gets the base context.
public getBaseContext(int $referenceType): arraypublic getBaseContext(int $referenceType): array| referenceType | int |
array
Builds the JSON-LD context for the entrypoint.Builds the JSON-LD context for the entrypoint.
public getEntrypointContext(int $referenceType): arraypublic getEntrypointContext(int $referenceType): array| referenceType | int |
array
Builds the JSON-LD context for the given resource.Builds the JSON-LD context for the given resource.
public getResourceContext(string $resourceClass, int $referenceType): arraypublic getResourceContext(string $resourceClass, int $referenceType): array| resourceClass | string | |
| referenceType | int |
array
Gets the URI of the given resource context.Gets the URI of the given resource context.
public getResourceContextUri(string $resourceClass, null|int $referenceType): stringpublic getResourceContextUri(string $resourceClass, null|int $referenceType): string| resourceClass | string | |
| referenceType | int |
string
Creates a JSON-LD context based on the given object. Usually this is used with an Input or Output DTO object.
public getAnonymousResourceContext(object $object, array $context, int $referenceType): arraypublic getAnonymousResourceContext(object $object, array $context, int $referenceType): array| object | object | |
| context | array | |
| referenceType | int |
array
