References IriConverter
Reference
C
Class

ApiPlatform\Symfony\Routing\IriConverter

Converts item and resources to IRI and vice versa.

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

Parameters

provider`ApiPlatform\State\ProviderInterface`
routerSymfony\Component\Routing\RouterInterface
identifiersExtractor`ApiPlatform\Metadata\IdentifiersExtractorInterface`
`ApiPlatform\Api\IdentifiersExtractorInterface`
resourceClassResolver`ApiPlatform\Metadata\ResourceClassResolverInterface`
`ApiPlatform\Api\ResourceClassResolverInterface`
resourceMetadataCollectionFactory`ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface`
uriVariablesConverter`ApiPlatform\Metadata\UriVariablesConverterInterface`
`ApiPlatform\Api\UriVariablesConverterInterface`
decorated`ApiPlatform\Metadata\IriConverterInterface`
operationMetadataFactory`ApiPlatform\Metadata\Operation\Factory\OperationMetadataFactoryInterface`

getResourceFromIri

Retrieves an item from its IRI.

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

Parameters

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

Parameters

resourceobject
string
referenceTypeint
operation`ApiPlatform\Metadata\Operation`
contextarray

Returns

string

Made with love by

Les-Tilleuls.coop can help you design and develop your APIs and web projects, and train your teams in API Platform, Symfony, Next.js, Kubernetes and a wide range of other technologies.

Learn more

Copyright © 2023 Kévin Dunglas

Sponsored by Les-Tilleuls.coop