| 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.
Implements
|
#
|
public
|
hasApp(): bool
Returns true if this module provides a UI5 application.
Returns true if this module provides a UI5 application.
Implements
|
#
|
public
|
getApp(): ?Ui5AppInterface
Returns the application artifact, if present.
Returns the application artifact, if present.
Implements
|
#
|
public
|
hasLibrary(): bool
Returns true if this module provides a UI5 library.
Returns true if this module provides a UI5 library.
Implements
|
#
|
public
|
getLibrary(): ?Ui5LibraryInterface
Returns the library artifact, if present.
Returns the library artifact, if present.
Implements
|
#
|
public
|
getArtifactRoot(): Ui5ArtifactInterface
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)
Implements
|
#
|
public
|
getCards(): array
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.
Implements
|
#
|
public
|
getKpis(): array
Returns an array of all KPIs provided by this module.
Returns an array of all KPIs provided by this module.
Implements
|
#
|
public
|
getTiles(): array
Returns an array of all tiles for launchpad or navigation purposes.
Returns an array of all tiles for launchpad or navigation purposes.
Implements
|
#
|
public
|
getActions(): array
Returns an array of all actions (API endpoints) provided by this module.
Returns an array of all actions (API endpoints) provided by this module.
Implements
|
#
|
public
|
getResources(): array
Returns an array of all resources (API) provided by this module.
Returns an array of all resources (API) provided by this module.
Implements
|
#
|
public
|
getDashboards(): array
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.
Implements
|
#
|
public
|
getReports(): array
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.
Implements
|
#
|
public
|
getDialogs(): array
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.
Implements
|
#
|