MultipleCheckboxField extends InputField
in package

Table of Contents

TYPE  = 'multiple-checkbox'
$additionalClasses  : mixed
$allowGroupActions  : mixed
$allSelected  : mixed
$allValue  : mixed
$alwaysEnabled  : array<string|int, mixed>
$default  : mixed
$description  : mixed
$description2  : mixed
$details  : mixed
$disabled  : mixed
$innerLabel  : mixed
$label  : mixed
$list  : mixed
$name  : mixed
$readonly  : mixed
$required  : mixed
$translatable  : mixed
$value  : mixed
__construct()  : mixed
addClass()  : mixed
getAllValue()  : mixed
getDefault()  : mixed
getDescription()  : string
getDescription2()  : mixed
getInnerLabel()  : mixed
getInnerLabelTag()  : mixed
getLabel()  : mixed
getLabelTag()  : mixed
getList()  : mixed
getName()  : mixed
getType()  : mixed
getValue()  : mixed
hasLabel()  : mixed
isDisabled()  : bool
isReadonly()  : mixed
isTranslatable()  : bool
output()  : mixed
removeClass()  : mixed
render()  : mixed
renderValue()  : mixed
sanitize()  : mixed
setDescription()  : mixed
setDescription2()  : mixed
setDisabled()  : mixed
setName()  : mixed
setReadonly()  : mixed
setRequired()  : mixed
setValue()  : mixed
generateAttrs()  : mixed
getCtrlAtts()  : mixed
getCtrlClasses()  : mixed
renderCheckbox()  : string
renderFakeItem()  : string
renderInput()  : mixed
renderListItem()  : mixed

Constants

TYPE

public mixed TYPE = 'multiple-checkbox'

Properties

$additionalClasses

protected mixed $additionalClasses = ''

$allowGroupActions

protected mixed $allowGroupActions = true

$allSelected

protected mixed $allSelected = false

$allValue

protected mixed $allValue = null

$alwaysEnabled

protected array<string|int, mixed> $alwaysEnabled = array()
Tags
since
3.6.0

$default

protected mixed $default = array()

$description

protected mixed $description = ''

$description2

protected mixed $description2 = ''

$details

protected mixed $details

$disabled

protected mixed $disabled = false

$innerLabel

protected mixed $innerLabel = ''

$label

protected mixed $label = ''

$list

protected mixed $list = array()

$name

protected mixed $name

$readonly

protected mixed $readonly = false

$required

protected mixed $required = false

$translatable

protected mixed $translatable = false

$value

protected mixed $value

Methods

__construct()

public __construct(mixed $name, mixed $details[, mixed $value = '' ]) : mixed
Parameters
$name : mixed
$details : mixed
$value : mixed = ''
Return values
mixed —

addClass()

public addClass(mixed $class) : mixed
Parameters
$class : mixed
Return values
mixed —

getAllValue()

public getAllValue() : mixed
Return values
mixed —

getDefault()

public getDefault() : mixed
Return values
mixed —

getDescription()

public getDescription() : string
Tags
since
3.5.1
Return values
string —

getDescription2()

public getDescription2() : mixed
Return values
mixed —

getInnerLabel()

public getInnerLabel() : mixed
Return values
mixed —

getInnerLabelTag()

public getInnerLabelTag() : mixed
Return values
mixed —

getLabel()

public getLabel() : mixed
Return values
mixed —

getLabelTag()

public getLabelTag() : mixed
Return values
mixed —

getList()

public getList() : mixed
Return values
mixed —

getName()

public getName() : mixed
Return values
mixed —

getType()

public getType() : mixed
Return values
mixed —

getValue()

public getValue() : mixed
Return values
mixed —

hasLabel()

public hasLabel() : mixed
Return values
mixed —

isDisabled()

public isDisabled() : bool
Tags
since
3.9.5
Return values
bool —

isReadonly()

public isReadonly() : mixed
Return values
mixed —

isTranslatable()

public isTranslatable() : bool
Return values
bool —

output()

public output() : mixed
Return values
mixed —

removeClass()

public removeClass(mixed $class) : mixed
Parameters
$class : mixed
Return values
mixed —

render()

public render() : mixed
Return values
mixed —

renderValue()

public static renderValue(self $field) : mixed
Parameters
$field : self
Return values
mixed —

sanitize()

public sanitize(mixed $values) : mixed
Parameters
$values : mixed
Return values
mixed —

setDescription()

public setDescription(mixed $description) : mixed
Parameters
$description : mixed
Return values
mixed —

setDescription2()

public setDescription2(mixed $description) : mixed
Parameters
$description : mixed
Return values
mixed —

setDisabled()

public setDisabled(bool $disabled) : mixed
Parameters
$disabled : bool
Return values
mixed —

setName()

public setName(mixed $name) : mixed
Parameters
$name : mixed
Return values
mixed —

setReadonly()

public setReadonly(bool $readonly) : mixed
Parameters
$readonly : bool
Return values
mixed —

setRequired()

public setRequired(bool $required) : mixed
Parameters
$required : bool
Return values
mixed —

setValue()

public setValue(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed —

generateAttrs()

protected generateAttrs() : mixed
Return values
mixed —

getCtrlAtts()

protected getCtrlAtts() : mixed
Return values
mixed —

getCtrlClasses()

protected getCtrlClasses() : mixed
Return values
mixed —

renderCheckbox()

protected renderCheckbox(string $name, string $value, string $atts, string $label) : string
Parameters
$name : string
$value : string
$atts : string
$label : string
Tags
since
3.6.0
Return values
string —

renderFakeItem()

protected renderFakeItem(string $value, string $label) : string
Parameters
$value : string
$label : string
Tags
since
3.6.0
Return values
string —

renderInput()

protected renderInput() : mixed
Return values
mixed —

renderListItem()

protected renderListItem(mixed $value, mixed $label[, mixed $addClass = '' ]) : mixed
Parameters
$value : mixed
$label : mixed
$addClass : mixed = ''
Return values
mixed —

Search results