abstract class MultiChoiceControl extends BaseControl

Choice control that allows multiple items selection.

Properties

bool $checkAllowedValues
array $items
array read-only $selectedItems

Methods

__construct($label = NULL, array $items = NULL)

No description

void
loadHttpData()

Loads HTTP data.

void
setValue($values)

Sets selected items (by keys).

mixed
getValue()

Returns selected keys.

array
getRawValue()

Returns selected keys (not checked).

bool
isFilled()

Is any item selected?

setItems(array $items, $useKeys = TRUE)

Sets items from which to choose.

array
getItems()

Returns items from which to choose.

array
getSelectedItems()

Returns selected values.

setDisabled($value = TRUE)

Disables or enables control or items.

string
getHtmlName()

Returns HTML name of control.

Details

at line 28
__construct($label = NULL, array $items = NULL)

No description

Parameters

$label
array $items

at line 41
void loadHttpData()

Loads HTTP data.

Return Value

void

at line 56
void setValue($values)

internal  
 

Sets selected items (by keys).

Parameters

$values

Return Value

void

at line 85
mixed getValue()

Returns selected keys.

Return Value

mixed

at line 95
array getRawValue()

Returns selected keys (not checked).

Return Value

array

at line 105
bool isFilled()

Is any item selected?

Return Value

bool

at line 117
MultiChoiceControl setItems(array $items, $useKeys = TRUE)

Sets items from which to choose.

Parameters

array $items
$useKeys

Return Value

MultiChoiceControl

at line 128
array getItems()

Returns items from which to choose.

Return Value

array

at line 138
array getSelectedItems()

Returns selected values.

Return Value

array

at line 149
BaseControl setDisabled($value = TRUE)

Disables or enables control or items.

Parameters

$value

Return Value

BaseControl

at line 166
string getHtmlName()

Returns HTML name of control.

Return Value

string