Reference
C
Class

ApiPlatform\Symfony\Routing\IriConverter

Converts item and resources to IRI and vice versa.

class ApiPlatform\Symfony\Routing\IriConverter implements `<a href="/docs/reference/Api/IriConverterInterface">ApiPlatform\Api\IriConverterInterface</a>`
{
    public __construct(ApiPlatform\State\ProviderInterface $provider, Symfony\Component\Routing\RouterInterface $router, ApiPlatform\Api\IdentifiersExtractorInterface $identifiersExtractor, ApiPlatform\Api\ResourceClassResolverInterface $resourceClassResolver, ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, null|ApiPlatform\Api\UriVariablesConverterInterface $uriVariablesConverter, null|ApiPlatform\Api\IriConverterInterface $decorated, null|ApiPlatform\Metadata\Operation\Factory\OperationMetadataFactoryInterface $operationMetadataFactory)
    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
}
class ApiPlatform\Symfony\Routing\IriConverter implements `<a href="/docs/reference/Api/IriConverterInterface">ApiPlatform\Api\IriConverterInterface</a>`
{
    public __construct(ApiPlatform\State\ProviderInterface $provider, Symfony\Component\Routing\RouterInterface $router, ApiPlatform\Api\IdentifiersExtractorInterface $identifiersExtractor, ApiPlatform\Api\ResourceClassResolverInterface $resourceClassResolver, ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, null|ApiPlatform\Api\UriVariablesConverterInterface $uriVariablesConverter, null|ApiPlatform\Api\IriConverterInterface $decorated, null|ApiPlatform\Metadata\Operation\Factory\OperationMetadataFactoryInterface $operationMetadataFactory)
    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

__construct

public __construct(ApiPlatform\State\ProviderInterface $provider, Symfony\Component\Routing\RouterInterface $router, ApiPlatform\Api\IdentifiersExtractorInterface $identifiersExtractor, ApiPlatform\Api\ResourceClassResolverInterface $resourceClassResolver, ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, null|ApiPlatform\Api\UriVariablesConverterInterface $uriVariablesConverter, null|ApiPlatform\Api\IriConverterInterface $decorated, null|ApiPlatform\Metadata\Operation\Factory\OperationMetadataFactoryInterface $operationMetadataFactory)
public __construct(ApiPlatform\State\ProviderInterface $provider, Symfony\Component\Routing\RouterInterface $router, ApiPlatform\Api\IdentifiersExtractorInterface $identifiersExtractor, ApiPlatform\Api\ResourceClassResolverInterface $resourceClassResolver, ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, null|ApiPlatform\Api\UriVariablesConverterInterface $uriVariablesConverter, null|ApiPlatform\Api\IriConverterInterface $decorated, null|ApiPlatform\Metadata\Operation\Factory\OperationMetadataFactoryInterface $operationMetadataFactory)

Parameters

providerApiPlatform\State\ProviderInterface
routerSymfony\Component\Routing\RouterInterface
identifiersExtractorApiPlatform\Api\IdentifiersExtractorInterface
resourceClassResolverApiPlatform\Api\ResourceClassResolverInterface
resourceMetadataCollectionFactoryApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface
uriVariablesConverterApiPlatform\Api\UriVariablesConverterInterface
decoratedApiPlatform\Api\IriConverterInterface
operationMetadataFactoryApiPlatform\Metadata\Operation\Factory\OperationMetadataFactoryInterface

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

iristring
contextarray
operationApiPlatform\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

resourceobject
string
referenceTypeint
operationApiPlatform\Metadata\Operation
contextarray

Returns

string

Copyright © 2023 Kévin Dunglas

Sponsored by Les-Tilleuls.coop