Creates a new TFormMultiCheck element (multiple checkboxes).
TFormMultiCheck
TFormMultiCheck
(string $name, string $displayname, string $class, array $elements, [string $seperator = ";"], [func $callback = null], [array $value = ""], [bool $store = true])
-
string
$name: The name of the element. This should correspond to the field names if using with TDBForm, and should not include any spaces or special characters.
-
string
$displayname: The name that should show up to the user for this field.
-
string
$class: The HTML Class to use for the element
-
array
$elements: The elements to go in the box. Key field is value, value is the displayed value.
-
string
$seperator: The value used to seperate the values in the returned string (by default a semi-colon)
-
func
$callback: A callback function used to generate the code for individual items. It will get an array containing: [html] - the html for the checkbox, [name] - the display name, [num] - the item number, [total] - the total number of items that will be passed. It should return the exact value to display. By default, if this field is null, it will display the Checkbox, followed by the display name, followed by a
tag.
-
array
$value: The initial value for the field. Note if using a TDBForm this value will be overridden by loadValues so it is effectively only the default for new entries.
-
bool
$store: Whether this value is persistent. Used by TDBForm to decide to save/load this value from database.
Returns a textual description of the current value
A
getValue
([$display $display = false])
-
$display
$display: True if the value is going to be used for display
Redefinition of:
- TFormElement::getValue()
- Returns a textual description of the current value
Sets the value of the field
true
setValue
(mixed $value)
-
mixed
$value: The value to set
Redefinition of:
- TFormElement::setValue()
- Sets the value of the field
Inherited Methods
Inherited From TFormElement
TFormElement::TFormElement()
TFormElement::getValue()
TFormElement::output()
TFormElement::setParent()
TFormElement::setValue()
TFormElement::validate()