Webylon 3.1 API Docs
  • Package
  • Class
  • Tree
  • Deprecated
  • Download
Version: current
  • 3.2
  • 3.1

Packages

  • auth
  • Booking
  • cart
    • shipping
    • steppedcheckout
  • Catalog
  • cms
    • assets
    • batchaction
    • batchactions
    • bulkloading
    • comments
    • content
    • core
    • export
    • newsletter
    • publishers
    • reports
    • security
    • tasks
  • Dashboard
  • DataObjectManager
  • event
  • faq
  • forms
    • actions
    • core
    • fields-basic
    • fields-dataless
    • fields-datetime
    • fields-files
    • fields-formatted
    • fields-formattedinput
    • fields-relational
    • fields-structural
    • transformations
    • validators
  • googlesitemaps
  • guestbook
  • installer
  • newsletter
  • None
  • photo
    • gallery
  • PHP
  • polls
  • recaptcha
  • sapphire
    • api
    • bulkloading
    • control
    • core
    • cron
    • dev
    • email
    • fields-formattedinput
    • filesystem
    • formatters
    • forms
    • i18n
    • integration
    • misc
    • model
    • parsers
    • search
    • security
    • tasks
    • testing
    • tools
    • validation
    • view
    • widgets
  • seo
    • open
      • graph
  • sfDateTimePlugin
  • spamprotection
  • stealth
    • captha
  • subsites
  • userform
    • pagetypes
  • userforms
  • webylon
  • widgets

Classes

  • CheckboxField
  • CheckboxField_Disabled
  • CheckboxField_Readonly
  • CheckboxSetField
  • DropdownField
  • GroupedDropdownField
  • ListboxField
  • LookupField
  • NullableField
  • OptionsetField
  • ReadonlyField
  • RoomServiceDropdownField
  • SimpleHTMLEditorField
  • SimpleTinyMCEField
  • SimpleWysiwygField
  • StateDropdownField
  • StateProvinceDropdownField
  • TextareaField
  • TextField

Class CheckboxSetField

Displays a set of checkboxes as a logical group.

ASSUMPTION -> IF you pass your source as an array, you pass values as an array too. Likewise objects are handled the same.

Object
Extended by ViewableData implements IteratorAggregate
Extended by RequestHandler
Extended by FormField
Extended by DropdownField
Extended by OptionsetField
Extended by CheckboxSetField
Package: forms\fields-basic
Located at sapphire/forms/CheckboxSetField.php

Methods summary

public string
# Field( )

Returns

string
HTML tag for this dropdown field

Overrides

OptionsetField::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

OptionsetField::setDisabled
public
# setDefaultItems( Array $items )

Default selections, regardless of the CheckboxSetField::setValue() settings. Note: Items marked as disabled through OptionsetField::setDisabledItems() can still be selected by default through this method.

Default selections, regardless of the CheckboxSetField::setValue() settings. Note: Items marked as disabled through OptionsetField::setDisabledItems() can still be selected by default through this method.

Parameters

$items
Array $items Collection of array keys, as defined in the $source array
public Array
# getDefaultItems( )

Returns

Array
Array
public
# setValue( mixed $value, mixed $obj = null )

Load a value into this CheckboxSetField

Load a value into this CheckboxSetField

Overrides

FormField::setValue
public
# saveInto( DataObject $record )

Save the current value of this CheckboxSetField into a DataObject. If the field it is saving to is a has_many or many_many relationship, it is saved by setByIDList(), otherwise it creates a comma separated list for a standard DB text/varchar field.

Save the current value of this CheckboxSetField into a DataObject. If the field it is saving to is a has_many or many_many relationship, it is saved by setByIDList(), otherwise it creates a comma separated list for a standard DB text/varchar field.

Parameters

$record
DataObject $record The record to save into

Overrides

FormField::saveInto
public string
# dataValue( )

Return the CheckboxSetField value as an array selected item keys.

Return the CheckboxSetField value as an array selected item keys.

Returns

string
string

Overrides

FormField::dataValue
public
# performDisabledTransformation( )

Return a disabled version of this field

Return a disabled version of this field

Overrides

FormField::performDisabledTransformation
public ReadonlyField
# performReadonlyTransformation( )

Transforms the source data for this CheckboxSetField into a comma separated list of values.

Transforms the source data for this CheckboxSetField into a comma separated list of values.

Returns

ReadonlyField
ReadonlyField

Overrides

OptionsetField::performReadonlyTransformation
public
# ExtraOptions( )

Overrides

OptionsetField::ExtraOptions

Methods inherited from OptionsetField

__construct(), getDisabledItems(), setDisabledItems()

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(), debug(), describe(), forTemplate(), getCustomValidationMessage(), getForm(), getTabIndex(), getTabIndexHTML(), hasClass(), hasData(), id(), isComposite(), isDisabled(), isReadonly(), jsValidation(), name_to_label(), removeExtraAttribute(), removeExtraClass(), rootFieldSet(), securityTokenEnabled(), setAutocomplete(), setContainerFieldSet(), setCustomValidationMessage(), setError(), setForm(), setHTML5Attribute(), setLeftTitle(), setName(), setReadonly(), setRightTitle(), setTabIndex(), setTitle(), 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 boolean $disabled
#

$disabled

$disabled

protected Array $defaultItems
#

Properties inherited from OptionsetField

$disabledItems

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. -
Webylon 3.1 API Docs API documentation generated by ApiGen 2.8.0