References
ContextBuilderInterface
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
I
InterfaceApiPlatform\JsonLd\ContextBuilderInterface
JSON-LD context builder interface.
interface ApiPlatform\JsonLd\ContextBuilderInterface
{
public getBaseContext(int $referenceType): array
public getEntrypointContext(int $referenceType): array
public getResourceContext(string $resourceClass, int $referenceType): array
public getResourceContextUri(string $resourceClass, int $referenceType): string
}Methods
getBaseContext
Gets the base context.
public getBaseContext(int $referenceType): arrayParameters
| referenceType | int |
Returns
array
getEntrypointContext
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.
public getResourceContext(string $resourceClass, int $referenceType): arrayParameters
| resourceClass | string | |
| referenceType | int |
Returns
array
getResourceContextUri
Gets the URI of the given resource context.
public getResourceContextUri(string $resourceClass, int $referenceType): stringParameters
| resourceClass | string | |
| referenceType | int |
Returns
string
