References
ContextBuilder
September 19-20, 2024 | Lille & online
The international conference on the API Platform Framework
API Platform Conference 2024: meet the best PHP, JavaScript and API experts
Learn more about the event, register for the conference, and get ready for two days of inspiration, ideas, and knowledge-sharing with our incredible lineup of renowned specialists and advocates.
Register nowReference
C
ClassApiPlatform\JsonLd\ContextBuilder
JSON-LD context builder with Input Output DTO support interface.
class ApiPlatform\JsonLd\ContextBuilder implements , `<a href="/docs/references/JsonLd/ContextBuilderInterface">ApiPlatform\JsonLd\ContextBuilderInterface
{
public __construct($resourceNameCollectionFactory, `<a href="/docs/references/Metadata/Resource/Factory/ResourceMetadataCollectionFactoryInterface">ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface</a>` $resourceMetadataFactory, `<a href="/docs/references/Metadata/Property/Factory/PropertyNameCollectionFactoryInterface">ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface</a>` $propertyNameCollectionFactory, `<a href="/docs/references/Metadata/Property/Factory/PropertyMetadataFactoryInterface">ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface</a>` $propertyMetadataFactory, `<a href="/docs/references/Api/UrlGeneratorInterface">ApiPlatform\Metadata\UrlGeneratorInterface</a>` $urlGenerator, null|`<a href="/docs/references/Api/IriConverterInterface">ApiPlatform\Metadata\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
}Methods
__construct
public __construct($resourceNameCollectionFactory, `<a href="/docs/references/Metadata/Resource/Factory/ResourceMetadataCollectionFactoryInterface">ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface</a>` $resourceMetadataFactory, `<a href="/docs/references/Metadata/Property/Factory/PropertyNameCollectionFactoryInterface">ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface</a>` $propertyNameCollectionFactory, `<a href="/docs/references/Metadata/Property/Factory/PropertyMetadataFactoryInterface">ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface</a>` $propertyMetadataFactory, `<a href="/docs/references/Api/UrlGeneratorInterface">ApiPlatform\Metadata\UrlGeneratorInterface</a>` $urlGenerator, null|`<a href="/docs/references/Api/IriConverterInterface">ApiPlatform\Metadata\IriConverterInterface $iriConverter, null|Symfony\Component\Serializer\NameConverter\NameConverterInterface $nameConverter)Parameters
| 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\Metadata\UrlGeneratorInterface` | |
| iriConverter | `ApiPlatform\Metadata\IriConverterInterface` | |
| nameConverter | Symfony\Component\Serializer\NameConverter\NameConverterInterface |
getBaseContext
Gets the base context.Gets the base context.
public getBaseContext(int $referenceType): arrayParameters
| referenceType | int |
Returns
array
getEntrypointContext
Builds the JSON-LD context for the entrypoint.Builds the JSON-LD context for the entrypoint.
public getEntrypointContext(int $referenceType): arrayParameters
| referenceType | int |
Returns
array
getResourceContext
Builds the JSON-LD context for the given resource.Builds the JSON-LD context for the given resource.
public getResourceContext(string $resourceClass, int $referenceType): arrayParameters
| resourceClass | string | |
| referenceType | int |
Returns
array
getResourceContextUri
Gets the URI of the given resource context.Gets the URI of the given resource context.
public getResourceContextUri(string $resourceClass, null|int $referenceType): stringParameters
| resourceClass | string | |
| referenceType | int |
Returns
string
getAnonymousResourceContext
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): arrayParameters
| object | object | |
| context | array | |
| referenceType | int |
Returns
array
