References
IriConverter
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\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/v3.1/references/Api/IdentifiersExtractorInterface">ApiPlatform\Api\IdentifiersExtractorInterface</a>` $identifiersExtractor, `<a href="/docs/v3.1/references/Api/ResourceClassResolverInterface">ApiPlatform\Api\ResourceClassResolverInterface</a>` $resourceClassResolver, `<a href="/docs/v3.1/references/Metadata/Resource/Factory/ResourceMetadataCollectionFactoryInterface">ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface</a>` $resourceMetadataCollectionFactory, null|`<a href="/docs/v3.1/references/Api/UriVariablesConverterInterface">ApiPlatform\Api\UriVariablesConverterInterface</a>` $uriVariablesConverter, null|`<a href="/docs/v3.1/references/Api/IriConverterInterface">ApiPlatform\Api\IriConverterInterface</a>` $decorated, null|`<a href="/docs/v3.1/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
public __construct($provider, Symfony\Component\Routing\RouterInterface $router, `<a href="/docs/v3.1/references/Api/IdentifiersExtractorInterface">ApiPlatform\Api\IdentifiersExtractorInterface</a>` $identifiersExtractor, `<a href="/docs/v3.1/references/Api/ResourceClassResolverInterface">ApiPlatform\Api\ResourceClassResolverInterface</a>` $resourceClassResolver, `<a href="/docs/v3.1/references/Metadata/Resource/Factory/ResourceMetadataCollectionFactoryInterface">ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface</a>` $resourceMetadataCollectionFactory, null|`<a href="/docs/v3.1/references/Api/UriVariablesConverterInterface">ApiPlatform\Api\UriVariablesConverterInterface</a>` $uriVariablesConverter, null|`<a href="/docs/v3.1/references/Api/IriConverterInterface">ApiPlatform\Api\IriConverterInterface</a>` $decorated, null|`<a href="/docs/v3.1/references/Metadata/Operation/Factory/OperationMetadataFactoryInterface">ApiPlatform\Metadata\Operation\Factory\OperationMetadataFactoryInterface $operationMetadataFactory)Parameters
| provider | `ApiPlatform\State\ProviderInterface` | |
| router | Symfony\Component\Routing\RouterInterface | |
| identifiersExtractor | `ApiPlatform\Api\IdentifiersExtractorInterface` | |
| resourceClassResolver | `ApiPlatform\Api\ResourceClassResolverInterface` | |
| resourceMetadataCollectionFactory | `ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface` | |
| uriVariablesConverter | `ApiPlatform\Api\UriVariablesConverterInterface` | |
| decorated | `ApiPlatform\Api\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): objectParameters
| 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): stringParameters
| resource | object string | |
| referenceType | int | |
| operation | `ApiPlatform\Metadata\Operation` | |
| context | array |
Returns
string
