WidgetSettingsFactory
Read onlyYes
Factory for creating widget settings instances.
This factory creates Settings objects for dashboard widgets, combining default values from setting definitions with instance-specific values. It handles validation of setting definitions and provides utilities for creating settings from form data submitted through the widget configuration interface.
The factory supports creating settings with various options:
- Respecting readonly settings
- Omitting default values when needed
- Processing form data for widget configuration updates
Attributes
- #[Autoconfigure]
- $public: true
Table of Contents
Properties
Methods
- __construct() : mixed
- createSettings() : SettingsInterface
- createSettingsFromFormData() : SettingsInterface
Properties
$settingDefinitionValidation
protected
SettingDefinitionValidation
$settingDefinitionValidation
$settingsFactory
protected
SettingsFactory
$settingsFactory
Methods
__construct()
public
__construct(SettingsFactory $settingsFactory, SettingDefinitionValidation $settingDefinitionValidation) : mixed
Parameters
- $settingsFactory : SettingsFactory
- $settingDefinitionValidation : SettingDefinitionValidation
createSettings()
public
createSettings(string $name, array<string|int, mixed> $settings, array<string|int, SettingDefinition> $definitions[, bool $respectReadonly = false ][, bool $omitDefaults = false ]) : SettingsInterface
Parameters
- $name : string
- $settings : array<string|int, mixed>
- $definitions : array<string|int, SettingDefinition>
- $respectReadonly : bool = false
- $omitDefaults : bool = false
Return values
SettingsInterfacecreateSettingsFromFormData()
public
createSettingsFromFormData(array<string|int, mixed> $settings, array<string|int, mixed> $definitions) : SettingsInterface
Parameters
- $settings : array<string|int, mixed>
- $definitions : array<string|int, mixed>