ApiPlatform\Api\UriVariablesConverter

UriVariables converter that chains uri variables transformers.

class ApiPlatform\Api\UriVariablesConverter implements ApiPlatform\Api\UriVariablesConverterInterface
{
    public __construct($propertyMetadataFactory, `<a href="/docs/main/references/Metadata/Resource/Factory/ResourceMetadataCollectionFactoryInterface">ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, iterable $uriVariableTransformers)
    public convert(array $uriVariables, string $class, array $context): array
}

Methods

__construct

public __construct($propertyMetadataFactory, `<a href="/docs/main/references/Metadata/Resource/Factory/ResourceMetadataCollectionFactoryInterface">ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, iterable $uriVariableTransformers)

Parameters

propertyMetadataFactory	`ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface`
resourceMetadataCollectionFactory	`ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface`
uriVariableTransformers	iterable

convert

Takes an array of strings representing URI variables (identifiers) and transform their values to the expected type.To handle the composite identifiers type correctly, use an uri_variables_map that maps uriVariables to their uriVariablesDefinition. Indeed, a composite identifier will already be parsed, and their corresponding properties will be the parameterName and not the defined identifiers.

public convert(array $uriVariables, string $class, array $context): array

Parameters

uriVariables	array
class	string
context	array

Returns

array