extends |
Model |
|---|
Class Setting
Represents a configuration entry for a specific UI5 artifact. Settings define system or user-level preferences that influence the behavior of UI5 apps, cards, or reports at runtime.
Settings exist in multiple scopes ({@see Scope}), prioritized so the most specific context wins: User > Site > Tenant > Installation > Platform
They are resolved dynamically by scope precedence — the highest-scope value
contributed for the acting partner wins. The Platform-scope row is the
default, written by the SettingsWorker from the Core attribute during
ui5:sync; higher scopes are overrides written by partners whose
system_level permits the setting's edit level.
Settings are managed entirely at runtime — there is no static registry
or manifest definition beyond the Platform default. They can be changed
through APIs, configuration UIs, or the ui5:sync maintenance routine.
sdk_partners.id, set only for Scope::User
(personal) rows so each user keeps their own valueThe partner_id column references sdk_partners.id (cascade on delete)
and owns a setting at the actor level. It is set only for Scope::User
rows; for every non-User scope the column is null (the value is shared).
| Methods | ||
|---|---|---|
public
|
artifact(): BelongsTo
|
# |
public
|
isPersonalSetting(): bool
|
# |
public
|
__toString(): string
|
# |
| Properties | |||
|---|---|---|---|
public
|
int
|
$id
|
# |
public
|
int
|
$artifact_id
|
# |
public
|
Scope
|
$scope
|
# |
public
|
string
|
$setting
|
# |
public
|
int|null
|
$partner_id
|
# |
public
|
mixed
|
$value
|
# |
public
|
ValueType
|
$value_type
|
# |
public
|
EditLevel
|
$level
|
# |
public
|
string
|
$value_help
|
# |
public
|
string
|
$value_help_scope
|
# |
public
|
Carbon
|
$created_at
|
# |
public
|
Carbon
|
$updated_at
|
# |
public
readonly
|
Artifact
|
$artifact
|
# |