class CheckboxList extends MultiChoiceControl

Set of checkboxes.

Properties

protected $separator
protected $container
protected $itemLabel
Html read-only $separatorPrototype
Html read-only $containerPrototype
Html read-only $itemLabelPrototype

Methods

__construct(string|Stringable|null $label = null, array|null $items = null)

No description

void
loadHttpData()

Loads HTTP data.

Html|string
getControl()

Generates control's HTML element.

Html|string|null
getLabel(string|Stringable|null $caption = null)

Generates label's HTML element.

Html|null
getControlPart($key = null)

Returns the HTML input element for a specific checkbox item by key.

Html|null
getLabelPart($key = null)

Returns the label element for the whole checkbox list, or the item label for a specific key.

Html
getSeparatorPrototype()

Returns separator HTML element template.

Html
getContainerPrototype()

Returns container HTML element template.

Html
getItemLabelPrototype()

Returns item label HTML element template.

Details

at line 31
__construct(string|Stringable|null $label = null, array|null $items = null)

No description

Parameters

string|Stringable|null $label
array|null $items

at line 42
void loadHttpData()

Loads HTTP data.

Return Value

void

at line 54
Html|string getControl()

Generates control's HTML element.

Return Value

Html|string

at line 78
Html|string|null getLabel(string|Stringable|null $caption = null)

Generates label's HTML element.

Parameters

string|Stringable|null $caption

Return Value

Html|string|null

at line 87
Html|null getControlPart($key = null)

Returns the HTML input element for a specific checkbox item by key.

Parameters

$key

Return Value

Html|null

at line 103
Html|null getLabelPart($key = null)

Returns the label element for the whole checkbox list, or the item label for a specific key.

Parameters

$key

Return Value

Html|null

at line 115
Html getSeparatorPrototype()

Returns separator HTML element template.

Return Value

Html

at line 124
Html getContainerPrototype()

Returns container HTML element template.

Return Value

Html

at line 133
Html getItemLabelPrototype()

Returns item label HTML element template.

Return Value

Html