Interface LaravelUi5\Core\Ui5\Contracts\Ui5RegistryInterface

Interface Ui5RegistryInterface

Build-time registry and introspection contract for the LaravelUi5 Core.

The Ui5Registry is the authoritative source of truth for all UI5-related artifacts declared in a Laravel application. It is responsible for discovering, instantiating, and indexing UI5 modules and artifacts based on configuration and PHP attributes.

The registry operates exclusively at build time (or during application bootstrapping) and is intentionally reflection-heavy. Its primary purpose is to provide normalized, deterministic metadata for:

runtime cache generation
manifest and resource root assembly
documentation and inspection tooling

The registry does NOT:

perform authorization
interpret semantic meaning
resolve user intents
make runtime decisions

In Core 2.0, the registry is strictly technical and URI-oriented. Semantic concerns (navigation meaning, intent declaration, authorization) are explicitly handled by the SDK layer.

Responsibilities:

Discover UI5 modules from configuration
Discover UI5 artifacts via module registration
Guarantee uniqueness of module slugs and artifact namespaces
Provide deterministic lookup structures for cache generation

System guarantees:

Each module has exactly one unique slug
Each artifact has a globally unique namespace
Artifact type (app, lib, action, report, …) is stable and deterministic

Typical consumers:

ui5:cache command
build-time manifest generators
tooling and diagnostics

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

Located at Ui5/Contracts/Ui5RegistryInterface.php

Methods


					
	public

modules(): array<string, Ui5ModuleInterface>

Returns all registered modules.

Implemented by

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


					
	public

getModule(string $namespace): Ui5ModuleInterface|null

Returns the module instance for the given slug, or null if not found.

Parameters

$namespace

The URL slug to identify the module (from config/ui5.php > modules)

Returns

The instantiated module, or null if not found

Implemented by

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


					
	public

artifacts(): array<string, Ui5ArtifactInterface>

Returns all registered artifacts across all modules.

Implemented by

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


					
	public

get(string $namespace): Ui5ArtifactInterface|null

Returns the artifact instance for the given namespace, or null if not found.

Parameters

$namespace

The fqn of the UI5 artifact

Returns

The instantiated artifact, or null if not found

Implemented by

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


					
	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

pathToNamespace(string $namespace): string

Converts external URI path segments to canonical registry namespace.

Example:

"io/pragmatiqu/partners" → "io.pragmatiqu.partners"

This method centralizes URI-to-registry normalization logic and avoids scattering string transformation rules across the codebase.

Implemented by

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


					
	public

namespaceToPath(string $namespace): string

Converts canonical registry namespace to external URI path segments.

Example:

"io.pragmatiqu.partners" → "io/pragmatiqu/partners"

This method centralizes registry-to-URI normalization logic and avoids scattering string transformation rules across the codebase.

Implemented by

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


					
	public

resolve(string $namespace): string|null

Resolves a full public URL path for the given namespace (e.g. "/ui5/app/offers/1.0.0").

Parameters

$namespace

The fqn of the UI5 artifact

Returns

The absolute path, or null if not found

Implemented by

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


					
	public

resolveRoots(array<int, string> $namespaces): array<string, string>

Resolves resource root URLs (namespace => URL) for multiple namespaces.

Parameters

$namespaces

The fqn of the UI5 artifact (app or lib!)

Implemented by

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

Namespaces

Interfaces

Interface LaravelUi5\Core\Ui5\Contracts\Ui5RegistryInterface

Implemented by

Parameters

Returns

Implemented by

Implemented by

Parameters

Returns

Implemented by

Parameters

Implemented by

Implemented by

Implemented by

Parameters

Returns

Implemented by

Parameters

Implemented by