WidgetSettingsFactory

Namespace

Ceres\Widgets\Helper\Factories

Properties
Type Name Description

``

$settings

``

$pointer

Methods
public static inherit($parentWidgetClass):WidgetSettingsFactory

Create a new factory instance and initialize values from given widget class.

Parameters

Type

Name

Description

string

$parentWidgetClass

public static create($data = []):WidgetSettingsFactory

Create a new factory instance with initial values.

Parameters

Type

Name

Description

array

$data

public createSetting($key):BaseSettingFactory

Create a generic widget settings entry.

Parameters

Type

Name

Description

string

$key

The key of the new settings entry. If key already exists, previous entry will be overridden.

public createContainer($key):ContainerSettingFactory

Create a container entry which may contain nested settings.

Parameters

Type

Name

Description

string

$key

public createVerticalContainer($key):ContainerSettingFactory

Create a vertical container

Parameters

Type

Name

Description

string

$key

public createHorizontalContainer($key):ContainerSettingFactory

Create a horizontal container

Parameters

Type

Name

Description

string

$key

public createText($key):TextSettingFactory

Create a text input setting

Parameters

Type

Name

Description

string

$key

public createCheckbox($key):CheckboxSettingFactory

Create a checkbox setting

Parameters

Type

Name

Description

string

$key

public createColorPalette():ColorPaletteSettingFactory

Create a color setting

public createDate($key):DateSettingFactory

Create a date input setting

Parameters

Type

Name

Description

string

$key

public createFile($key):FileSettingFactory

Create a file picker setting

Parameters

Type

Name

Description

string

$key

public createTextarea($key):TextareaSettingFactory

Create a textarea input setting

Parameters

Type

Name

Description

string

$key

public createNumber($key):BaseSettingFactory
Parameters

Type

Name

Description

string

$key

public createDouble($key):DoubleSettingFactory

Create a double input setting

Parameters

Type

Name

Description

string

$key

public createSelect($key):SelectSettingFactory

Create a dropdown setting

Parameters

Type

Name

Description

string

$key

public createSuggestion($key):SuggestionSettingFactory

Create a dropdown setting

Parameters

Type

Name

Description

string

$key

public createCategory($key):CategorySettingFactory

Create a category select setting

Parameters

Type

Name

Description

string

$key

public createColor($key):BaseSettingFactory
Parameters

Type

Name

Description

string

$key

public createSlider($key):SliderSettingFactory

Create a slider setting

Parameters

Type

Name

Description

string

$key

public createCheckboxGroup($key):CheckboxGroupSettingFactory

Create a checkbox group setting

Parameters

Type

Name

Description

string

$key

public createRadioGroup($key):RadioGroupSettingFactory

Create a checkbox group setting

Parameters

Type

Name

Description

string

$key

public createUrl($key):UrlSettingFactory

Create a url picker

Parameters

Type

Name

Description

string

$key

public createNoteEditor($key):EditorSettingFactory
Parameters

Type

Name

Description

string

$key

public createCodeEditor($key):EditorSettingFactory
Parameters

Type

Name

Description

string

$key

public createCustomClass():CustomClassSettingFactory
public createIcon():IconSettingFactory
public createHeight():HeightSettingFactory
public createButtonSize():ButtonSizeSettingFactory
public createAlignment():AlignmentSettingFactory
public toArray()