| Methods |
public
|
__construct(?array $config = null)
|
#
|
public
static
|
fromArray(array $config): self
|
#
|
public
|
hasModule(string $slug): bool
-- Lookup ----------------------------------------------------------
-- Lookup ----------------------------------------------------------
Parameters
| $slug |
The URL slug to identify the module (from config/ui5.php > modules)
|
Returns
True if module for slug is known
Implements
|
#
|
public
|
getModule(string $slug): ?Ui5ModuleInterface
Returns the module instance for the given slug, or null if not found.
Returns the module instance for the given slug, or null if not found.
Parameters
| $slug |
The URL slug to identify the module (from config/ui5.php > modules)
|
Returns
The instantiated module, or null if not found
Implements
|
#
|
public
|
modules(): array
Returns all registered modules.
Returns all registered modules.
Implements
|
#
|
public
|
has(string $namespace): bool
Checks whether an artifact with the given namespace is registered.
Checks whether an artifact with the given namespace is registered.
Parameters
| $namespace |
The fqn of the UI5 artifact
|
Returns
True if namespace for artifact is known
Implements
|
#
|
public
|
get(string $namespace): ?Ui5ArtifactInterface
Returns the artifact instance for the given namespace, or null if not found.
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
Implements
|
#
|
public
|
artifacts(): array
Returns all registered artifacts across all modules.
Returns all registered artifacts across all modules.
Implements
|
#
|
public
|
roles(): array
-- Introspection ---------------------------------------------------
-- Introspection ---------------------------------------------------
Implements
|
#
|
public
|
abilities(?string $namespace = null, ?ArtifactType $type = null): array
Returns all registered abilities, grouped by namespace and ability type.
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.
|
Implements
|
#
|
public
|
settings(?string $namespace = null): array
Returns all settings declared via #[Setting] attributes,
grouped by artifact namespace.
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.
|
Implements
|
#
|
public
|
objects(): array
Returns all semantic objects declared via #[SemanticObject] attributes.
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"]
]
]
]
Implements
|
#
|
public
|
fromSlug(string $slug): ?Ui5ArtifactInterface
-- Laravel routing -------------------------------------------------
-- Laravel routing -------------------------------------------------
Parameters
| $slug |
The URL slug to identify the artifact
|
Returns
The instantiated artifact, or null if not found
Implements
|
#
|
public
|
slugFor(Ui5ArtifactInterface $artifact): ?string
Returns the canonical slug (e.g. "app/offers") for the given artifact.
Returns the canonical slug (e.g. "app/offers") for the given artifact.
Implements
|
#
|
public
|
resolveIntents(string $slug): array
-- manifest.json facing --------------------------------------------
-- manifest.json facing --------------------------------------------
Parameters
Implements
|
#
|
public
|
resolve(string $namespace): ?string
Resolves a full public URL path for the given namespace
(e.g. "/ui5/app/offers/1.0.0").
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
Implements
|
#
|
public
|
resolveRoots(array $namespaces): array
Resolves resource root URLs (namespace => URL) for multiple namespaces.
Resolves resource root URLs (namespace => URL) for multiple namespaces.
Parameters
| $namespaces |
The fqn of the UI5 artifact (app or lib!)
|
Implements
|
#
|
public
|
exportToCache(): array
-- Export ----------------------------------------------------------
-- Export ----------------------------------------------------------
|
#
|