ApiPlatform\Api\IriConverterInterface

Converts item and resources to IRI and vice versa.

interface ApiPlatform\Api\IriConverterInterface
{
    public getResourceFromIri(string $iri, array $context, null|ApiPlatform\Metadata\Operation $operation): object
    public getIriFromResource(object|string $resource, int $referenceType, null|ApiPlatform\Metadata\Operation $operation, array $context): string
}

interface ApiPlatform\Api\IriConverterInterface
{
    public getResourceFromIri(string $iri, array $context, null|ApiPlatform\Metadata\Operation $operation): object
    public getIriFromResource(object|string $resource, int $referenceType, null|ApiPlatform\Metadata\Operation $operation, array $context): string
}

Methods

getResourceFromIri

Retrieves an item from its IRI.

public getResourceFromIri(string $iri, array $context, null|ApiPlatform\Metadata\Operation $operation): object

public getResourceFromIri(string $iri, array $context, null|ApiPlatform\Metadata\Operation $operation): object

Parameters

iri	string
context	array
operation	ApiPlatform\Metadata\Operation

Returns

object

getIriFromResource

Gets the IRI associated with the given item.

public getIriFromResource(object|string $resource, int $referenceType, null|ApiPlatform\Metadata\Operation $operation, array $context): string

public getIriFromResource(object|string $resource, int $referenceType, null|ApiPlatform\Metadata\Operation $operation, array $context): string

Parameters

resource	object string
referenceType	int
operation	ApiPlatform\Metadata\Operation
context	array

Returns

string