Element index for package apidoc

[ a ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ l ] [ p ] [ r ] [ s ] [ t ] [ u ] [ v ] [ _ ]

_

$_appendForm: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$_appendForm
If false, FormBuilder will use the form object from $_form as a basis for the new form: It will just add elements to the existing form object, not generate a new one.
$_form: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$_form
If you want to use the generator on an existing form object, pass it to the factory method within the options array, element name: 'form' (who would have guessed?)
$_queryType: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$_queryType
Used to determine which action to perform with the submitted data in processForm()
$_validationErrors: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$_validationErrors
Contains the last validation errors, if validation checking is enabled.
_addElementGroupToForm: in file QuickForm.php, method DB_DataObject_FormBuilder_QuickForm::_addElementGroupToForm()
DB_DataObject_FormBuilder_QuickForm::_addElementGroupToForm()
_addElementToForm: in file QuickForm.php, method DB_DataObject_FormBuilder_QuickForm::_addElementToForm()
DB_DataObject_FormBuilder_QuickForm::_addElementToForm()
_addFieldRulesToForm: in file QuickForm.php, method DB_DataObject_FormBuilder_QuickForm::_addFieldRulesToForm()
DB_DataObject_FormBuilder_QuickForm::_addFieldRulesToForm()
_addFormHeader: in file QuickForm.php, method DB_DataObject_FormBuilder_QuickForm::_addFormHeader()
DB_DataObject_FormBuilder_QuickForm::_addFormHeader()
_array2date: in file FormBuilder.php, method DB_DataObject_FormBuilder::_array2date()
DB_DataObject_FormBuilder::_array2date()
_createCheckbox: in file QuickForm.php, method DB_DataObject_FormBuilder_QuickForm::_createCheckbox()
DB_DataObject_FormBuilder_QuickForm::_createCheckbox()
_createDateElement: in file QuickForm.php, method DB_DataObject_FormBuilder_QuickForm::_createDateElement()
DB_DataObject_FormBuilder_QuickForm::_createDateElement()
_createFormObject: in file QuickForm.php, method DB_DataObject_FormBuilder_QuickForm::_createFormObject()
DB_DataObject_FormBuilder_QuickForm::_createFormObject()
_createGroup: in file QuickForm.php, method DB_DataObject_FormBuilder_QuickForm::_createGroup()
DB_DataObject_FormBuilder_QuickForm::_createGroup()
_createHiddenField: in file QuickForm.php, method DB_DataObject_FormBuilder_QuickForm::_createHiddenField()
DB_DataObject_FormBuilder_QuickForm::_createHiddenField()
_createIntegerField: in file QuickForm.php, method DB_DataObject_FormBuilder_QuickForm::_createIntegerField()
DB_DataObject_FormBuilder_QuickForm::_createIntegerField()
_createRadioButtons: in file QuickForm.php, method DB_DataObject_FormBuilder_QuickForm::_createRadioButtons()
DB_DataObject_FormBuilder_QuickForm::_createRadioButtons()
_createSelectBox: in file QuickForm.php, method DB_DataObject_FormBuilder_QuickForm::_createSelectBox()
DB_DataObject_FormBuilder_QuickForm::_createSelectBox()
_createStaticField: in file QuickForm.php, method DB_DataObject_FormBuilder_QuickForm::_createStaticField()
DB_DataObject_FormBuilder_QuickForm::_createStaticField()
_createSubmitButton: in file QuickForm.php, method DB_DataObject_FormBuilder_QuickForm::_createSubmitButton()
DB_DataObject_FormBuilder_QuickForm::_createSubmitButton()
_createTextArea: in file QuickForm.php, method DB_DataObject_FormBuilder_QuickForm::_createTextArea()
DB_DataObject_FormBuilder_QuickForm::_createTextArea()
_createTextField: in file QuickForm.php, method DB_DataObject_FormBuilder_QuickForm::_createTextField()
DB_DataObject_FormBuilder_QuickForm::_createTextField()
_createTimeElement: in file QuickForm.php, method DB_DataObject_FormBuilder_QuickForm::_createTimeElement()
DB_DataObject_FormBuilder_QuickForm::_createTimeElement()
_date2array: in file FormBuilder.php, method DB_DataObject_FormBuilder::_date2array()
DB_DataObject_FormBuilder::_date2array()
_explodeArrString: in file FormBuilder.php, method DB_DataObject_FormBuilder::_explodeArrString()
DB_DataObject_FormBuilder::_exlplodeArrString()
_freezeFormElements: in file QuickForm.php, method DB_DataObject_FormBuilder_QuickForm::_freezeFormElements()
DB_DataObject_FormBuilder_QuickForm::_freezeFormElements()
_generateForm: in file FormBuilder.php, method DB_DataObject_FormBuilder::_generateForm()
DB_DataObject_FormBuilder::_generateForm()
_getQFType: in file QuickForm.php, method DB_DataObject_FormBuilder_QuickForm::_getQFType()
DB_DataObject_FormBuilder::_getQFType()
_getSelectOptions: in file FormBuilder.php, method DB_DataObject_FormBuilder::_getSelectOptions()
Internal function to get the select potions for a table.
_reorderElements: in file FormBuilder.php, method DB_DataObject_FormBuilder::_reorderElements()
DB_DataObject_FormBuilder::_reorderElements()
_setFormElementRequired: in file QuickForm.php, method DB_DataObject_FormBuilder_QuickForm::_setFormElementRequired()
DB_DataObject_FormBuilder_QuickForm::_setFormElementRequired()

top

a

$addFormHeader: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$addFormHeader
Add a header to the form - if set to true, the form will have a header element as the first element in the form.

top

c

$clientRules: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$clientRules
If set to true, validation rules will also be client side.
$createSubmit: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$createSubmit
If set to false, no submit button will be created for your forms. Useful when used together with QuickForm_Controller when you already have submit buttons for next/previous page. By default, a button is being generated.
$crossLinks: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$crossLinks
Holds cross link data.
$crossLinkSeparator: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$crossLinkSeparator
The text to put between crosslink elements.
create: in file FormBuilder.php, method DB_DataObject_FormBuilder::create()
DB_DataObject_FormBuilder::create()

top

d

$dateElementFormat: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$dateElementFormat
A format string that represents the display settings for QuickForm date elements.
$dateFieldLanguage: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$dateFieldLanguage
The language used in date fields. See documentation of HTML_Quickform's date element for more information.
$dateFields: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$dateFields
A simple array of field names indicating which of the fields in a particular table/class are actually to be treated date fields. This is an unfortunate workaround that is neccessary because the DataObject generator script does not make a difference between any other datatypes than string and integer.
$dateFromDatabaseCallback: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$dateFromDatabaseCallback
Callback method to convert a date from the format it is stored in the database to the format used by the QuickForm element that handles date values. Must have a format usable with call_user_func().
$dateToDatabaseCallback: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$dateToDatabaseCallback
Callback method to convert a date from the format used by the QuickForm element that handles date values to the format the database can store it in.
DB_DataObject_FormBuilder: in file FormBuilder.php, class DB_DataObject_FormBuilder
DB_DataObject_FormBuilder: in file FormBuilder.php, method DB_DataObject_FormBuilder::DB_DataObject_FormBuilder()
DB_DataObject_FormBuilder::DB_DataObject_FormBuilder()
DB_DataObject_FormBuilder_QuickForm: in file QuickForm.php, method DB_DataObject_FormBuilder_QuickForm::DB_DataObject_FormBuilder_QuickForm()
DB_DataObject_FormBuilder_QuickForm::DB_DataObject_FormBuilder_QuickForm()
DB_DataObject_FormBuilder_QuickForm: in file QuickForm.php, class DB_DataObject_FormBuilder_QuickForm
debug: in file FormBuilder.php, method DB_DataObject_FormBuilder::debug()
DB_DataObject_FormBuilder::debug()

top

e

$elementTypeMap: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$elementTypeMap
Array to determine what QuickForm element types are being used for which
$enumFields: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$enumFields
A simple array of fields names which should be treated as ENUMs. A select box will be created with the enum options. If you add this field to the linkElementTypes array and give it a 'radio' type, you will get radio buttons instead.
$enumOptions: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$enumOptions
An array which holds enum options for specific fields. Each key should be a field in the current table and each value holds a an array of strings which are the possible values for the enum. This will only be used if the field is listed in enumFields.
$enumOptionsCallback: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$enumOptionsCallback
A valid callback which will return the options in a simple array of strings for an enum field given the table and field names.

top

f

$fieldLabels: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$fieldLabels
Array of field labels. The key of the element is the field name. Use this if you want to keep the auto-generated elements, but still define your own labels for them.
$fieldsToRender: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$fieldsToRender
Array of fields to render elements for. If a field is not given, it will not be rendered. If empty, all fields will be rendered (except, normally, the primary key).
$formHeaderText: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$formHeaderText
Text for the form header. If not set, the name of the database table this form represents will be used.
forceQueryType: in file FormBuilder.php, method DB_DataObject_FormBuilder::forceQueryType()
DB_DataObject_FormBuilder::forceQueryType()

top

g

getDataObjectSelectDisplayValue: in file FormBuilder.php, method DB_DataObject_FormBuilder::getDataObjectSelectDisplayValue()
DB_DataObject_FormBuilder::getDataObjectSelectDisplayValue()
getFieldLabel: in file FormBuilder.php, method DB_DataObject_FormBuilder::getFieldLabel()
DB_DataObject_FormBuilder::getFieldLabel()
getForm: in file FormBuilder.php, method DB_DataObject_FormBuilder::getForm()
DB_DataObject_FormBuilder::getForm()
getSelectOptions: in file FormBuilder.php, method DB_DataObject_FormBuilder::getSelectOptions()
DB_DataObject_FormBuilder::getSelectOptions()
getValidationErrors: in file FormBuilder.php, method DB_DataObject_FormBuilder::getValidationErrors()
DB_DataObject_FormBuilder::getValidationErrors()

top

h

$hidePrimaryKey: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$hidePrimaryKey
By default, hidden fields are generated for the primary key of a DataObject. This behaviour can be deactivated by setting this option to false.

top

l

$linkDisplayFields: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$linkDisplayFields
An array of the default fields to display when creating a select box
$linkDisplayLevel: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$linkDisplayLevel
If this is set to 1 or above, links will be followed in the display fields and the display fields of the record linked to will be used for display.
$linkElementTypes: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$linkElementTypes
Array to configure the type of the link elements. By default, a select box will be used. The key is the name of the link element. The value is 'radio' or 'select'. If you choose 'radio', radio buttons will be made instead of a select box.
$linkOrderFields: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$linkOrderFields
An array of the default fields to order records by when creating a select box

top

p

$preDefElements: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$preDefElements
Array of user-defined QuickForm elements that will be used for the field
$preDefGroups: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$preDefGroups
Array of groups to put certain elements in. The key is an element name, the value is the group to put the element in.
$preDefOrder: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$preDefOrder
Indexed array of element names. If defined, this will determine the order in which the form elements are being created. This is useful if you're using QuickForm's default renderer or dynamic templates and the order of the fields in the database doesn't match your needs.
populateOptions: in file FormBuilder.php, method DB_DataObject_FormBuilder::populateOptions()
DB_DataObject_FormBuilder::populateOptions()
processForm: in file FormBuilder.php, method DB_DataObject_FormBuilder::processForm()
DB_DataObject_FormBuilder::processForm()

top

r

$requiredRuleMessage: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$requiredRuleMessage
Text that is displayed as an error message if a required field is left empty. Use %s to insert the field name.
$ruleViolationMessage: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$ruleViolationMessage
Text that is displayed as an error message if a validation rule is violated by the user's input. Use %s to insert the field name.

top

s

$selectAddEmpty: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$selectAddEmpty
An array of the link fields which should have an empty option added to the select box. This is only a valid option for fields which link to another table.
$submitText: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$submitText
Text for submit button

top

t

$textFields: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$textFields
A simple array of field names indicating which of the fields in a particular table/class are actually to be treated as textareas. This is an unfortunate workaround that is neccessary because the DataObject generator script does not make a difference between any other datatypes than string and integer.
$timeFields: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$timeFields
A simple array of field names indicating which of the fields in a particular table/class are actually to be treated time fields. This is an unfortunate workaround that is neccessary because the DataObject generator script does not make a difference between any other datatypes than string and integer.
$tripleLinks: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$tripleLinks
Holds triple link data.

top

u

$userEditableFields: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$userEditableFields
Array of fields which the user can edit. If a field is rendered but not specified in this array, it will be frozen. Ignored if not given.
useForm: in file FormBuilder.php, method DB_DataObject_FormBuilder::useForm()
DB_DataObject_FormBuilder::useForm()

top

v

$validateOnProcess: in file FormBuilder.php, variable DB_DataObject_FormBuilder::$validateOnProcess
If set to TRUE, the current DataObject's validate method is being called before the form data is processed. If errors occur, no insert/update operation will be made on the database. Use getValidationErrors() to retrieve the reasons for a failure.
validateData: in file FormBuilder.php, method DB_DataObject_FormBuilder::validateData()
DB_DataObject_FormBuilder::validateData()

top