SettingsDiff
Read onlyYes
FinalYes
Table of Contents
Properties
- $changes : array<string|int, mixed>
- $deletions : array<string|int, mixed>
- $settings : array<string|int, mixed>
Methods
- __construct() : mixed
- asArray() : array<string|int, mixed>
- create() : self
- Calculate a new settings tree for the given $targetSettings
Properties
$changes
public
array<string|int, mixed>
$changes
$deletions
public
array<string|int, mixed>
$deletions
$settings
public
array<string|int, mixed>
$settings
Methods
__construct()
public
__construct(array<string|int, mixed> $settings, array<string|int, string> $changes, array<string|int, string> $deletions) : mixed
Parameters
- $settings : array<string|int, mixed>
- $changes : array<string|int, string>
- $deletions : array<string|int, string>
asArray()
public
asArray() : array<string|int, mixed>
Return values
array<string|int, mixed>create()
Calculate a new settings tree for the given $targetSettings
public
static create(array<string|int, mixed> $currentSettings, SettingsInterface $targetSettings[, SettingsInterface $defaultSettings = null ]) : self
Settings that have the same value as their default value are removed (tree is minified) if the list of default settings via $defaultSettings.
Parameters
- $currentSettings : array<string|int, mixed>
-
Current settings In case of site settings: config/sites/…/settings.yaml
- $targetSettings : SettingsInterface
-
Target settings (values as supplied via the settings editor)
- $defaultSettings : SettingsInterface = null
-
Default settings, without local settings tree applied. In case of site settings: Combination of all settings defined in settings.definitions.yaml + setting.yaml from all selected sets combined