Docs For Class CheckboxSetField

Description

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.

Located in /sapphire/forms/CheckboxSetField.php (line 10)

Object
   |
   --ViewableData
      |
      --RequestHandlingData
         |
         --FormField
            |
            --DropdownField
               |
               --OptionsetField
                  |
                  --CheckboxSetField

Variable Summary

mixed $disabled

Method Summary

CheckboxSetField __construct ( $name, [ $title = ""], [ $source = array()], [ $value = ""], [ $form = null])

void dataValue ()

void ExtraOptions ()

void Field ()

void performDisabledTransformation ()

void performReadonlyTransformation ()

void saveInto ( $record)

void setDisabled ( $val)

void setValue ( $value, [ $obj = null])

Variables

mixed $disabled = false (line 13)

access: protected

Redefinition of:

OptionsetField::$disabled

Inherited Variables

Inherited from DropdownField

DropdownField::$emptyString
DropdownField::$hasEmptyDefault
DropdownField::$isSelected
DropdownField::$source

Inherited from FormField

FormField::$containerFieldSet
FormField::$description
FormField::$dontEscape
FormField::$extraClass
FormField::$extraClasses
FormField::$form
FormField::$leftTitle
FormField::$message
FormField::$messageType
FormField::$name
FormField::$readonly
FormField::$rightTitle
FormField::$tabIndex
FormField::$title
FormField::$value

Inherited from RequestHandlingData

RequestHandlingData::$allowed_actions
RequestHandlingData::$request
RequestHandlingData::$url_handlers

Inherited from ViewableData

ViewableData::$casting
ViewableData::$castingHelperPair_cache
ViewableData::$customisedObj
ViewableData::$failover
ViewableData::$iteratorPos
ViewableData::$iteratorTotalItems
ViewableData::$namedAs
ViewableData::$parent
ViewableData::$_natural_cache
ViewableData::$_object_cache
ViewableData::$_xml_cache

Inherited from Object

Object::$builtInMethods
Object::$class
Object::$classConstructed
Object::$extensions
Object::$extension_instances
Object::$extraMethods
Object::$extraStatics
Object::$statics
Object::$static_cached

Methods

Constructor __construct (line 15)

CheckboxSetField __construct ( $name, [ $title = ""], [ $source = array()], [ $value = ""], [ $form = null])

$name
$title
$source
$value
$form

Redefinition of:

OptionsetField::__construct(): Creates a new optionset field.

dataValue (line 154)

Return the CheckboxSetField value, as an array of the selected item keys

void dataValue ()

Redefinition of:

FormField::dataValue(): Returns the field value suitable for insertion into the data object

ExtraOptions (line 222)

void ExtraOptions ()

Redefinition of:

OptionsetField::ExtraOptions()

Field (line 26)

Object handles arrays and dosets being passed by reference.

todo: Should use CheckboxField FieldHolder rather than constructing own markup.

void Field ()

Redefinition of:

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

performDisabledTransformation (line 165)

void performDisabledTransformation ()

Redefinition of:

FormField::performDisabledTransformation(): Return a disabled version of this field

performReadonlyTransformation (line 174)

Makes a pretty readonly field

void performReadonlyTransformation ()

Redefinition of:

OptionsetField::performReadonlyTransformation()

saveInto (line 132)

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.

void saveInto ( $record)

DataObject $record: The record to save into

Redefinition of:

FormField::saveInto(): Method to save this form field into the given data object.

setDisabled (line 106)

void setDisabled ( $val)

$val

Redefinition of:

OptionsetField::setDisabled()

setValue (line 113)

Load a value into this CheckboxSetField

void setValue ( $value, [ $obj = null])

$value
$obj

Redefinition of:

FormField::setValue(): Set the field value.

Inherited Methods

Inherited From OptionsetField

OptionsetField::__construct()
OptionsetField::ExtraOptions()
OptionsetField::Field()
OptionsetField::performReadonlyTransformation()
OptionsetField::setDisabled()

Inherited From DropdownField

DropdownField::__construct()
DropdownField::extraClass()
DropdownField::Field()
DropdownField::getEmptyString()
DropdownField::getHasEmptyDefault()
DropdownField::getSource()
DropdownField::isSelected()
DropdownField::performReadonlyTransformation()
DropdownField::setEmptyString()
DropdownField::setHasEmptyDefault()
DropdownField::setSource()

Inherited From FormField

FormField::__construct()
FormField::addExtraClass()
FormField::attrName()
FormField::attrTitle()
FormField::attrValue()
FormField::createTag()
FormField::dataValue()
FormField::debug()
FormField::describe()
FormField::extraClass()
FormField::Field()
FormField::FieldHolder()
FormField::forTemplate()
FormField::getForm()
FormField::getTabIndex()
FormField::getTabIndexHTML()
FormField::hasClass()
FormField::hasData()
FormField::id()
FormField::isComposite()
FormField::isDisabled()
FormField::isReadonly()
FormField::jsValidation()
FormField::LeftTitle()
FormField::Link()
FormField::Message()
FormField::MessageType()
FormField::Name()
FormField::name_to_label()
FormField::performDisabledTransformation()
FormField::performReadonlyTransformation()
FormField::removeExtraClass()
FormField::Required()
FormField::RightTitle()
FormField::rootFieldSet()
FormField::saveInto()
FormField::setContainerFieldSet()
FormField::setDisabled()
FormField::setError()
FormField::setForm()
FormField::setLeftTitle()
FormField::setName()
FormField::setReadonly()
FormField::setRightTitle()
FormField::setTabIndex()
FormField::setTitle()
FormField::setValue()
FormField::SmallFieldHolder()
FormField::Title()
FormField::transform()
FormField::Type()
FormField::validate()
FormField::Value()

Inherited From RequestHandlingData

RequestHandlingData::checkAccessAction()
RequestHandlingData::getRequest()
RequestHandlingData::handleRequest()
RequestHandlingData::httpError()

Inherited From ViewableData

ViewableData::ATT_val()
ViewableData::BaseHref()
ViewableData::buildCastingHelperCache()
ViewableData::cachedCall()
ViewableData::castingHelper()
ViewableData::castingHelperPair()
ViewableData::castingObjectCreator()
ViewableData::castingObjectCreatorPair()
ViewableData::CSSClasses()
ViewableData::CurrentMember()
ViewableData::CurrentPage()
ViewableData::customise()
ViewableData::Debug()
ViewableData::defineMethods()
ViewableData::escapeTypeForField()
ViewableData::Even()
ViewableData::EvenOdd()
ViewableData::First()
ViewableData::FirstLast()
ViewableData::getField()
ViewableData::getIterator()
ViewableData::getXMLValues()
ViewableData::hasField()
ViewableData::HasPerm()
ViewableData::hasValue()
ViewableData::i18nLocale()
ViewableData::IsAjax()
ViewableData::iteratorProperties()
ViewableData::JS_val()
ViewableData::Last()
ViewableData::Me()
ViewableData::Middle()
ViewableData::MiddleString()
ViewableData::obj()
ViewableData::Odd()
ViewableData::Pos()
ViewableData::RAW_val()
ViewableData::renderWith()
ViewableData::SecurityID()
ViewableData::setCustomisedObj()
ViewableData::setField()
ViewableData::SQL_val()
ViewableData::ThemeDir()
ViewableData::Top()
ViewableData::TotalItems()
ViewableData::val()
ViewableData::XML_val()
ViewableData::__get()
ViewableData::__isset()
ViewableData::__set()

Inherited From Object

Object::__construct()
Object::addMethodsFrom()
Object::addStaticVars()
Object::addWrapperMethod()
Object::add_extension()
Object::allMethodNames()
Object::buildMethodList()
Object::cacheToFile()
Object::cacheToFileWithArgs()
Object::create()
Object::createMethod()
Object::defineMethods()
Object::exists()
Object::extend()
Object::extInstance()
Object::getCustomClass()
Object::hasExtension()
Object::hasMethod()
Object::invokeWithExtensions()
Object::is_a()
Object::loadCache()
Object::parentClass()
Object::sanitiseCachename()
Object::saveCache()
Object::set_stat()
Object::set_uninherited()
Object::stat()
Object::strong_create()
Object::uninherited()
Object::useCustomClass()
Object::__call()
Object::__toString()