Class Quform_Element_Checkbox

Quform_Element_Checkbox implements Quform_Element_Editable

Copyright: Copyright (c) 2009-2022 ThemeCatcher (https://www.themecatcher.net)
Located at Quform/Element/Checkbox.php

Methods summary
`public array`	# `prepareDynamicValue( string $value )` Prepare the dynamic default value Prepare the dynamic default value Parameters `$value` Returns array Overrides `Quform_Element_Field::prepareDynamicValue()`
`protected boolean`	# `isValidValue( array $value )` Set the value Set the value Parameters `$value` Returns boolean Overrides `Quform_Element_Field::isValidValue()`
`public boolean`	# `hasValue( mixed $value )` Does this element have the given value? Does this element have the given value? Parameters `$value` Returns boolean Overrides `Quform_Element_Field::hasValue()`
`public array`	# `getEmptyValue( )` Get the empty value for this element Get the empty value for this element Returns array Overrides `Quform_Element_Field::getEmptyValue()`
`public array`	# `getValue( )` Get the filtered value Get the filtered value Returns array Overrides `Quform_Element_Field::getValue()`
`public string`	# `getValueHtml( )` Get the value formatted for HTML Get the value formatted for HTML Returns string Overrides `Quform_Element_Field::getValueHtml()`
`public string`	# `getValueText( string $separator = ', ' )` Get the value formatted in plain text Get the value formatted in plain text Parameters `$separator` The separator Returns string Overrides `Quform_Element_Field::getValueText()`
`protected string`	# `getConvertedValueForStorage( )` Get the value in storage format Get the value in storage format Returns string Overrides `Quform_Element_Field::getConvertedValueForStorage()`
`protected array`	# `convertValueFromStorage( string $value )` Convert given the value from storage format Convert given the value from storage format Parameters `$value` Returns array Overrides `Quform_Element_Field::convertValueFromStorage()`
`public boolean`	# `isEmpty( )` If the value is not an array or is an empty array it's empty If the value is not an array or is an empty array it's empty Returns boolean Overrides `Quform_Element_Field::isEmpty()`
`protected string`	# `getLabelHtml( array $context = array(), string\|boolean $forAttribute = true, boolean $id = false )` Get the HTML for the element label Get the HTML for the element label Parameters `$context` `$forAttribute` Set the "for" attribute to the element unique ID `$id` Add a unique ID to the label Returns string Overrides `Quform_Element_Field::getLabelHtml()`
`protected array`	# `getFieldAttributes( array $option, array $context = array() )` Get the HTML attributes for the field Get the HTML attributes for the field Parameters `$option` The current option within the loop `$context` Returns array
`protected array`	# `getFieldClasses( array $option, array $context = array() )` Get the classes for the field Get the classes for the field Parameters `$option` The current option within the loop `$context` Returns array
`protected string`	# `getFieldHtml( array $context = array() )` Get the HTML for the field Get the HTML for the field Parameters `$context` Returns string
`protected string`	# `getInputHtml( array $context = array() )` Get the HTML for the element input wrapper Get the HTML for the element input wrapper Parameters `$context` Returns string Overrides `Quform_Element_Field::getInputHtml()`
`protected boolean`	# `hasOnlySimpleOptions( array $context = array() )` Returns true if the options are simple text options, false otherwise Returns true if the options are simple text options, false otherwise Parameters `$context` Returns boolean
`public string`	# `getEditFieldHtml( )` Get the field HTML when editing Get the field HTML when editing Returns string Implementation of `Quform_Element_Editable::getEditFieldHtml()`
`protected string`	# `renderCss( array $context = array() )` Render the CSS for this element Render the CSS for this element Parameters `$context` Returns string Overrides `Quform_Element_Field::renderCss()`
`public static array`	# `getDefaultOptionConfig( string\|null $key = null )` Get the default option config Get the default option config Parameters `$key` Get the config by key, if omitted the full config is returned Returns array Overrides `Quform_Element_Multi::getDefaultOptionConfig()`
`protected static array`	# `getDefaultOptions( )` Get the default options for this element Get the default options for this element Returns array
`public static array`	# `getDefaultConfig( string\|null $key = null )` Get the default element configuration Get the default element configuration Parameters `$key` Get the config by key, if omitted the full config is returned Returns array

Methods inherited from Quform_Element_Multi
`addOption(), addOptions(), clearOptions(), getCssSelectors(), getOptionValue(), getOptions(), isLogicRuleMatch(), prepareContext(), setOptions()`

Methods inherited from Quform_Element_Field
addError(), addFilter(), addValidator(), clearError(), clearErrors(), clearFilters(), clearValidators(), filterValue(), filterValueRecursive(), getAdminLabel(), getBelongsTo(), getDefaultValue(), getDescriptionHtml(), getEditLabelHtml(), getElementClasses(), getError(), getErrorArray(), getErrorHtml(), getErrors(), getFieldIconsHtml(), getFilter(), getFilters(), getFullyQualifiedName(), getIdentifier(), getInnerClasses(), getInputClasses(), getLabel(), getName(), getSubLabelHtml(), getTooltip(), getUniqueId(), getValidator(), getValidators(), getValueForStorage(), getValueRaw(), hasDefaultValue(), hasError(), hasFilter(), hasFilters(), hasValidator(), hasValidators(), isLogicValueMatch(), isMultiple(), isRequired(), isValid(), removeFilter(), removeValidator(), render(), reset(), setBelongsTo(), setDefaultValue(), setDynamicDefaultValue(), setError(), setIsMultiple(), setValue(), setValueFromStorage(), shouldConvertToHidden()

Methods inherited from Quform_Element
`__construct(), config(), getCss(), getCssSelector(), getForm(), getId(), getTranslation(), hasNonVisibleAncestor(), isConditionallyHidden(), isHidden(), isVisible(), setConditionallyHidden(), setConfig(), setForm(), setHasNonVisibleAncestor(), setId(), setUniqueId()`

Properties summary
`protected array`	`$value`	# `array()`
`protected boolean`	`$isMultiple`	# `true`

Properties inherited from Quform_Element_Multi
`$options`

Properties inherited from Quform_Element_Field
`$belongsTo, $defaultValue, $errors, $filters, $validators`

Properties inherited from Quform_Element
`$config, $form, $hasNonVisibleAncestor, $id, $isConditionallyHidden, $uniqueId`

Classes

Interfaces

Class Quform_Element_Checkbox

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Returns

Overrides

Returns

Overrides

Returns

Overrides

Parameters

Returns

Overrides

Returns

Overrides

Parameters

Returns

Overrides

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Overrides

Parameters

Returns

Returns

Implementation of

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Returns

Parameters

Returns