Class LaravelUi5\Core\Attributes\Parameter

Declarative runtime parameter definition for Parameterizable classes.

Apply this attribute multiple times on a class (Ui5Action, Resource/Data provider, Report provider) to describe each expected request parameter. A central ParameterResolver will:

read all #[Parameter(...)] attributes,
extract raw values from the request (path/query/body),
cast them according to ParameterType,
resolve Eloquent models when type=Model,
enforce required/nullable/default semantics,
and return an immutable, normalized argument bag.

Key distinction: name vs. uriKey

name = logical backend name Used as array key in the resolved argument bag and as identifier in the application code (controller, handler, service).
uriKey = external transport key The concrete identifier used on the communication layer (path segment or query string key). This is what the client sends, and what is reflected into the manifest.

This separation allows:

Stable API contracts even if backend internals are refactored.
Aliasing: uriKey may differ from name (e.g. legacy URL key mapped to a cleaner internal parameter name).
Explicit, enterprise-grade clarity in manifests and generated clients.

Path resolution

If you use a catch-all {uri} route, uriKey specifies the segment name.
The order of #[Parameter(...)] attributes in the source code defines the positional order of path parameters.

Example #[Parameter( name: 'projectModel', uriKey: 'project', type: ValueType::Model, source: ParameterSource::Path, model: Project::class ), Parameter( name: 'withPositions', uriKey: 'withPositions', type: ValueType::Bool, source: ParameterSource::Query, required: false, default: false ) ]

Located at Attributes/Parameter.php

Methods


					
	public

__construct(
	string $name,
	string $uriKey,
	ValueType $type,
	ParameterSource $source = ParameterSource::Path,
	bool $required = true,
	bool $nullable = false,
	mixed $default = null,
	class-string|null $model = null,
)

Parameters

`$name`	Logical parameter name (used as array key in the resolved args)
`$uriKey`	External transport key (path segment or query key, as seen by the client)
`$type`	Declared runtime type (drives casting/model binding)
`$source`	Where to read from: Path, Query, Body
`$required`	If true and no value is provided (after source lookup), the resolver fails (400)
`$nullable`	Allow explicit null (distinct from “missing”); if true and null provided, no cast is applied
`$default`	Default used when value is missing and not required
`$model`	Eloquent model FQCN; required when $type = ValueType::Model

Properties
`public`	`string`	`$name` Logical parameter name (used as array key in the resolved args) Logical parameter name (used as array key in the resolved args)	#
`public`	`string`	`$uriKey` External transport key (path segment or query key, as seen by the client) External transport key (path segment or query key, as seen by the client)	#
`public`	`ValueType`	`$type` Declared runtime type (drives casting/model binding) Declared runtime type (drives casting/model binding)	#
`public`	`ParameterSource`	`$source` Where to read from: Path, Query, Body Where to read from: Path, Query, Body	#
`public`	`bool`	`$required` If true and no value is provided (after source lookup), the resolver fails (400) If true and no value is provided (after source lookup), the resolver fails (400)	#
`public`	`bool`	`$nullable` Allow explicit null (distinct from “missing”); if true and null provided, no cast is applied Allow explicit null (distinct from “missing”); if true and null provided, no cast is applied	#
`public`	`mixed`	`$default` Default used when value is missing and not required Default used when value is missing and not required	#
`public`	`class-string\|null`	`$model` Eloquent model FQCN; required when $type = ValueType::Model Eloquent model FQCN; required when $type = ValueType::Model	#

Namespaces

Classes

Class LaravelUi5\Core\Attributes\Parameter

Parameters