Properties

$parsedFormProperties

$parsedFormProperties : array|null

Type

array|null

$widgetId

$widgetId : string

The widget identifier.

Type

string

$showNotesAbove

$showNotesAbove : boolean

Whether notes shoudl be display before or after the form fields.

Type

boolean

$groupProperties

$groupProperties : array

Type

array

$propertiesOptions

$propertiesOptions : array

Type

array

Methods

__construct()

__construct(array|\ArrayAccess  $data) 

Parameters

array|\ArrayAccess $data

Dependencies.

setDependencies()

setDependencies(\Pimple\Container  $container) : void

Parameters

\Pimple\Container $container

The DI container.

type()

type() : string

Returns

string

setWidgetId()

setWidgetId(string  $widgetId) : \Charcoal\Admin\Widget\AdminWidget

Parameters

string $widgetId

The widget identifier.

Returns

\Charcoal\Admin\Widget\AdminWidget —

Chainable

widgetId()

widgetId() : string

Returns

string

setGroupProperties()

setGroupProperties(array  $properties) : \Charcoal\Admin\Widget\FormGroupWidget

Parameters

array $properties

The group properties.

Returns

\Charcoal\Admin\Widget\FormGroupWidget

Chainable

groupProperties()

groupProperties() : array

Returns

array

setPropertiesOptions()

setPropertiesOptions(array  $properties) : \Charcoal\Admin\Widget\FormGroupWidget

Parameters

array $properties

The options to customize the group properties.

Returns

\Charcoal\Admin\Widget\FormGroupWidget

Chainable

propertiesOptions()

propertiesOptions() : array

Returns

array

hasFormProperties()

hasFormProperties() : boolean

Determine if the form group has properties.

Returns

boolean

formProperties()

formProperties() : mixed|\Charcoal\Admin\Widget\Generator

Retrieve the object's properties from the form.

Returns

mixed|\Charcoal\Admin\Widget\Generator

languages()

languages() : array

Retrieve the available languages, formatted for the sidebar language-switcher.

Returns

array

description()

description() : \Charcoal\Admin\Widget\Translation|string|null

Returns

\Charcoal\Admin\Widget\Translation|string|null

notes()

notes() : \Charcoal\Admin\Widget\Translation|string|null

Returns

\Charcoal\Admin\Widget\Translation|string|null

setShowNotes()

setShowNotes(boolean|string  $show) : \Charcoal\Admin\Widget\FormGroupWidget

Show/hide the widget's notes.

Parameters

boolean|string $show

Whether to show or hide notes.

Returns

\Charcoal\Admin\Widget\FormGroupWidget

Chainable

showNotesAbove()

showNotesAbove() : boolean

Returns

boolean

parsedFormProperties()

parsedFormProperties() : array

Parse the form group and model properties.

Returns

array