WidgetOptionFactory
in package
Class representing widget option factory.
Table of Contents
- $dropdownFactory : DropdownOptionFactory
- Dropdown factory.
- $predefinedFactory : PredefinedOptionFactory
- Predefined option factory.
- __construct() : mixed
- Constructor.
- createCheckbox() : CheckboxOption
- Return checkbox option.
- createId() : OptionId
- Return ID.
- createNumber() : NumberOption
- Return number option.
- createOptions() : WidgetOptions
- Return options.
- createOptionsFromUpdateSet() : WidgetOptions
- Return options from update set and widget options.
- createText() : TextOption
- Return text option.
- createTitle() : OptionTitle
- Return title.
- createTitles() : OptionTitles
- Return multilingual titles.
- createUpdateSet() : OptionUpdateSet
- Return update set.
- useDropdowns() : DropdownOptionFactory
- Return dropdown factory.
- usePredefined() : PredefinedOptionFactory
- Return predefined option factory.
Properties
$dropdownFactory
Dropdown factory.
private
DropdownOptionFactory
$dropdownFactory
$predefinedFactory
Predefined option factory.
private
PredefinedOptionFactory
$predefinedFactory
Methods
__construct()
Constructor.
public
__construct(DropdownOptionFactory $dropdownFactory, PredefinedOptionFactory $predefinedFactory) : mixed
Parameters
- $dropdownFactory : DropdownOptionFactory
-
Dropdown factory.
- $predefinedFactory : PredefinedOptionFactory
-
Predefined option factory.
Return values
mixed —createCheckbox()
Return checkbox option.
public
createCheckbox(OptionId $id, bool $value, OptionTitles $titles) : CheckboxOption
Parameters
- $id : OptionId
-
ID.
- $value : bool
-
Value.
- $titles : OptionTitles
-
Multilingual titles.
Return values
CheckboxOption —Checkbox option.
createId()
Return ID.
public
createId(string $id) : OptionId
Parameters
- $id : string
-
ID.
Return values
OptionId —ID.
createNumber()
Return number option.
public
createNumber(OptionId $id, int $value, OptionTitles $titles) : NumberOption
Parameters
- $id : OptionId
-
ID.
- $value : int
-
Value.
- $titles : OptionTitles
-
Multilingual titles.
Return values
NumberOption —Number option.
createOptions()
Return options.
public
createOptions(WidgetOption ...$options) : WidgetOptions
Parameters
- $options : WidgetOption
-
Options.
Return values
WidgetOptions —Options.
createOptionsFromUpdateSet()
Return options from update set and widget options.
public
createOptionsFromUpdateSet(OptionUpdateSet $updateSet, WidgetOptions $options) : WidgetOptions
Parameters
- $updateSet : OptionUpdateSet
-
Update set.
- $options : WidgetOptions
-
Widget options.
Tags
Return values
WidgetOptions —Widget options.
createText()
Return text option.
public
createText(OptionId $id, string $value, OptionTitles $titles) : TextOption
Parameters
- $id : OptionId
-
ID.
- $value : string
-
Value.
- $titles : OptionTitles
-
Multilingual titles.
Return values
TextOption —Text option.
createTitle()
Return title.
public
createTitle(LanguageCode $languageCode, string $title) : OptionTitle
Parameters
- $languageCode : LanguageCode
-
Language code.
- $title : string
-
Title.
Return values
OptionTitle —createTitles()
Return multilingual titles.
public
createTitles(OptionTitle ...$titles) : OptionTitles
Parameters
- $titles : OptionTitle
-
Multilingual Titles.
Return values
OptionTitles —Multilingual Titles.
createUpdateSet()
Return update set.
public
createUpdateSet(array<string|int, mixed> $updateSet) : OptionUpdateSet
Parameters
- $updateSet : array<string|int, mixed>
-
Update set.
Return values
OptionUpdateSet —Update set.
useDropdowns()
Return dropdown factory.
public
useDropdowns() : DropdownOptionFactory
Return values
DropdownOptionFactory —Dropdown factory.
usePredefined()
Return predefined option factory.
public
usePredefined() : PredefinedOptionFactory
Return values
PredefinedOptionFactory —Predefined option factory.