Interface LaravelUi5\Core\Ui5\Contracts\Ui5RegistryInterface

`extends`	`Ui5RuntimeInterface`

Interface Ui5RegistryInterface

Defines the build-time introspection and coordination contract of the LaravelUi5 ecosystem. The registry exposes a unified API to discover, inspect, and reflect upon all UI5-related modules, artifacts, roles, abilities, settings, and semantic objects declared in a Laravel application.

The registry operates at development or build time and performs reflection across modules and PHP attributes. It is the authoritative source for generating cache files, documentation, and metadata used at runtime by the {@see Ui5RuntimeInterface}.

Responsibilities:

Discover modules and artifacts from configuration and attributes
Collect and normalize metadata (roles, abilities, settings, semantic objects)
Provide build-time data for the runtime cache generator (ui5:cache)

System guarantees:

Every module has a unique slug
Every artifact has a globally unique namespace
Artifacts are addressable either through their module or namespace

Example use cases:

Generate the runtime cache file via php artisan ui5:cache
Produce manifest.json files or capability maps for modules
Inspect declared roles, settings, or abilities for validation or documentation

LaravelUi5\Core\Ui5\Contracts\Ui5RegistryInterface extends Ui5RuntimeInterface
- LaravelUi5\Core\Ui5\Ui5Registry implements Ui5RegistryInterface

Located at Ui5/Contracts/Ui5RegistryInterface.php

Methods


					
	public

modules(): Ui5ModuleInterface[]

Returns all registered modules.

Implemented by

LaravelUi5\Core\Ui5\Ui5Registry::modules()


					
	public

artifacts(): Ui5ArtifactInterface[]

Returns all registered artifacts across all modules.

Implemented by

LaravelUi5\Core\Ui5\Ui5Registry::artifacts()


					
	public

roles(): array<string, array>

Returns all roles declared across all modules via #[Role] attributes.

Implemented by

LaravelUi5\Core\Ui5\Ui5Registry::roles()


					
	public

abilities(string|null $namespace = null, ArtifactType|null $type = null): array

Returns all registered abilities, grouped by namespace and ability type.

The result reflects the normalized internal structure: $abilities[$namespace][$type->label()][$abilityName] = Ability.

When $namespace is provided, abilities are limited to that artifact namespace (e.g. "io.pragmatiqu.offers").
When $type is provided, only abilities of that AbilityType (e.g. AbilityType::Act) are returned.
When both are null, all abilities across all namespaces and types are returned.

Example:

$registry->abilities('io.pragmatiqu.reports', AbilityType::Act);
// → [ 'toggleLock' => Ability, 'exportPdf' => Ability, ... ]

Parameters

`$namespace`	Optional artifact namespace to filter by.
`$type`	Optional ability type to filter by.

Implemented by

LaravelUi5\Core\Ui5\Ui5Registry::abilities()


					
	public

settings(string|null $namespace = null): array

Returns all settings declared via #[Setting] attributes, grouped by artifact namespace.

When $namespace is provided, only settings belonging to that namespace are returned.
When $namespace is null, all settings across all registered artifacts are returned.

The result reflects the normalized internal structure: $settings[$namespace][$settingName] = Setting.

Example:

$registry->settings('io.pragmatiqu.dashboard');
// → [ 'refreshInterval' => Setting, 'theme' => Setting, ... ]

Parameters

$namespace

Optional artifact namespace to filter by.

Implemented by

LaravelUi5\Core\Ui5\Ui5Registry::settings()


					
	public

objects(): array<string, array>

Returns all semantic objects declared via #[SemanticObject] attributes.

Each object entry describes a business entity and its available routes or actions as defined in PHP attributes.

Example structure: [ "User" => [ "name" => "User", "module" => "users", "routes" => [ "display" => ["label" => "Show", "icon" => "sap-icon://display"], "edit" => ["label" => "Edit", "icon" => "sap-icon://edit"] ] ] ]

Implemented by

LaravelUi5\Core\Ui5\Ui5Registry::objects()

Methods inherited from LaravelUi5\Core\Ui5\Contracts\Ui5RuntimeInterface
`hasModule(), getModule(), has(), get(), fromSlug(), slugFor(), resolve(), resolveIntents(), resolveRoots()`

Namespaces

Interfaces

Interface LaravelUi5\Core\Ui5\Contracts\Ui5RegistryInterface

Implemented by

Implemented by

Implemented by

Parameters

Implemented by

Parameters

Implemented by

Implemented by