InputfieldToggle class

A toggle providing similar input capability to a checkbox but much more configurable.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the InputfieldToggle class also inherits all the methods and properties of: Inputfield, WireData and Wire.

Common

Name	Return	Summary
InputfieldToggle::addOption() InputfieldToggle::addOption($value) InputfieldToggle::addOption($value, $label = null)	`$this`	Add a selectable option (custom API usage only, overrides built-in options)
InputfieldToggle::defaultOption	`string`	Default selected value of 'no', 'yes', 'other' or 'none' (default='none')
InputfieldToggle::formatLabel() InputfieldToggle::formatLabel(string $label) InputfieldToggle::formatLabel(string $label, bool $allowIcon = true)	`string`	Format label for HTML output (entity encode, etc.)
InputfieldToggle::getAllLabels() InputfieldToggle::getAllLabels() InputfieldToggle::getAllLabels()	`array`	Get all possible labels for all label types and all languages
InputfieldToggle::getConfigAllowContext() InputfieldToggle::getConfigAllowContext(Field $field) InputfieldToggle::getConfigAllowContext(Field $field)	`array`	Return a list of config property names allowed for fieldgroup/template context
InputfieldToggle::getConfigInputfields() InputfieldToggle::getConfigInputfields() InputfieldToggle::getConfigInputfields()	`InputfieldWrapper`	Configure Inputfield
InputfieldToggle::getInputfield() InputfieldToggle::getInputfield() InputfieldToggle::getInputfield()	`mixed`	Get the delegated Inputfield that will be used for rendering selectable options
InputfieldToggle::getLabels() InputfieldToggle::getLabels() InputfieldToggle::getLabels(int $labelType = null, $language = null)	`array`	Get labels for the given label type
InputfieldToggle::getOptions() InputfieldToggle::getOptions() InputfieldToggle::getOptions()	`array`	Get all selectable options as array of [ value => label ]
InputfieldToggle::getValueLabel() InputfieldToggle::getValueLabel() InputfieldToggle::getValueLabel($value = null, $labelType = null, $language = null)	`string`	Get the label for the currently set (or given) value
InputfieldToggle::inputfieldClass	`string`	Inputfield class to use or blank for this toggle buttons (default='')
InputfieldToggle::isEmpty() InputfieldToggle::isEmpty() InputfieldToggle::isEmpty()	`bool`	Is the current value empty? (i.e. no selection)
InputfieldToggle::labelType	`int`	Label type to use, see the labelType constants (default=labelTypeYes)
InputfieldToggle::noLabel	`string`	Custom no/off label
InputfieldToggle::otherLabel	`string`	Custom label for optional other value Label to use for "other" option
InputfieldToggle::processInput() InputfieldToggle::processInput(WireInputData $input) InputfieldToggle::processInput(WireInputData $input)	`$this`	Process input
InputfieldToggle::render() InputfieldToggle::render() InputfieldToggle::render()	`string`	Render input element(s)
InputfieldToggle::renderReady() InputfieldToggle::renderReady() InputfieldToggle::renderReady($parent = null, bool $renderValueMode = false)	`bool`	Render ready
InputfieldToggle::renderValue() InputfieldToggle::renderValue() InputfieldToggle::renderValue()	`string`	Render value
InputfieldToggle::sanitizeValue() InputfieldToggle::sanitizeValue($value) InputfieldToggle::sanitizeValue($value, bool $getName = false)	`int` `string`	Sanitize the value to be one ofthe constants: valueYes, valueNo, valueOther, valueUnknown
InputfieldToggle::setAttribute() InputfieldToggle::setAttribute($key, $value) InputfieldToggle::setAttribute($key, $value)	`Inputfield`	Set attribute
InputfieldToggle::setOptions() InputfieldToggle::setOptions(array $options) InputfieldToggle::setOptions(array $options)	`$this`	Set all options with array of [ value => label ] (custom API usage only, overrides built-in options)
InputfieldToggle::useDeselect	`bool` `int`	Allow radios or toggles to be de-selected, enabling possibility of no-selection? (default=false)
InputfieldToggle::useOther	`int` `bool`	Use the "other" option? (default=false)
InputfieldToggle::useReverse	`int` `bool`	Reverse the order of the Yes/No options? (default=false)
InputfieldToggle::useVertical	`bool` `int`	Use vertically oriented radio buttons? Applies only if $inputfieldClass is 'InputfieldRadios' (default=false)
InputfieldToggle::value	`int` `string`	Integer value when selection is made or blank string when no selection (0=No, 1=Yes, 2=Other, ''=Unknown)
InputfieldToggle::valueType	`int`	Type of value for methods that ask for it (use one of the valueType constants)
InputfieldToggle::wired() InputfieldToggle::wired() InputfieldToggle::wired()	(nothing)
InputfieldToggle::yesLabel	`string`	Custom yes/on label

Additional methods and properties

In addition to the methods and properties above, InputfieldToggle also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.236

A toggle providing similar input capability to a checkbox but much more configurable.

Common

Additional methods and properties

Newest forum posts

Latest news

Subscribe to weekly ProcessWire news