icms_ipf_form_elements_Checkbox

Notice: Wiki was automatic generated from project sources as project API documentation. Do not edit manually!

icms_ipf_form_elements_Checkbox

Form control creating a checkbox element for an object derived from icms_ipf_Object

• Class name: icms_ipf_form_elements_Checkbox
• Namespace:
• Parent class: icms_form_elements_Checkbox

Properties

$_delimeter

private string $_delimeter

HTML to separate the elements

• Visibility: private

$_options

private array $_options = array()

Available options

• Visibility: private

$_value

private array $_value = array()

pre-selected values in array

• Visibility: private

Methods

__construct

mixed icms_form_elements_Checkbox::__construct(string caption, string name, mixed value, mixed delimeter)

Constructor

• Visibility: public
• This method is defined by icms_form_elements_Checkbox

Arguments

• caption string
• name string
• value mixed - <p>Either one value as a string or an array of them.</p>
• delimeter mixed

render

string icms_form_elements_Checkbox::render()

prepare HTML for output

• Visibility: public
• This method is defined by icms_form_elements_Checkbox

renderValidationJS

string icms_ipf_form_elements_Checkbox::renderValidationJS()

Creates validation javascript

• Visibility: public

getValue

array icms_form_elements_Checkbox::getValue(bool encode)

Get the "value"

• Visibility: public
• This method is defined by icms_form_elements_Checkbox

Arguments

• encode bool - <p>Would you like to sanitize the text?</p>

setValue

mixed icms_form_elements_Checkbox::setValue(mixed value)

Set the "value"

• Visibility: public
• This method is defined by icms_form_elements_Checkbox

Arguments

• value mixed

addOption

mixed icms_form_elements_Checkbox::addOption(string value, string name)

Add an option

• Visibility: public
• This method is defined by icms_form_elements_Checkbox

Arguments

• value string
• name string

addOptionArray

mixed icms_form_elements_Checkbox::addOptionArray(array options)

Add multiple Options at once

• Visibility: public
• This method is defined by icms_form_elements_Checkbox

Arguments

• options array - <p>Associative array of value->name pairs</p>

getOptions

array icms_form_elements_Checkbox::getOptions(int encode)

Get an array with all the options

• Visibility: public
• This method is defined by icms_form_elements_Checkbox

Arguments

• encode int - <p>To sanitize the text? potential values: 0 - skip; 1 - only for value; 2 - for both value and name</p>

getDelimeter

string icms_form_elements_Checkbox::getDelimeter(bool encode)

Get the delimiter of this group

• Visibility: public
• This method is defined by icms_form_elements_Checkbox

Arguments

• encode bool - <p>To sanitizer the text?</p>