Class OptionsetField

Set of radio buttons designed to emulate a dropdown. It even uses the same constructor as a dropdown field.

Object

Extended by

ViewableData implements IteratorAggregate

Extended by

RequestHandler

Extended by

FormField

Extended by

DropdownField

Extended by

OptionsetField

Direct known subclasses

CheckboxSetField

Package: forms\fields-basic
Located at sapphire/forms/OptionsetField.php

Methods summary

`public`	# `__construct( FormField::$name $name, FormField::$title $title = "", DropdownField::$source $source = array(), FormField::$value $value = "", FormField::$form $form = null )` Creates a new optionset field. Creates a new optionset field. Parameters `$name` name The field name `$title` title The field title `$source` source An map of the dropdown items `$value` value The current value `$form` form The parent form Overrides `DropdownField::__construct`
`public string`	# `Field( )` Create a UL tag containing sets of radio buttons and labels. The IDs are set to FieldID_ItemKey, where ItemKey is the key with all non-alphanumerics removed. Create a UL tag containing sets of radio buttons and labels. The IDs are set to FieldID_ItemKey, where ItemKey is the key with all non-alphanumerics removed. Returns `string` HTML tag for this dropdown field Overrides `DropdownField::Field`
`public`	# `setDisabled( mixed $val )` Sets disabed-flag on form-field. Please use performDisabledTransformation() to actually transform this instance. Sets disabed-flag on form-field. Please use performDisabledTransformation() to actually transform this instance. Parameters `$val` $bool boolean Setting "false" has no effect on the field-state. Overrides `FormField::setDisabled`
`public`	# `performReadonlyTransformation( )` Returns a readonly version of this field Returns a readonly version of this field Overrides `DropdownField::performReadonlyTransformation`
`public`	# `setDisabledItems( array $items )` Mark certain elements as disabled, regardless of the `OptionsetField::setDisabled()` settings. Mark certain elements as disabled, regardless of the `OptionsetField::setDisabled()` settings. Parameters `$items` array $items Collection of array keys, as defined in the $source array
`public Array`	# `getDisabledItems( )` Returns `Array` Array
`public`	# `ExtraOptions( )`

Methods inherited from DropdownField

extraClass(), getEmptyString(), getHasEmptyDefault(), getSource(), isSelected(), setEmptyString(), setHasEmptyDefault(), setSource()

Methods inherited from FormField

FieldHolder(), LeftTitle(), Link(), Message(), MessageType(), Name(), Required(), RightTitle(), SmallFieldHolder(), Title(), Type(), Value(), addExtraAttribute(), addExtraClass(), allowHTML5(), allow_html5(), attrName(), attrTitle(), attrValue(), createTag(), dataValue(), debug(), describe(), forTemplate(), getCustomValidationMessage(), getForm(), getTabIndex(), getTabIndexHTML(), hasClass(), hasData(), id(), isComposite(), isDisabled(), isReadonly(), jsValidation(), name_to_label(), performDisabledTransformation(), removeExtraAttribute(), removeExtraClass(), rootFieldSet(), saveInto(), securityTokenEnabled(), setAutocomplete(), setContainerFieldSet(), setCustomValidationMessage(), setError(), setForm(), setHTML5Attribute(), setLeftTitle(), setName(), setReadonly(), setRightTitle(), setTabIndex(), setTitle(), setValue(), transform(), useHTML5(), use_html5(), validate()

Methods inherited from RequestHandler

allowedActions(), checkAccessAction(), getRequest(), handleRequest(), hasAction(), httpError()

Methods inherited from ViewableData

ATT_val(), BaseHref(), CSSClasses(), ColumnBreak(), ColumnCalc(), ColumnNumber(), ColumnPad(), ColumnPos(), CurrentMember(), CurrentPage(), Debug(), Even(), EvenOdd(), First(), FirstLast(), HasPerm(), IsAjax(), JS_val(), Last(), Me(), Middle(), MiddleString(), Modulus(), MultipleOf(), Odd(), Pos(), RAW_val(), SQL_val(), ThemeDir(), ThemeName(), Top(), TotalItems(), XML_val(), __get(), __isset(), __set(), buildCastingCache(), cachedCall(), castingClass(), castingHelper(), castingHelperPair(), castingObjectCreator(), castingObjectCreatorPair(), customise(), defineMethods(), escapeTypeForField(), getField(), getIterator(), getSecurityID(), getXMLValues(), hasField(), hasValue(), i18nLocale(), iteratorProperties(), obj(), renderWith(), setCustomisedObj(), setField()

Methods inherited from Object

__call(), __toString(), __wakeup(), addMethodsFrom(), addStaticVars(), addWrapperMethod(), add_extension(), add_static_var(), allMethodNames(), cacheToFile(), cacheToFileWithArgs(), clearCache(), combined_static(), create(), createMethod(), create_from_string(), exists(), extInstance(), extend(), getCustomClass(), getExtensionInstance(), getExtensionInstances(), get_extensions(), get_static(), hasExtension(), hasMethod(), has_extension(), invokeWithExtensions(), is_a(), loadCache(), parentClass(), parse_class_spec(), remove_extension(), sanitiseCachename(), saveCache(), set_stat(), set_static(), set_uninherited(), stat(), strong_create(), uninherited(), uninherited_static(), useCustomClass()

Magic methods summary

Properties summary

`protected Array`	`$disabledItems`	#
`protected boolean`	`$disabled`	# $disabled $disabled

Properties inherited from DropdownField

$emptyString, $hasEmptyDefault, $isSelected, $source

Properties inherited from FormField

$autocomplete, $containerFieldSet, $customValidationMessage, $description, $dontEscape, $extraAttributes, $extraClass, $extraClasses, $fieldHTML5, $form, $html5Attributes, $leftTitle, $message, $messageType, $name, $possible_autocomplete_values, $readonly, $rightTitle, $tabIndex, $title, $use_html5, $value

Properties inherited from RequestHandler

$allowed_actions, $brokenOnConstruct, $request, $url_handlers

Properties inherited from ViewableData

$casting, $customisedObject, $default_cast, $failover, $iteratorPos, $iteratorTotalItems

Properties inherited from Object

$class, $extension_instances, $extensions

[Raise a SilverStripe Framework issue/bug](https://github.com/silverstripe/silverstripe-framework/issues/new)
- [Raise a SilverStripe CMS issue/bug](https://github.com/silverstripe/silverstripe-cms/issues/new)
- Please use the Silverstripe Forums to ask development related questions. -