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

$settingDefinitionValidation  : SettingDefinitionValidation
$settingsFactory  : SettingsFactory

Methods

__construct()  : mixed
createSettings()  : SettingsInterface
createSettingsFromFormData()  : SettingsInterface

Properties

Methods

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
SettingsInterface

createSettingsFromFormData()

public createSettingsFromFormData(array<string|int, mixed> $settings, array<string|int, mixed> $definitions) : SettingsInterface
Parameters
$settings : array<string|int, mixed>
$definitions : array<string|int, mixed>
Return values
SettingsInterface

        
On this page

Search results