class ControlGroup

A user group of form controls.

Traits

Strict class for better experience.

Properties

protected SplObjectStorage $controls

Methods

__construct()

No description

add(...$items)

No description

void
remove(IControl $control)

No description

void
removeOrphans()

No description

array
getControls()

No description

setOption(string $key, $value)

Sets user-specific option.

mixed
getOption(string $key, $default = null)

Returns user-specific option.

array
getOptions()

Returns user-specific options.

Details

at line 29
__construct()

at line 36
ControlGroup add(...$items)

Parameters

...$items

Return Value

ControlGroup

at line 58
void remove(IControl $control)

Parameters

IControl $control

Return Value

void

at line 64
void removeOrphans()

Return Value

void

at line 75
array getControls()

Return Value

array

at line 92
ControlGroup setOption(string $key, $value)

Sets user-specific option.

Options recognized by DefaultFormRenderer - 'label' - textual or IHtmlString object label - 'visual' - indicates visual group - 'container' - container as Html object - 'description' - textual or IHtmlString object description - 'embedNext' - describes how render next group

Parameters

string $key
$value

Return Value

ControlGroup

at line 108
mixed getOption(string $key, $default = null)

Returns user-specific option.

Parameters

string $key
$default

Return Value

mixed

at line 117
array getOptions()

Returns user-specific options.

Return Value

array