Docs For Class FieldGroup

Description

Lets you include a nested group of fields inside a template.

This control gives you more flexibility over form layout.

Note: the child fields within a field group aren't rendered using DefaultFieldHolder. Instead, SmallFieldHolder() is called, which just prefixes $Field with a <label> tag, if the Title is set.

Located in /sapphire/forms/FieldGroup.php (line 11)

Object
   |
   --ViewableData
      |
      --RequestHandlingData
         |
         --FormField
            |
            --CompositeField
               |
               --FieldGroup

Direct descendents

Class	Description
HiddenFieldGroup	Lets you include a nested group of fields inside a template.

Variable Summary

mixed $subfieldParam

mixed $zebra

Method Summary

FieldGroup __construct ([ $arg1 = null], [ $arg2 = null])

void Field ()

void FieldHolder ()

void jsValidation ()

void Message ()

void MessageType ()

void Name ()

void php ( $data)

void setID ( $id)

void setZebra ( $zebra)

Variables

mixed $subfieldParam = "SmallFieldHolder" (line 13)

access: public

mixed $zebra (line 12)

access: protected

Inherited Variables

Inherited from CompositeField

CompositeField::$children
CompositeField::$columnCount
CompositeField::$readonly

Inherited from FormField

FormField::$containerFieldSet
FormField::$description
FormField::$disabled
FormField::$dontEscape
FormField::$extraClass
FormField::$extraClasses
FormField::$form
FormField::$leftTitle
FormField::$message
FormField::$messageType
FormField::$name
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)

FieldGroup __construct ([ $arg1 = null], [ $arg2 = null])

$arg1
$arg2

Redefinition of:

CompositeField::__construct()

Field (line 59)

Returns a set of <span class="subfield"> tags, each containing a sub-field.

You can also use <% control FieldSet %>, if you'd like more control over the generated HTML

todo: Shouldn't use SmallFieldHolder() (very difficult to style), it is easier to overwrite the <div class="field"> behaviour in a more specific class

void Field ()

Redefinition of:

CompositeField::Field()

Redefined in descendants as:

HiddenFieldGroup::Field() : Returns a set of <span class="subfield"> tags, each containing a sub-field.

FieldHolder (line 85)

void FieldHolder ()

Redefinition of:

CompositeField::FieldHolder(): Returns the fields nested inside another DIV

Redefined in descendants as:

HiddenFieldGroup::FieldHolder()

jsValidation (line 110)

This allows fields within this fieldgroup to still allow them to get valuated.

void jsValidation ()

Redefinition of:

FormField::jsValidation(): javascript handler Functions for each field type by default formfield doesnt have a validation function

Message (line 89)

void Message ()

Redefinition of:

FormField::Message(): Returns the field message, used by form validation

MessageType (line 97)

void MessageType ()

Redefinition of:

FormField::MessageType(): Returns the field message type, used by form validation

Name (line 36)

Returns the name (ID) for the element.

In some cases the FieldGroup doesn't have a title, but we still want the ID / name to be set. This code, generates the ID from the nested children

void Name ()

Redefinition of:

FormField::Name(): Returns the field name - used by templates.

php (line 122)

void php ( $data)

$data

setID (line 73)

access: public

void setID ( $id)

$id

Redefinition of:

CompositeField::setID()

setZebra (line 80)

Set an odd/even class

void setZebra ( $zebra)

$zebra

Inherited Methods

Inherited From CompositeField

CompositeField::__construct()
CompositeField::collateDataFields()
CompositeField::debug()
CompositeField::Field()
CompositeField::fieldByName()
CompositeField::FieldHolder()
CompositeField::FieldSet()
CompositeField::getChildren()
CompositeField::hasData()
CompositeField::insertBefore()
CompositeField::insertBeforeRecursive()
CompositeField::isComposite()
CompositeField::IsReadonly()
CompositeField::performDisabledTransformation()
CompositeField::performReadonlyTransformation()
CompositeField::push()
CompositeField::removeByName()
CompositeField::replaceField()
CompositeField::rootFieldSet()
CompositeField::setColumnCount()
CompositeField::setForm()
CompositeField::setID()
CompositeField::SmallFieldHolder()
CompositeField::validate()

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()