A Ui5Module represents the root-level container for all UI5-related artifacts
provided by a feature package or domain module in the LaravelUi5 ecosystem.
A module can contain either a UI5 application or a UI5 library, but not both.
Only applications can provide subordinate artifacts such as cards, actions,
reports, KPIs, and tiles.
Responsibilities:
- Expose the main artifact (App or Library) via type-specific getters
- Declare all subordinate artifacts (if applicable)
- Provide artifact metadata via Ui5ArtifactInterface
System rules:
- A module MUST provide either an app or a library (exclusive)
- A library MUST NOT define subordinate artifacts
- Every artifact must have a globally unique namespace
| Methods |
public
|
getName(): string
Returns the canonical name of the module.
Returns the canonical name of the module.
The module name is a human-readable identifier derived from the module’s
directory structure (e.g. Timesheet, Partners, Finance) and is used
for:
- module introspection,
- help/documentation resolution,
- manifest generation,
- CLI tooling,
- and internal module mapping.
The name must represent the top-level directory under /ui5/<Module>/,
and is therefore expected to be unique within the installation.
Returns
The canonical module name.
Implemented by
|
#
|
public
|
getSourceStrategy(): Ui5SourceStrategyInterface
Returns the Ui5SourceStrategy used to resolve UI5 source artifacts
for this module.
Returns the Ui5SourceStrategy used to resolve UI5 source artifacts
for this module.
The source strategy defines how and from where UI5 resources
(manifest, preload bundles, i18n files, descriptors) are accessed,
depending on the module's origin (e.g. workspace-based or packaged).
The returned value is resolved by the Ui5Registry.
The strategy itself is responsible for:
- determining the runtime UI5 resource path,
- and optionally providing introspection capabilities.
Important:
- This method does NOT perform any filesystem access.
- It only declares which strategy applies to this module.
Returns
Strategy for resolving Ui5Source artifacts.
Implemented by
|
#
|
public
|
hasApp(): bool
Returns true if this module provides a UI5 application.
Returns true if this module provides a UI5 application.
Implemented by
|
#
|
public
|
getApp(): Ui5AppInterface|null
Returns the application artifact, if present.
Returns the application artifact, if present.
Implemented by
|
#
|
public
|
hasLibrary(): bool
Returns true if this module provides a UI5 library.
Returns true if this module provides a UI5 library.
Implemented by
|
#
|
public
|
getLibrary(): Ui5LibraryInterface|null
Returns the library artifact, if present.
Returns the library artifact, if present.
Implemented by
|
#
|
public
|
getArtifactRoot(): Ui5AppInterface|Ui5LibraryInterface
Returns the root artifact of the module — either the application or the library,
depending on the module type.
Returns the root artifact of the module — either the application or the library,
depending on the module type.
This method allows consumers to access the primary artifact in a generic way,
without checking whether the module is app- or library-based.
Returns
The root artifact (App or Library)
Implemented by
|
#
|
public
|
getCards(): Ui5CardInterface[]
Returns an array of all cards provided by this module.
Only available if this module provides an app.
Returns an array of all cards provided by this module.
Only available if this module provides an app.
Implemented by
|
#
|
public
|
getKpis(): Ui5KpiInterface[]
Returns an array of all KPIs provided by this module.
Returns an array of all KPIs provided by this module.
Implemented by
|
#
|
public
|
getTiles(): Ui5TileInterface[]
Returns an array of all tiles for launchpad or navigation purposes.
Returns an array of all tiles for launchpad or navigation purposes.
Implemented by
|
#
|
public
|
getActions(): Ui5ActionInterface[]
Returns an array of all actions (API endpoints) provided by this module.
Returns an array of all actions (API endpoints) provided by this module.
Implemented by
|
#
|
public
|
getResources(): Ui5ResourceInterface[]
Returns an array of all resources (API) provided by this module.
Returns an array of all resources (API) provided by this module.
Implemented by
|
#
|
public
|
getDashboards(): Ui5DashboardInterface[]
Returns an array of all dashboards (API) provided by this module.
Returns an array of all dashboards (API) provided by this module.
This artifact type is not discovered automatically. It must be declared
under the dedicated configuration key dashboards inside your module’s
config/ui5.php.
Implemented by
|
#
|
public
|
getReports(): Ui5ReportInterface[]
Returns an array of all resports (API) provided by this module.
Returns an array of all resports (API) provided by this module.
This artifact type is not discovered automatically. It must be declared
under the dedicated configuration key reports inside your module’s
config/ui5.php.
Implemented by
|
#
|
public
|
getDialogs(): Ui5DialogInterface[]
Returns an array of all dialogs (API) provided by this module.
Returns an array of all dialogs (API) provided by this module.
This artifact type is not discovered automatically. It must be declared
under the dedicated configuration key dialogs inside your module’s
config/ui5.php.
Implemented by
|
#
|
public
|
getAllArtifacts(): Ui5ArtifactInterface[]
Returns all artifacts belonging to this module (app, library, tiles, cards,
kpis, actions, resources, dashboards,…
Returns all artifacts belonging to this module (app, library, tiles, cards,
kpis, actions, resources, dashboards, reports, dialogs, etc.)
Implemented by
|
#
|