| Methods |
public
|
__construct(Ui5ModuleInterface $module)
|
#
|
public
|
getModule(): ?Ui5ModuleInterface
Returns the parent module of this artifact, if any.
Returns the parent module of this artifact, if any.
- For Applications, Libraries, Cards, Reports, Tiles, KPIs, Actions and Resources:
this returns the Ui5ModuleInterface instance that owns the artifact.
- For Dashboards (global containers outside module scope), this returns null.
Implements
|
#
|
public
|
getSlug(): string
Returns the slug that identifies this artifact/module/action within its context.
Returns the slug that identifies this artifact/module/action within its context.
This value is used to generate the url_key, which serves as a unified
identifier across the client (routing), server (controllers), registry,
and admin/database layers.
Returns
A stable, kebab-case string (e.g. "toggle-lock", "budget-report")
Implements
|
#
|
public
|
getType(): ArtifactType
Returns the type of the artifact (e.g., application, library, card).
Returns the type of the artifact (e.g., application, library, card).
Implements
|
#
|
public
|
getNamespace(): string
Returns the JavaScript namespace of the artifact.
Returns the JavaScript namespace of the artifact.
This namespace must be globally unique and is typically used as
the id in manifest.json as well as the key in the UI5 resource
root mapping (e.g. "io.pragmatiqu.tools").
Implements
|
#
|
public
|
getVersion(): string
Returns the semantic version of the artifact.
Returns the semantic version of the artifact.
The version string is used to construct resource paths and control
client-side caching (e.g. "1.0.0").
Implements
|
#
|
public
|
getTitle(): string
Returns the localized title of the application (e.g., for manifest.json).
Returns the localized title of the application (e.g., for manifest.json).
Implements
|
#
|
public
|
getDescription(): string
Returns a short description of the application.
Returns a short description of the application.
Implements
|
#
|
public
|
getUi5BootstrapAttributes(): array
Returns a key-value map of sap-ui bootstrap attributes
(e.g. theme, async, compatVersion, oninit, etc.).
Returns a key-value map of sap-ui bootstrap attributes
(e.g. theme, async, compatVersion, oninit, etc.).
These will be injected into the UI5 bootstrap script tag.
Implements
|
#
|
public
|
getResourceNamespaces(): array
Returns a list of all required resource roots for this app.
The keys are the JS namespaces.
Returns a list of all required resource roots for this app.
The keys are the JS namespaces.
Example: ['io.pragmatiqu.portal', 'io.pragmatiqu.tools']
Implements
|
#
|
public
|
getAdditionalHeadScript(): ?string
Optional inline JavaScript to be included in the <head> tag.
Optional inline JavaScript to be included in the tag.
Typically used for sap.ui.loader.config(...) blocks.
Implements
|
#
|
public
|
getAdditionalInlineCss(): ?string
Optional inline CSS styles to be included in the <head> tag.
Optional inline CSS styles to be included in the tag.
Implements
|
#
|
public
|
getAssetPath(string $filename): ?string
Resolve the absolute path to an exposed asset (e.g., Component-preload.js).
Resolve the absolute path to an exposed asset (e.g., Component-preload.js).
If the file exists, return the full path. Otherwise, return null.
Parameters
| $filename |
The relative asset filename requested
|
Returns
The full filesystem path if it exists, or null otherwise
Implements
|
#
|
public
|
getVendor(): string
Returns the vendor name that owns or provides this artifact.
Returns the vendor name that owns or provides this artifact.
Implements
|
#
|
public
|
getManifestPath(): string
Returns the absolute path to the raw manifest.json file
as shipped by the frontend UI5 application.
Returns the absolute path to the raw manifest.json file
as shipped by the frontend UI5 application.
This method is used by the Laravel ManifestController to read
the complete manifest structure (sap.app, sap.ui, sap.ui5)
without having to reconstruct it from PHP.
Returns
Absolute filesystem path to manifest.json
Implements
|
#
|
public
|
getLaravelUiManifest(): LaravelUi5ManifestInterface
Returns Laravel-specific manifest data to be injected
under the `laravel.ui5` root key in the final manifest.json.
Returns Laravel-specific manifest data to be injected
under the laravel.ui5 root key in the final manifest.json.
This section may include definitions such as abilities, actions,
settings, reports, or other backend-managed frontend metadata.
Implements
|
#
|