Docs For Class DB_DataObject_FormBuilder

$clientRules =

[line 81]

Type:

mixed

[ Top ]

$dateElementFormat =

[line 76]

Type:

mixed

[ Top ]

$dateFieldLanguage =

[line 77]

Type:

mixed

[ Top ]

$dateOptionsCallback =

[line 82]

Type:

mixed

[ Top ]

$dateTimeElementFormat =

[line 79]

Type:

mixed

[ Top ]

$dateTimeOptionsCallback =

[line 84]

Type:

mixed

[ Top ]

$elementNamePostfix =

[line 75]

Type:

mixed

[ Top ]

$elementNamePrefix =

[line 74]

Type:

mixed

[ Top ]

$elementTypeAttributes = array()

[line 58]

Array of attributes for each element type. See the keys of elementTypeMap for the allowed element types.

The key is the element type. The value can be a valid attribute string or an associative array of attributes.

Type:

mixed

[ Top ]

$elementTypeMap = array('shorttext' => 'text',
                                'longtext'  => 'textarea',
                                'date'      => 'date',
                                'time'      => 'date',
                                'datetime'  => 'date',
                                'integer'   => 'text',
                                'float'     => 'text',
                                'select'    => 'select',
                                'multiselect'  => 'select',
                                'subForm'      => 'subFormFB',
                                'elementGrid' => 'elementGrid')

[line 39]

Array to determine what QuickForm element types are being used for which

general field types. If you configure FormBuilder using arrays, the format is: array('nameOfFieldType' => 'QuickForm_Element_name', ...); If configured via .ini file, the format looks like this: elementTypeMap = shorttext:text,date:date,...

Allowed field types:

shorttext
longtext</
date
integer
float

Type:

mixed

[ Top ]

$fieldAttributes = array()

[line 66]

Array of attributes for each specific field.

The key is the field name. The value can be a valid attribute string or an associative array of attributes.

Type:

mixed

[ Top ]

$formHeaderText =

[line 71]

The following member variables are set to force copying from the FormBuilder object

Type:

mixed

[ Top ]

$linkNewValue =

[line 72]

Type:

mixed

[ Top ]

$linkNewValueText =

[line 73]

Type:

mixed

[ Top ]

$requiredRuleMessage =

[line 80]

Type:

mixed

[ Top ]

$timeElementFormat =

[line 78]

Type:

mixed

[ Top ]

$timeOptionsCallback =

[line 83]

Type:

mixed

[ Top ]

DB_DataObject_FormBuilder_QuickForm (Constructor) [line 109]

DB_DataObject_FormBuilder_QuickForm DB_DataObject_FormBuilder_QuickForm(

&$fb, DB_DataObject_FormBuilder
$fb)

DB_DataObject_FormBuilder_QuickForm::DB_DataObject_FormBuilder_QuickForm()

The class constructor.

Access: public

Parameters:

DB_DataObject_FormBuilder	`$fb`	—	the FormBuilder object this driver is attached to
	`&$fb`	—

[ Top ]

getForm [line 884]

void &getForm(
)

Returns the HTML_QuickForm object that has been created

[ Top ]

populateOptions [line 117]

void populateOptions(
)

Populate options from the main formbuilder class

[ Top ]

useForm [line 139]

boolean useForm(
$form
&$form, [$append
$append = false])

DB_DataObject_FormBuilder::useForm()

Sometimes, it might come in handy not just to create a new QuickForm object, but to work with an existing one. Using FormBuilder together with HTML_QuickForm_Controller or HTML_QuickForm_Page is such an example ;-) If you do not call this method before the form is generated, a new QuickForm object will be created (default behaviour).

Return: Returns false if the passed object was not a HTML_QuickForm object or a QuickForm object was already created
Access: public

Parameters:

$form	`&$form`	—	object A HTML_QuickForm object (or extended from that)
$append	`$append`	—	boolean If TRUE, the form will be appended to the one generated by FormBuilder. If false, FormBuilder will just add its own elements to this form.

[ Top ]

validateLinkNewValues [line 494]

mixed validateLinkNewValues(
Array
$values)

Loops through linkNewValue forms and makes sure that the submitted values are valid

Return: true if everything is valid, else an array with QF rule messages

Parameters:

Array $values — the array of posted values

[ Top ]

_addElement [line 599]

void _addElement(

&$element, object
$element)

DB_DataObject_FormBuilder_QuickForm::_addElement()

Adds a QuickForm element to a form object Used in _generateForm().

See: DB_DataObject_FormBuilder::_generateForm()
Access: protected

Parameters:

object	`$element`	—	The element object to be added
	`&$element`	—

[ Top ]

_addElementGroup [line 580]

void _addElementGroup(

&$element, string
$fieldName, [string
$separator = ''], array
$element)

DB_DataObject_FormBuilder_QuickForm::_addElementGroup()

Adds a group of elements to a form object Used in _generateForm().

See: DB_DataObject_FormBuilder::_generateForm()
Access: protected

Parameters:

array	`$element`	—	Array of QuickForm element objects
string	`$fieldName`	—	The field name to use for the QuickForm element group
string	`$separator`	—	Some text or HTML snippet used to separate the group entries
	`&$element`	—

[ Top ]

_addFieldRules [line 797]

void _addFieldRules(
array
$rules, string
$fieldName)

DB_DataObject_FormBuilder_QuickForm::_addFieldRules()

Adds a set of rules to a form that will apply to a specific element Used in _generateForm().

See: DB_DataObject_FormBuilder::_generateForm()
Access: protected

Parameters:

array	`$rules`	—	Array of rule names to be enforced on the element (must be registered QuickForm rules)
string	`$fieldName`	—	Name of the form element in question

[ Top ]

_addFormHeader [line 247]

void _addFormHeader(
string
$text)

DB_DataObject_FormBuilder_QuickForm::_addFormHeader()

Adds a header to the given form. Will use the header defined in the "formHeaderText" property. Used in _generateForm().

See: DB_DataObject_FormBuilder::_generateForm()
Access: protected

Parameters:

string $text — THe text for the header

[ Top ]

_createCheckbox [line 315]

object The &_createCheckbox(
string
$fieldName, [string
$text = null], [string
$value = null], [
$label = null], [boolean
$checked = false], [boolean
$freeze = false])

DB_DataObject_FormBuilder_QuickForm::_createCheckbox()

Returns a QuickForm element for a checkbox. Used in _generateForm().

Return: HTML_QuickForm_element object.
See: DB_DataObject_FormBuilder::_generateForm()
Access: protected

Parameters:

string	`$fieldName`	—	The field name to use for the QuickForm element
string	`$text`	—	Text to label the checkbox
string	`$value`	—	The value that is submitted when the checkbox is checked
boolean	`$checked`	—	Is the checkbox checked? (Default: False)
boolean	`$freeze`	—	Is the checkbox frozen? (Default: False)
	`$label`	—

[ Top ]

_createDateElement [line 647]

object The &_createDateElement(
string
$fieldName)

DB_DataObject_FormBuilder_QuickForm::_createDateElement()

Returns a QuickForm element for entering date values. Used in _generateForm().

Return: HTML_QuickForm_element object.
See: DB_DataObject_FormBuilder::_generateForm()
Access: protected

Parameters:

string $fieldName — The field name to use for the element

[ Top ]

_createDateTimeElement [line 713]

object The &_createDateTimeElement(
string
$fieldName)

DB_DataObject_FormBuilder_QuickForm::_createDateTimeElement()

Returns a QuickForm element for entering date values. Used in _generateForm().

Return: HTML_QuickForm_element object.
See: DB_DataObject_FormBuilder::_generateForm()
Access: protected

Parameters:

string $fieldName — The field name to use for the element

[ Top ]

_createFormObject [line 219]

object The _createFormObject(
string
$formName, string
$method, string
$action, string
$target)

DB_DataObject_FormBuilder_QuickForm::_createFormObject()

Creates a QuickForm object to be used by _generateForm().

Return: HTML_QuickForm object.
See: DB_DataObject_FormBuilder::_generateForm()
Access: protected

Parameters:

string	`$formName`	—	The name of the form
string	`$method`	—	Method for transferring form data over HTTP (GET\|POST)
string	`$action`	—	The script to transfer the form data to
string	`$target`	—	Name of the target frame/window to use to display the "action" script

[ Top ]

_createHiddenField [line 262]

void &_createHiddenField(
string
$fieldName)

DB_DataObject_FormBuilder_QuickForm::_createHiddenField()

Returns a QuickForm element for a hidden field. Used in _generateForm().

See: DB_DataObject_FormBuilder::_generateForm()
Access: protected

Parameters:

string $fieldName — The field name to use for the QuickForm element

[ Top ]

_createIntegerField [line 367]

object The &_createIntegerField(
string
$fieldName)

DB_DataObject_FormBuilder_QuickForm::_createIntegerField()

Returns a QuickForm element for an integer field. Used in _generateForm().

Return: HTML_QuickForm_element object.
See: DB_DataObject_FormBuilder::_generateForm()
Access: protected

Parameters:

string $fieldName — The field name to use for the QuickForm element

[ Top ]

_createRadioButtons [line 283]

array &_createRadioButtons(
string
$fieldName, array
$options)

DB_DataObject_FormBuilder_QuickForm::_createRadioButtons()

Returns a QuickForm element for a group of radio buttons. Used in _generateForm().

Return: Array of HTML_QuickForm_element objects.
See: DB_DataObject_FormBuilder::_generateForm()
Access: protected

Parameters:

string	`$fieldName`	—	The field name to use for the QuickForm element group
array	`$options`	—	The list of options to generate the radio buttons for

[ Top ]

_createSelectBox [line 411]

object The &_createSelectBox(
string
$fieldName, array
$options, [boolean
$multiple = false])

DB_DataObject_FormBuilder_QuickForm::_createSelectBox()

Returns a QuickForm element for a selectbox/combobox. Used in _generateForm().

Return: HTML_QuickForm_element object.
See: DB_DataObject_FormBuilder::_generateForm()
Access: protected

Parameters:

string	`$fieldName`	—	The field name to use for the QuickForm element
array	`$options`	—	List of options for populating the selectbox
boolean	`$multiple`	—	If set to true, the select box will be a multi-select

[ Top ]

_createStaticField [line 557]

object The &_createStaticField(
string
$fieldName, [string
$text = null])

DB_DataObject_FormBuilder_QuickForm::_createStaticField()

Returns a QuickForm element for displaying static HTML. Used in _generateForm().

Return: HTML_QuickForm_element object.
See: DB_DataObject_FormBuilder::_generateForm()
Access: protected

Parameters:

string	`$fieldName`	—	The field name to use for the QuickForm element
string	`$text`	—	The text or HTML code to display in place of this element

[ Top ]

_createSubmitButton [line 628]

object The &_createSubmitButton(
string
$fieldName, string
$text)

DB_DataObject_FormBuilder_QuickForm::_createSubmitButton()

Returns a QuickForm element for a submit button. Used in _generateForm().

Return: HTML_QuickForm_element object.
See: DB_DataObject_FormBuilder::_generateForm()
Access: protected

Parameters:

string	`$fieldName`	—	the name of the submit button
string	`$text`	—	the text to put in the button

[ Top ]

_createTextArea [line 388]

object The &_createTextArea(
string
$fieldName)

DB_DataObject_FormBuilder_QuickForm::_createTextArea()

Returns a QuickForm element for a long text field. Used in _generateForm().

Return: HTML_QuickForm_element object.
See: DB_DataObject_FormBuilder::_generateForm()
Access: protected

Parameters:

string $fieldName — The field name to use for the QuickForm element

[ Top ]

_createTextField [line 346]

object The &_createTextField(
string
$fieldName)

DB_DataObject_FormBuilder_QuickForm::_createTextField()

Returns a QuickForm element for a single-line text field. Used in _generateForm().

Return: HTML_QuickForm_element object.
See: DB_DataObject_FormBuilder::_generateForm()
Access: protected

Parameters:

string $fieldName — The field name to use for the QuickForm element

[ Top ]

_createTimeElement [line 681]

object The &_createTimeElement(
string
$fieldName)

DB_DataObject_FormBuilder_QuickForm::_createTimeElement()

Returns a QuickForm element for entering time values. Used in _generateForm(). Note by Frank: The only reason for this is the difference in timeoptions so it probably would be better integrated with _createDateElement

Return: HTML_QuickForm_element object.
See: DB_DataObject_FormBuilder::_generateForm()
Access: protected

Parameters:

string $fieldName — The field name to use for the element

[ Top ]

_freezeFormElements [line 836]

void _freezeFormElements(

$elementsToFreeze, array
$elements_to_freeze)

DB_DataObject_FormBuilder_QuickForm::_freezeFormElements()

Freezes a list of form elements (set read-only). Used in _generateForm().

See: DB_DataObject_FormBuilder::_generateForm()
Access: protected

Parameters:

array	`$elements_to_freeze`	—	List of element names to be frozen
	`$elementsToFreeze`	—

[ Top ]

_getQFType [line 163]

string _getQFType(
string
$fieldType)

DB_DataObject_FormBuilder_QuickForm::_getQFType()

Returns the QuickForm element type associated with the given field type, as defined in the elementTypeMap property. If an unknown field type is given, the returned type name will default to 'text'.

Return: The QuickForm element type name
Access: protected

Parameters:

string $fieldType — The internal field type

[ Top ]

_setFormElementRequired [line 778]

void _setFormElementRequired(
object
$fieldName)

DB_DataObject_FormBuilder_QuickForm::_setFormElementRequired()

Adds a required rule for a specific element to a form Used in _generateForm().

See: DB_DataObject_FormBuilder::_generateForm()
Access: protected

Parameters:

object $fieldName — The name of the required field

[ Top ]

Class: DB_DataObject_FormBuilder_QuickForm

Class Overview

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$clientRules =

$dateElementFormat =

$dateFieldLanguage =

$dateOptionsCallback =

$dateTimeElementFormat =

$dateTimeOptionsCallback =

$elementNamePostfix =

$elementNamePrefix =

$elementTypeAttributes = array()

$elementTypeMap = array('shorttext' => 'text', 'longtext' => 'textarea', 'date' => 'date', 'time' => 'date', 'datetime' => 'date', 'integer' => 'text', 'float' => 'text', 'select' => 'select', 'multiselect' => 'select', 'subForm' => 'subFormFB', 'elementGrid' => 'elementGrid')

$fieldAttributes = array()

$formHeaderText =

$linkNewValue =

$linkNewValueText =

$requiredRuleMessage =

$timeElementFormat =

$timeOptionsCallback =

Method Detail

DB_DataObject_FormBuilder_QuickForm (Constructor) [line 109]

Parameters:

getForm [line 884]

populateOptions [line 117]

useForm [line 139]

Parameters:

validateLinkNewValues [line 494]

Parameters:

_addElement [line 599]

Parameters:

_addElementGroup [line 580]

Parameters:

_addFieldRules [line 797]

Parameters:

_addFormHeader [line 247]

Parameters:

_createCheckbox [line 315]

Parameters:

_createDateElement [line 647]

Parameters:

_createDateTimeElement [line 713]

Parameters:

_createFormObject [line 219]

Parameters:

_createHiddenField [line 262]

Parameters:

_createIntegerField [line 367]

Parameters:

_createRadioButtons [line 283]

Parameters:

_createSelectBox [line 411]

Parameters:

_createStaticField [line 557]

Parameters:

_createSubmitButton [line 628]

Parameters:

_createTextArea [line 388]

Parameters:

_createTextField [line 346]

Parameters:

_createTimeElement [line 681]

Parameters:

_freezeFormElements [line 836]

Parameters:

_getQFType [line 163]

Parameters:

_setFormElementRequired [line 778]

Parameters:

$elementTypeMap = array('shorttext' => 'text',
'longtext' => 'textarea',
'date' => 'date',
'time' => 'date',
'datetime' => 'date',
'integer' => 'text',
'float' => 'text',
'select' => 'select',
'multiselect' => 'select',
'subForm' => 'subFormFB',
'elementGrid' => 'elementGrid')