class ResourceTypeConverter implements ParamConverterInterface (View source)

internal  JSON:API maintains no PHP API since its API is the HTTP API. This class may change at any time and this will break any dependencies on it.
 

Parameter converter for upcasting JSON:API resource type names to objects.

Constants

PARAM_TYPE_ID

The route parameter type to match.

Properties

protected ResourceTypeRepositoryInterface $resourceTypeRepository

The JSON:API resource type repository.

Methods

__construct(ResourceTypeRepositoryInterface $resource_type_repository)

ResourceTypeConverter constructor.

mixed|null
convert(mixed $value, mixed $definition, string $name, array $defaults)

Converts path variables to their corresponding objects.

bool
applies(mixed $definition, string $name, Route $route)

Determines if the converter applies to a specific route and variable.

Details

__construct(ResourceTypeRepositoryInterface $resource_type_repository)

ResourceTypeConverter constructor.

Parameters

ResourceTypeRepositoryInterface $resource_type_repository

The JSON:API resource type repository.

mixed|null convert(mixed $value, mixed $definition, string $name, array $defaults)

Converts path variables to their corresponding objects.

Parameters

mixed $value

The raw value.

mixed $definition

The parameter definition provided in the route options.

string $name

The name of the parameter.

array $defaults

The route defaults array.

Return Value

mixed|null

The converted parameter value.

bool applies(mixed $definition, string $name, Route $route)

Determines if the converter applies to a specific route and variable.

Parameters

mixed $definition

The parameter definition provided in the route options.

string $name

The name of the parameter.

Route $route

The route to consider attaching to.

Return Value

bool

TRUE if the converter applies to the passed route and parameter, FALSE otherwise.