SilverStripe 2.4 API Docs
  • Package
  • Class
  • Tree
  • Deprecated
Version: master
  • master
  • 3.1
  • 3.0
  • 2.4
  • tagfield

Packages

  • cms
    • assets
    • batchaction
    • batchactions
    • bulkloading
    • comments
    • content
    • core
    • export
    • publishers
    • reports
    • security
    • tasks
  • forms
    • actions
    • core
    • fields-basic
    • fields-dataless
    • fields-datetime
    • fields-files
    • fields-formatted
    • fields-formattedinput
    • fields-relational
    • fields-structural
    • transformations
    • validators
  • installer
  • None
  • PHP
  • 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

Classes

  • CheckboxField
  • CheckboxField_Disabled
  • CheckboxField_Readonly
  • CheckboxSetField
  • DropdownField
  • GroupedDropdownField
  • ListboxField
  • LookupField
  • NullableField
  • OptionsetField
  • ReadonlyField
  • 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.

Example: <code php> new CheckboxSetField( $name = "topics", $title = "I am interested in the following topics", $source = array( "1" => "Technology", "2" => "Gardening", "3" => "Cooking", "4" => "Sports" ), $value = "1" ) </code>

Saving The checkbox set field will save its data in one of ways: * If the field name matches a many-many join on the object being edited, that many-many join will be updated to link to the objects selected on the checkboxes. In this case, the keys of your value map should be the IDs of the database records. * If the field name matches a database field, a comma-separated list of values will be saved to that field. The keys can be text or numbers.

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 )

Set form being disabled

Set form being disabled

Parameters

$val
mixed
$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
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 a string selected item keys.

Return the CheckboxSetField value as a string selected item keys.

Returns

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

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(), addExtraClass(), attrName(), attrTitle(), attrValue(), createTag(), debug(), describe(), forTemplate(), getCustomValidationMessage(), getForm(), getTabIndex(), getTabIndexHTML(), hasClass(), hasData(), id(), isComposite(), isDisabled(), isReadonly(), jsValidation(), name_to_label(), removeExtraClass(), rootFieldSet(), securityTokenEnabled(), setContainerFieldSet(), setCustomValidationMessage(), setError(), setForm(), setLeftTitle(), setName(), setReadonly(), setRightTitle(), setTabIndex(), setTitle(), transform(), validate()

Methods inherited from RequestHandler

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

Methods inherited from ViewableData

ATT_val(), BaseHref(), CSSClasses(), CurrentMember(), CurrentPage(), Debug(), Even(), EvenOdd(), First(), FirstLast(), HasPerm(), IsAjax(), JS_val(), Last(), Me(), Middle(), MiddleString(), Modulus(), MultipleOf(), Odd(), Pos(), RAW_val(), SQL_val(), ThemeDir(), 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(), 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

$containerFieldSet, $customValidationMessage, $description, $dontEscape, $extraClass, $extraClasses, $form, $leftTitle, $message, $messageType, $name, $readonly, $rightTitle, $tabIndex, $title, $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

Comments

Comment policy: Please use comments for tips and corrections about the described functionality. Comments are moderated, we reserve the right to remove comments that are inappropriate or are no longer relevant.
Use the Silverstripe Forum to ask questions.
blog comments powered by Disqus
SilverStripe 2.4 API Docs API documentation generated by ApiGen 2.8.0