AutoForm automatically creates a form based on an underlying DataItem. More...

Inheritance diagram for AutoForm:

Public Member Functions
	AutoForm ($target, $method="POST", $action="", $id="")
	Creates a new AutoForm, based on the supplied target DataItem. More...

	getData ()
	Returns the target data item for the form. More...

	setDataSet ($params)

	setLayout ($layout)
	Override the default layout manager. More...

	setFieldOrder ()
	Override the display order for ungrouped field. More...

	createRenderer ($field)
	This factory method creates a FieldRender based on the type of the specified field. More...

	addDefaultValidators ()
	Creates default validators for fields in the form. More...

	getValidationEngine ()
	Retrieve the validation engine for this AutoForm. More...

	makeSubordinate ()
	Set this AutoForm to be a subordinate form within a CompositeAutoForm. More...

	configureValidators ()

	writeScript ()
	This method writes any Javascript code that will be required for the generated form to operate, including code for Rich Text Editors, Date Pickers and field validation. More...

	getRenderer ($field)
	Retrieves the FieldRenderer object for the specified field. More...

	override ($field, $label="", $renderer=null)
	Overrides the defaults for the specifed form field, providing a new label and/or FieldRenderer. More...

	overrideType ($field, $type, $label="")
	Override the default type for the specified form field, providing a FieldRenderer based on the supplied type (and optionally also override the field label) More...

	add ($renderer, $field="", $label="")
	Adds an additional (pseudo) field to the form. More...

	hide ()
	Call this method to hide one or more fields in the form's user interface. More...

	hideExcept ()
	Call this method to hide all the fields in the form's user interface EXCEPT the fields specified. More...

	isHidden ($field)
	Check whether the specified field is hidden in the form. More...

	annotate ($field, $text)
	Adds an annotation (such as brief explanatory text) to the specified field. More...

	alias ()
	Use this method to override the display name for fields in the form. More...

	related ($class, $constraint="", $format=null, $field=null, $label=null, $allowAdd=false, $allowNone=true)
	Utility function to add a RelatedItemSelectFieldRender. More...

	crossReference ($xrefClass, $options, $format, $field, $label=null, $xrefField=null)
	Utility function to add a CrossReferenceSelectFieldRenderer. More...

	dropdown ($field, $label="", $options=null, $onchange=null, $grouped=false)
	Utility function to add a SelectFieldRenderer. More...

	groupedDropdown ($field, $label, $options, $onchange=null)
	Utility function to add a SelectFieldRenderer with grouped options. More...

	radio ($field, $label, $options, $onchange=null)
	Utility function to add a RadioButtonFieldRenderer. More...

	checklist ($field, $label, $options, $grouped=false)
	Utility function to add a CheckListFieldRenderer. More...

	toggle ($field, $label="", $ragged=false)
	Utility function to create a ToggleFieldRenderer. More...

	group ($name)
	Define a field grouping. More...

	addToGroup ($name)
	Add more fields to the specified group. More...

	groupDescription ($name, $description, $position='start')
	Add a description block to a group. More...

	getGroupDescription ($name, $position='start')
	Retrieves the group description for the specified group. More...

	makeGroupCollapsible ($name, $toggleControl)
	Allows a group to be shown or hidden based on the value of another control. More...

	setGroupCSSClass ($name, $cssClass)
	Sets a specific CSS class on the specified CSS group. More...

	getGroupCSSClass ($name)
	Gets the CSS class for the specified group, if one has been set. More...

	removeGroup ($name)
	Remove the specified field grouping from the form. More...

	hideLabel ()
	Use this method to hide the labels for the specified fields in the form. More...

	readonly ()
	Call this method to make one or more fields read-only in the form's user interface. More...

	isReadOnly ($field)
	Determine whether the specified field is being displayed read-only. More...

	required ()
	Call this method to mark one or more fields as being required fields. More...

	hasAdditional ($field)
	Check if this field exists as an additional field. More...

	isRequired ($field)
	Determine whether the specified field is a required field for the form. More...

	requiredIfChecked ($field, $checkbox, $fieldTitle="", $checkboxTitle="", $message="")
	Make a field required if a given checkbox is checked. More...

	requiredSubSelect ($field, $fieldTitle, $subFieldTitle="", $message="")
	Make a subselect field required. More...

	regexp ($field, $expr, $message)
	Validate the user input for the specified field against a regular expression, outputting the supplied message if the entered value does not match. More...

	dateRange ($field, $min="", $max="", $message=null)

	unique ()
	Adds a uniqueness validator to the specified field(s). More...

	uniqueWithConstraint ($field, $message, $constraint="")

	range ($field, $min, $max, $message=null)
	Adds a range validator to the specified field. More...

	match ($field, $title, $match, $matchTitle, $caseSensitive=true)
	Specifies that two field values must match (as in a password/confirmation pair, for instance). More...

	password ($field, $title)
	Adds a password validator to the specified field. More...

	disableAutoComplete ()
	Disable autocomplete for the selected fields. More...

	button ($text, $url, $confirm=null, $isScript=false, $cssClass=null)
	Adds a custom button to the form. More...

	ajaxSubmit ($success, $failure=null)
	Put the form into AJAX submission mode. More...

	partialSaveButton ($containerID, $label="Save")
	Activate partial saves for this form. More...

	matchesSubmitted ()
	Determine if this form is the one that was submitted. More...

	drawForm ()
	Renders the form to HTML. More...

	drawSubmitButtons ($obj, $pk, $submitLabel)

	renderAllFields ($obj)

	renderFields ($obj)

	renderOneField ($field, $renderScript=false)

	renderAdditionalFields ($obj)

	drawButtons ()
	Draws any additional buttons specified in the calling script. More...

	drawReadOnly ()
	Draws the form in read-only mode. More...

	prettifyFieldName ($field)
	Generates a human-readable label from the given field name. More...

	load ($id)
	Loads the underlying DataItem from the database, using the specified primary key value. More...

	save ()
	Saves the posted values to the database. More...

	handlePartialSave ($success)

	preProcessFields ($pk, $filter)

	postProcessFields ($pk, $filter)

	remove (&$obj)

	validate ()
	Validate the posted values for the form. More...

	patchUpReferences ()

Static Public Member Functions
static	registerFieldRendererClass ($type, $rendererClass)
	Registers a custom type-to-renderer mapping. More...

Public Attributes
	$formCSS = ""
	CSS Class to use for the table containing the form. More...

	$labelCSS = ""
	CSS Class to use for label cells. More...

	$valueCSS = ""
	CSS Class to use for field/value cells. More...

	$buttonCSS = ""
	CSS Class to use for buttons. More...

	$buttonLineCSS = "submit"
	CSS Class to use for the button line (container for form buttons) More...

	$inputCSS = ""
	CSS Class to use for input fields. More...

	$checkboxCSS = ""
	CSS Class to use for checkbox fields. More...

	$style = ""

	$componentPath ="/fakoli"

	$buttonAlignment = "left"
	Default Form button alignment. More...

	$passwordEncryptor = ""
	Password Encryption method name. More...

	$hideButtons = false
	Set to true to hide form submission button line(s) More...

	$capitalizationMode = "word"
	Capitalization to be used for labels. Can be 'lower', 'upper', 'first' or 'word'. More...

	$submitLabel = ""
	Text to display on the form's submit button. If not specified defaut text will be generated based on the target DataItem. More...

	$allowDelete = false
	If true, the form will display a delete button if editing an existing item. More...

	$deleteLabel = ""
	Text to display on the form's delete button. If not specified defaut text will be generated based on the target DataItem. More...

	$deleteMessage = ""
	Confirmation message to display when the form's delete button is pressed. If not specified defaut text will be generated based on the target DataItem. More...

	$method = "POST"
	HTTP method that will be used to submit the form. More...

	$action = ""
	Action URL for submitting the form. Generally this can be left blank to submit back to the same page. More...

	$renderers = array()
	The field renderers collection. More...

	$overrides = array()
	The field overrides collection. More...

	$hidden = array()
	The hidden fields collection. More...

	$additional = array()
	The additional (pseudo) fields collection. More...

	$additional_at_top = false
	whether additional fields are rendered above the datamodel's field list; if false, then rendered below More...

	$readonly = array()
	The read-only fields collection. More...

	$annotations = array()
	The field annotations collection. More...

	$buttons = array()
	The custom buttons collection. More...

	$fieldOrder = array()
	The order in which to display ungrouped fields. More...

	$validator
	The ValidationEngine for this form. More...

	$useLinkSubmit = false
	Flag to indicate whether the submit button for the form should be rendered as a link (not common). More...

	$HTMLEditorHideStyleBar = false
	Flag to indicate that Rich Text Editors should be displayed with or without the style editing toolbar. More...

	$HTMLEditorDefaultWidth = "540px"
	Default width for Rich Text Editor controls. More...

	$HTMLEditorDefaultHeight = "200px"
	Default height for Rich Text Editor controls. More...

	$passwordEnterLabel = "Enter"
	Text for Password Enter label. More...

	$passwordConfirmLabel = "Confirm"
	Text for Password Confirm label. More...

	$onDrawStart = null
	Callback event handler that is fired just prior to drawing the form. More...

	$onDrawComplete = null
	Callback event handler that is fired just after the form been drawn. More...

	$onInsertPreProcess = null
	Callback event handler that is fired after fields have been preprocessed, but before the data has been saved to the database as a new record. More...

	$onSavePreProcess = null
	Callback event handler that is fired after fields have been preprocessed, but before the data has been saved to the database. More...

	$onSaveComplete = null
	Callback event handler that is fired after the AutoForm has finished saving data to the database. More...

	$confirmPrompt = null
	Specify a confirmation message. This will be shown to the user to have them confirm the form submission after the submit button is pressed. More...

	$onDelete = ""
	delete method name More...

	$customSaveHandler = null
	Use this field to override the default save behavior of your form. More...

	$markRequiredFields = false
	Set to true to add an asterisk after required field labels. More...

	$onFormatLabel = null
	Label Processing hook. More...

	$buttons_at_top = false

	$ajaxSubmitHandler = false
	JavaScript Callback for AJAX Submit mode - called on success. More...

	$ajaxFailureHandler = false
	JavaScript Callback for AJAX Submit mode - called on failure. More...

	$onSubmitHandler = null
	Javascript Callback for user-defined onsubmit hook. More...

	$required = array()
	List of required fields. More...

	$requiredFieldsText = "* indicates required field"
	Text prompt to display when a form contains required fields. More...

	$interstitialMessage = null
	Specifies the message to display in an interstitial while the form is being submitted. More...

	$interstitialSpinner = '/fakoli/images/loader.gif'
	Set this property to override the default interstitial spinner animation. More...

	$fields
	Local field cache. More...

	$groups = array()
	List of field groups. More...

	$collapsibleGroups = array()
	List of collapsible groups and their default states. More...

	$groupDescriptions = array()
	List of group descriptions. More...

	$groupDescriptionCSS = "group_description"
	CSS class for group description blocks. More...

	$groupCSSClasses = array()
	Additional classes for specific groups. More...

	$readOnlyForm
	Specifies whether the entire form is read-only. More...

	$subordinate
	Specifies whether this form is a subordinate member of a composite form. More...

	$hideEmptyFields = false
	Specifies whether to hide empty fields when displaying a read-only form. More...

	$showAnnotations = true
	Set to false to hide field annotations. More...

	$layout
	Layout handler object. More...

	$default_layout = "table"

	$allowPartialSave = false
	Whether to allow partial (i.e. in-progress) saves via AJAX. More...

	$partialSaveContainerID
	DOM ID for the element that will contain the partial save button. More...

	$partialSaveLabel = "Save"
	Label text for the partial save button. More...

Static Public Attributes
static	$fieldRendererMap
	Provides the mapping from Type identifier to FieldRenderer. More...

Detailed Description

AutoForm automatically creates a form based on an underlying DataItem.

Definition at line 45 of file auto_form.inc.

Member Function Documentation

◆ add()

AutoForm::add	(	$renderer,
		$field = `""`,
		$label = `""`
	)

Adds an additional (pseudo) field to the form.

This can be used to render additional fields in the user interface that are not directly tied to single fields in the underlying DataItem (for instance, to provide a checkbox list for many-to-one relationships, etc)

Parameters

mixed	$renderer	either a mapped type (String, Number, etc), or a FieldRenderer-derived object to use for the additional field.
string	$field	the name of the additional field
string	$label	(optional) label for the additional field

Definition at line 594 of file auto_form.inc.

      {
           if (is_string($renderer))
           {
                if (array_key_exists($renderer, AutoForm::$fieldRendererMap))
                {
                     $renderer = new AutoForm::$fieldRendererMap[$renderer]($this, $field);
                }
                else
                {
                     throw new FakoliException("Unknown Type - {$renderer}");
                }
           }
           
           array_push($this->additional, array('renderer' => $renderer, 'field' => $field));
           if ($field && $label)
           {
                $this->alias($field, $label);
           }
      }

◆ addDefaultValidators()

AutoForm::addDefaultValidators ( )

Creates default validators for fields in the form.

Currently this adds Date format validators to all date fields - other fields are not affected.

This method is called automatically before the form is rendered.

Reimplemented in SearchForm.

Definition at line 311 of file auto_form.inc.

      {
           $filter = $this->data->getFilter();
           
           foreach(array_keys($this->fields) as $field)
           {
                if ($filter && $filter->isExcluded($field)) continue;
                if ($this->readonly[$field]) continue; // No need to validate readonly fields
                
                $renderer = $this->getRenderer($field);
                if ($renderer)
                {
                     // JDG 9/19/2010 - let each renderer supply its own validator
                     $required = (array_search($field, $this->required) === FALSE) ? false : true;
                     $renderer->addValidatorsToForm($field, $required);
                }
           }
  
           foreach($this->additional as $r)
           {
                // JDG 5/2012 - check if additional field is required
                $required = (array_search($r['field'], $this->required) === FALSE) ? false : true;
                $r['renderer']->addValidatorsToForm($r['field'], $required);
           }
      }

◆ addToGroup()

AutoForm::addToGroup ( $name )

Add more fields to the specified group.

Parameters

string $name the name of the group

Definition at line 817 of file auto_form.inc.

      {
           if (!array_key_exists($name, $this->groups))
           {
                $this->groups[$name] = array();
           }
           
           for($i = 1; $i < func_num_args(); ++$i)
           {
                $this->groups[$name][] = func_get_arg($i);
           }
      }

◆ ajaxSubmit()

AutoForm::ajaxSubmit	(	$success,
		$failure = `null`
	)

Put the form into AJAX submission mode.

You must supply a Javascript function to call once the submission is complete.

Parameters

string	$success	the Javascript callback function for success
string	$failure	the Javascript callback function for failure

Definition at line 1157 of file auto_form.inc.

      {
           if ($failure == null)
           {
                $failure = "function() {document.id('{$form->id}_error').set('text','Failed to communicate with server'); }";
           }
           
           $this->ajaxSubmitHandler = $success;
           $this->ajaxFailureHandler = $failure;
      }

◆ alias()

AutoForm::alias ( )

Use this method to override the display name for fields in the form.

For instance, calling alias('x1', 'Useful Label') would display the text 'Useful Label' as the label for field 'x1' when rendering the form. You can alias more than one field with a single call to alias, simply by passing in more than one pairs of strings. For instance, you might call: alias('x1', 'Field 1', 'x2', 'Field 2', ...)

Definition at line 684 of file auto_form.inc.

      {
           for($i = 0; $i < func_num_args(); $i += 2)
           {
                $field = func_get_arg($i);
                $label = func_get_arg($i + 1);
                $this->override($field, $label);
           }
      }

◆ annotate()

AutoForm::annotate	(	$field,
		$text
	)

Adds an annotation (such as brief explanatory text) to the specified field.

The annotation is displayed next to the field when the form is renderered.

Parameters

string	$field	the name of the field to annotate
string	$text	the annotation text

Definition at line 670 of file auto_form.inc.

      {
           $this->annotations[$field] = $text;
      }

◆ AutoForm()

AutoForm::AutoForm	(	$target,
		$method = `"POST"`,
		$action = `""`,
		$id = `""`
	)

Creates a new AutoForm, based on the supplied target DataItem.

Parameters

DataItem	$target	the DataItem object upon which the form will be based
string	$method	the HTTP method to be used for submitting the form (default is POST)
string	$action	the HTTP action URL to be used for submitting the form (default is to post back to the originating URL)
string	$id	DOM element ID to use for the form when rendering to HTML. Useful for pages with more than one form.

Returns: AutoForm

Definition at line 166 of file auto_form.inc.

      {
           global $auto_form_defaults;
  
           $this->subordinate = false;
           
           $this->validator = new ValidationEngine();
  
           foreach($auto_form_defaults as $field => $value)
           {
                $this->$field = $value;
           }
  
           if (!$target)
           {
                throw new FakoliException("Form has no target object");
           }
           
           $this->data =& $target;
           $this->method = $method;
           $this->action = $action;
           $this->id = ($id != "") ? $id : get_class($this->data)."_form";
  
           $this->validator->id = $this->id;
  
           $this->fields = $this->data->getFields();
           
           $filter = $this->data->getFilter();
           
           // Add in a default renderer for each field
           foreach($this->fields as $field => $type)
           {
                if ($filter && $filter->isExcluded($field)) continue;
                
                $this->renderers[$field] = $this->createRenderer($field);
           }
           
           $aliases = $this->data->getFieldAliases();
           // Read in default alias definitions from DataItem
           if ($aliases)
           {
                foreach($aliases as $field => $alias)
                {
                     $this->alias($field, $alias);
                }
           }
           
           $annotations = $this->data->getFieldAnnotations();
           // Read in default annotations from DataItem
           if ($annotations)
           {
                foreach($annotations as $field => $annotation)
                {
                     $this->annotate($field, $annotation);
                }
           }
           
           $pks = $this->data->getPrimaryKeyList();
           foreach($pks as $p)
           {
                $this->hide($p);
           }
           
           $hiddenFields = $this->data->getHiddenFields();
           foreach($hiddenFields as $h)
           {
                $this->hide($h);
           }
           
           $this->layout = AutoFormLayout::create($this->default_layout, $this);
      }

◆ button()

AutoForm::button	(	$text,
		$url,
		$confirm = `null`,
		$isScript = `false`,
		$cssClass = `null`
	)

Adds a custom button to the form.

Parameters

string	$text	the button label text
string	$url	the URL to handle the button press
string	$confirm	optional confirmation message
boolean	$isScript	true if the url is javascript code to execute, false if it is a URL to redirect to
string	$cssClass	optional CSS class(es) to apply to the button

Definition at line 1146 of file auto_form.inc.

      {
           $this->buttons[] = array('text' => $text, 'url' => $url, 'confirm' => $confirm, 'isScript' => $isScript, 'cssClass' => $cssClass);
      }

◆ checklist()

AutoForm::checklist	(	$field,
		$label,
		$options,
		$grouped = `false`
	)

Utility function to add a CheckListFieldRenderer.

Parameters

string	$label	the label for the field
array	$options	associative array of grouped options

See also: CheckListFieldRenderer

Parameters

bool $grouped true if the options are grouped, false otherwise (default)

Definition at line 779 of file auto_form.inc.

      {
           return new CheckListFieldRenderer($this, $field, $label, $options, $grouped);
      }

◆ configureValidators()

AutoForm::configureValidators ( )

Definition at line 353 of file auto_form.inc.

      {
           if ($this->validatorsConfigured) return;
           
           $this->addDefaultValidators();
  
           foreach($this->validator->validators as $v)
           {
                $v->title = (!$v->title) ? $this->prettifyFieldName($v->field) : $v->title;
                $v->readOnly = $this->isReadOnly($v->field) || $this->isHidden($v->field);
           }
           
           $this->validatorsConfigured = true;
      }

◆ createRenderer()

AutoForm::createRenderer ( $field )

This factory method creates a FieldRender based on the type of the specified field.

Parameters

string $field the field for which the FieldRenderer is to be created

Returns: FieldRenderer a FieldRenderer object suitable for the specified field.

Definition at line 278 of file auto_form.inc.

      {
           if (!array_key_exists($field, $this->fields)) return null;
  
           $type = $this->fields[$field];
           
           if ($type == "Timestamp") return null; // No field renderer required for this type
           
           if (array_key_exists($type, AutoForm::$fieldRendererMap))
           {
                return new AutoForm::$fieldRendererMap[$type]($this, $field);
           }
           
           throw new FakoliException("AutoForm::createRenderer(): Unknown type '$type'");
      }

◆ crossReference()

AutoForm::crossReference	(	$xrefClass,
		$options,
		$format,
		$field,
		$label = `null`,
		$xrefField = `null`
	)

Utility function to add a CrossReferenceSelectFieldRenderer.

Parameters

string	$xrefClass	the name of the cross-reference DataItem class
array	$options	array of possible target DataItems
string	$format	the format specifier to use when outputting the optio0ns
string	$field	field name for use during form submission (should not be an actual field name)
string	$label	the label text to display
string	$xrefField	the name of the field mapping the primary key of the target DataItems (only specify this if the field name is different from the primary key)

Returns: CrossReferenceSelectFieldRenderer

Definition at line 728 of file auto_form.inc.

      {
           if (!$label) $label = prettify($field);
           return new CrossReferenceSelectFieldRenderer($this, $field, $label, $options, $format, $xrefClass, $xrefField);
      }

◆ dateRange()

AutoForm::dateRange	(	$field,
		$min = `""`,
		$max = `""`,
		$message = `null`
	)

Parameters

string	$field
	string,Date,or	DateTime $min
	string,Date	or DateTime $max
string	$message	Min can be either a static date min that the field's value must be set to or the name of a field whose value will be compared to the given field.

E.g., start_date must be no earlier than today or start_date must be no earlier than end_date

Definition at line 1035 of file auto_form.inc.

      {
           if ($this->data->hasField($field))
           {
                $this->validator->add(new DateRangeValidator($field, $this->prettifyFieldName($field), $min, $max, $message));
           }
      }

◆ disableAutoComplete()

AutoForm::disableAutoComplete ( )

Disable autocomplete for the selected fields.

If no fields are specified, autocomplete is disabled for all the fields in the form.

Definition at line 1110 of file auto_form.inc.

      {
           $numArgs = func_num_args();
           
           if ($numArgs == 0)
           {
                foreach($this->data->getFields() as $field => $type)
                {
                     if ($this->data->hasField($field))
                     {
                          $this->getRenderer($field)->autocomplete = false;
                     }
                }
           }
           else
           {
                for($i = 0; $i < $numArgs; ++$i)
                {
                     if ($this->data->hasField($field))
                     {
                          $this->getRenderer($field)->autocomplete = false;
                     }
                }
           }
      }

◆ drawButtons()

AutoForm::drawButtons ( )

Draws any additional buttons specified in the calling script.

Definition at line 1459 of file auto_form.inc.

      {
           foreach($this->buttons as $button)
           {
                $url = ($button['isScript']) ? $button['url'] : "go('{$button['url']}');";
                
                if ($button['confirm'])
                {
                     $link = "if (confirm('".jsSafe($button['confirm'])."')) $url; return false;";
                }
                else
                {
                     $link = "$url; return false;";
                }
  
                $css = $this->buttonCSS;
                if ($button['cssClass'])
                {
                     $css .= " ".$button['cssClass'];
                }
                
                echo "&nbsp;&nbsp;&nbsp;&nbsp;<input type='button' class='{$css}' onclick=\"$link\" value=\"{$button['text']}\"/>";
           }
  
      }

◆ drawForm()

AutoForm::drawForm ( )

Renders the form to HTML.

Reimplemented in SearchForm, FilterForm, and SubordinateAutoForm.

Definition at line 1196 of file auto_form.inc.

      {
           if ($this->readOnlyForm) return $this->drawReadOnly();      
  
           if ($this->onDrawStart)
           {
                if (call_user_func_array($this->onDrawStart, array($this)) === false)
                {
                     return;
                }
           }
           
           $obj =& $this->data;
           $pk = $obj->getPrimaryKey();
  
           $submitLabel = $this->submitLabel;
           if ($submitLabel == "")
           {
                $submitLabel = ($obj->get($pk) != "" && $obj->get($pk) != 0) ? "Update ".$obj->prettifyClassName() : "Add ".$obj->prettifyClassName();
           }
  
           //echo "<!--\n";
           //print_r($this);
           //echo "\n-->\n";
           
           if (!$this->subordinate)
           {
                echo "<form id='{$this->id}' method='{$this->method}' action='{$this->action}' enctype='multipart/form-data'";
                if (!$this->ajaxSubmitHandler) 
                {
                     echo " onsubmit='return onSubmit{$this->id}(this);'";
                }
                else
                {
                     echo " data-mode='ajax'";
                }
                echo ">\n";
           }
           
           if ($this->id)
           {
                echo "<input type='hidden' name='#FORMID#' value='{$this->id}'/>";
           }
           
           $csrfToken = $_SESSION["csrfToken"];
           if (!$csrfToken)
           {
                $csrfToken = plainGUID();
                $_SESSION["csrfToken"] = $csrfToken;
           }
           
           echo "<input type='hidden' name='#SESSIONTIE#' value='{$csrfToken}'/>\n";
           
           foreach(array_keys($this->hidden) as $hidden)
           {
                echo "<input id='{$this->id}_{$hidden}' type='hidden' name='$hidden' value='".htmlSafe($obj->get($hidden))."'/>\n";
           }
  
           if ($this->layout->externalErrorBox) $this->layout->errorBox();
           
           $this->layout->startUngrouped();
           
           if ($this->buttons_at_top && !$this->subordinate && !$this->hideButtons) 
           {
                $this->layout->startButtonLine();
                
                $this->drawSubmitButtons($obj, $pk, $submitLabel);
  
                $this->drawButtons();
  
                $this->layout->endButtonLine();
           }
  
           if (!$this->layout->externalErrorBox) $this->layout->errorBox();
           
           if ($this->markRequiredFields && $this->validator->hasRequiredFields())
           {
                $this->layout->requiredFields($this->requiredFieldsText);
           }
  
           $this->renderAllFields($obj);
                          
           if (!$this->subordinate && !$this->hideButtons)
           {         
                $this->layout->startButtonLine();
  
                $this->drawSubmitButtons($obj, $pk, $submitLabel);
                $this->drawButtons();
      
                $this->layout->endButtonLine();
           }
  
           $this->layout->endUngrouped();
           
           $this->layout->finalizeLayout();
           
           if (!$this->subordinate)
           {
                echo "</form>\n";
           }
  
           if ($this->onDrawComplete)
           {
                call_user_func_array($this->onDrawComplete, array($this));
           }
      }

◆ drawReadOnly()

AutoForm::drawReadOnly ( )

Draws the form in read-only mode.

This is most often used to display the details for a DataItem on a preview or details screen.

Reimplemented in SearchForm, and SubordinateAutoForm.

Definition at line 1489 of file auto_form.inc.

      {
           $this->readOnlyForm = true;
           
           $this->layout->startUngrouped();
           
           $obj =& $this->data;
           
           $this->renderAllFields($obj);
           
           $this->layout->endUngrouped();     
  
           $this->layout->finalizeLayout();
      }

◆ drawSubmitButtons()

AutoForm::drawSubmitButtons	(	$obj,
		$pk,
		$submitLabel
	)

Definition at line 1306 of file auto_form.inc.

      {
           $submitID = $this->id."_submitButton";
           
           if ($this->useLinkSubmit)
           {
                echo "<a id='{$submitID}' class='{$this->buttonCSS}' name='Submit' onclick='if (onSubmit{$this->id}(document.forms.{$this->id})) return document.forms.{$this->id}.submit(); else return false;'>$submitLabel</a>";
           }
           else
           {
                echo "<input type='submit' id='{$submitID}' class='{$this->buttonCSS}' name='Submit' value='$submitLabel' ondblclick='return false;'/>";
           }
  
           if ($obj->get($pk) && $this->allowDelete)
           {
                $deleteLabel = ($this->deleteLabel) ? $this->deleteLabel : "Delete this ".$obj->prettifyClassName();
                $deleteMessage = ($this->deleteMessage) ? $this->deleteMessage : "Are you sure you want to delete this ".$obj->prettifyClassName();
                
                echo "&nbsp;&nbsp;&nbsp;&nbsp;<input type='submit' class='{$this->buttonCSS}' name='{$this->id}_delete'
                 value='$deleteLabel'
                 onclick='return confirm(\"{$deleteMessage}\");'/>";
           }    
      }

◆ dropdown()

AutoForm::dropdown	(	$field,
		$label = `""`,
		$options = `null`,
		$onchange = `null`,
		$grouped = `false`
	)

Utility function to add a SelectFieldRenderer.

Parameters

string	$field	the field name
string	$label	the label for the field
array	$options	associative array of grouped options

See also: SelectFieldRenderer

Parameters

string	$onchange	Javascript onchange handler function name (optional)
bool	$grouped	true if the options are grouped, false otherwise (default)

Definition at line 742 of file auto_form.inc.

      {
           return new SelectFieldRenderer($this, $field, $label, $options, $onchange, $grouped);
      }

◆ getData()

AutoForm::getData ( )

Returns the target data item for the form.

Reimplemented in SubordinateAutoForm.

Definition at line 241 of file auto_form.inc.

      {
           return $this->data;
      }

◆ getGroupCSSClass()

AutoForm::getGroupCSSClass ( $name )

Gets the CSS class for the specified group, if one has been set.

Parameters

string $name the name of the group

Returns: string the CSS class applied to the group

Definition at line 879 of file auto_form.inc.

      {
           return array_key_exists($name, $this->groupCSSClasses) ? $this->groupCSSClasses[$name] : "";
      }

◆ getGroupDescription()

AutoForm::getGroupDescription	(	$name,
		$position = `'start'`
	)

Retrieves the group description for the specified group.

Parameters

string	$name	the name of the group
	$position	whether the description should appear at the 'start' or 'end' of the group

Definition at line 847 of file auto_form.inc.

      {
           $key = "{$name}:{$position}";
           if (array_key_exists($key, $this->groupDescriptions)) return $this->groupDescriptions[$key];
           return "";
      }

◆ getRenderer()

AutoForm::getRenderer ( $field )

Retrieves the FieldRenderer object for the specified field.

You can use this to access the underlying field renderer for a given field and change the way it is rendered or processed.

Parameters

string $field the name of the field for which to retrieve the FieldRenderer

Returns: FieldRenderer

Definition at line 512 of file auto_form.inc.

      {
           if (array_key_exists($field, $this->overrides))
           {
                if ($this->overrides[$field]['renderer']) return $this->overrides[$field]['renderer'];
           }
  
           if (array_key_exists($field, $this->renderers))
           {
                return $this->renderers[$field];
           }
           else // JDG 2/13/2011 get renderer from additional field set
           {
                foreach($this->additional as $r)
                {
                     $renderer = $r['renderer'];
                     $rField = $r['field'];
                     if(!$rField)
                          $rField = $renderer->field;
                     if($rField == $field)
                          return $renderer;
                }                        
           }
           
           trace("AutoForm::getRenderer(): Unknown field: $field", 2);
           return null;
      }

◆ getValidationEngine()

AutoForm::getValidationEngine ( )

Retrieve the validation engine for this AutoForm.

Reimplemented in SubordinateAutoForm.

Definition at line 340 of file auto_form.inc.

      {
           return $this->validator;
      }

◆ group()

AutoForm::group ( $name )

Define a field grouping.

Parameters

string $name the legend to use for the group

Definition at line 801 of file auto_form.inc.

      {
           $group = (array_key_exists($name, $this->groups)) ? $this->groups[$name] : array();
           for($i = 1; $i < func_num_args(); ++$i)
           {
                $group[] = func_get_arg($i);
           }
           
           $this->groups[$name] = $group;
           return $group;
      }

◆ groupDescription()

AutoForm::groupDescription	(	$name,
		$description,
		$position = `'start'`
	)

Add a description block to a group.

This will be displayed within the group, after then title (if displayed) but before any fields.

Parameters

string	$name	the name of the group
string	$description	the description to display for that group
string	$position	whether the description should appear at the 'start' or 'end' of the group

Definition at line 837 of file auto_form.inc.

      {
           $this->groupDescriptions["{$name}:{$position}"] = $description;
      }

◆ groupedDropdown()

AutoForm::groupedDropdown	(	$field,
		$label,
		$options,
		$onchange = `null`
	)

Utility function to add a SelectFieldRenderer with grouped options.

Parameters

string	$field	the field name
string	$label	the label for the field
array	$options	associative array of grouped options

See also: SelectFieldRenderer

Parameters

string $onchange Javascript onchange handler function name (optional)

Returns: SelectFieldRenderer

Definition at line 755 of file auto_form.inc.

      {
           return $this->dropdown($field, $label, $options, $onchange, true);
      }

◆ handlePartialSave()

AutoForm::handlePartialSave ( $success )

Definition at line 1655 of file auto_form.inc.

      {
           // Handle partial saves - return results via AJAX and exit immediately
           if ($this->allowPartialSave)
           {
                $headers = getallheaders();
                trace(print_r($headers, true), 3);
                
                if ($headers["X-Partial-Save"])
                {
                     $result = array("status"                => $success ? 'success' : 'error',
                                         "primary_key"       => $this->data->getPrimaryKey(),
                                        "primary_key_value"  => $this->data->get($this->data->getPrimaryKey()));
  
                     if (!$success)
                     {
                          $result["error"] = $this->msg;
                     }    
                     
                     ajaxReturn(json_encode($result));
                }
           }
           
           return $success;
      }

◆ hasAdditional()

AutoForm::hasAdditional ( $field )

Check if this field exists as an additional field.

Definition at line 947 of file auto_form.inc.

      {
           foreach($this->additional as $r)
           {
                $renderer = $r['renderer'];
                $rField = $r['field'];
                trace("## $field == $rField", 3);
                if($rField == $field)
                     return true;
           }
  
           return $false;
      }

◆ hide()

AutoForm::hide ( )

Call this method to hide one or more fields in the form's user interface.

For instance, calling hide("field1", "field3") would remove field1 and field3 from display when the form is rendered. Note that the values for these fields are still carried around with the form and saved to the database when the AutoForm saves the target DataItem. To prevent a field on the DataItem from being processed by the AutoForm at all, you should use an InclusionFilter or ExclusionFilter on the target DataItem.

Definition at line 624 of file auto_form.inc.

      {
           foreach(func_get_args() as $hidden)
           {
                $this->hidden[$hidden] = true;
           }
      }

◆ hideExcept()

AutoForm::hideExcept ( )

Call this method to hide all the fields in the form's user interface EXCEPT the fields specified.

For instance, calling hide("field1", "field3") would remove all the fields other than field1 and field3 when the form is rendered.
Note that the values for the hidden fields are still carried around with the form and saved to the database when the AutoForm saves the target DataItem. To prevent a field on the DataItem from being processed by the AutoForm at all, you should use an InclusionFilter or ExclusionFilter on the target DataItem.

Definition at line 641 of file auto_form.inc.

      {
           $exceptions = array_combine(func_get_args(), func_get_args());
           foreach($this->data->getFields() as $name => $type)
           {
                if (!array_key_exists($name, $exceptions))
                {
                     $this->hidden[$name] = true;
                }
           }
      }

◆ hideLabel()

AutoForm::hideLabel ( )

Use this method to hide the labels for the specified fields in the form.

Definition at line 897 of file auto_form.inc.

      {
           foreach(func_get_args() as $naked)
           {
                $this->getRenderer($naked)->hideLabel = true;
           }
      }

◆ isHidden()

AutoForm::isHidden ( $field )

Check whether the specified field is hidden in the form.

Parameters

string $field the name of the field

Returns: boolean true if the field has been hidden, false otherwise.

Definition at line 658 of file auto_form.inc.

      {
           return array_key_exists($field, $this->hidden) ? $this->hidden[$field] : false;
      }

◆ isReadOnly()

AutoForm::isReadOnly ( $field )

Determine whether the specified field is being displayed read-only.

Parameters

string $field the name of the field

Returns: boolean true if read-only, false otherwise

Definition at line 923 of file auto_form.inc.

      {
           return $this->readonly[$field];
      }

◆ isRequired()

AutoForm::isRequired ( $field )

Determine whether the specified field is a required field for the form.

Parameters

$field the field to check

Returns: boolean true if the field is required to be filled in by the user, false if it is an optional field.

Definition at line 966 of file auto_form.inc.

      {
           return (array_search($field, $this->required) !== FALSE) ? true : false;
      }

◆ load()

AutoForm::load ( $id )

Loads the underlying DataItem from the database, using the specified primary key value.

Parameters

integer $id the value to use for the primary key

Definition at line 1556 of file auto_form.inc.

      {
           $this->data->load($id);
      }

◆ makeGroupCollapsible()

AutoForm::makeGroupCollapsible	(	$name,
		$toggleControl
	)

Allows a group to be shown or hidden based on the value of another control.

Parameters

string	$name	the name of the group
string	$toggleControl	the field name of the toggling control

Definition at line 859 of file auto_form.inc.

      {
           $this->collapsibleGroups[$name] = $toggleControl;
      }

◆ makeSubordinate()

AutoForm::makeSubordinate ( )

Set this AutoForm to be a subordinate form within a CompositeAutoForm.

Reimplemented in SubordinateAutoForm.

Definition at line 348 of file auto_form.inc.

      {
           $this->subordinate = true;
      }

◆ match()

AutoForm::match	(	$field,
		$title,
		$match,
		$matchTitle,
		$caseSensitive = `true`
	)

Specifies that two field values must match (as in a password/confirmation pair, for instance).

Parameters

string	$field	The name of the first field that must match
string	$title
string	$match	The name of the second field that must match
string	$matchTitle
string	$caseSensitive	specifies whether the match is case sensitive

Definition at line 1090 of file auto_form.inc.

      {
           $this->validator->add(new MatchValidator($field, $title, $match, $matchTitle, $caseSensitive));
      }

◆ matchesSubmitted()

AutoForm::matchesSubmitted ( )

Determine if this form is the one that was submitted.

Useful for managing pages with multiple forms.

Definition at line 1187 of file auto_form.inc.

      {
           return (isset($_POST["#FORMID#"]) && $_POST["#FORMID#"] == $this->id);
      }

◆ override()

AutoForm::override	(	$field,
		$label = `""`,
		$renderer = `null`
	)

Overrides the defaults for the specifed form field, providing a new label and/or FieldRenderer.

Parameters

string	$field	the name of the field that is to be overridden
string	$label	the new text to use for the label for the specified field (null or "" to use the default label).
FieldRenderer	$renderer	the FieldRenderer-derived object to use in place of the default renderer for the specified field.

Definition at line 549 of file auto_form.inc.

      {
           if (!isset($this->overrides[$field]))
           {
                $this->overrides[$field] = array('label' => $label, 'renderer' => $renderer);
           }
           else
           {
                if ($label) $this->overrides[$field]['label'] = $label;
                if ($renderer) $this->overrides[$field]['renderer'] = $renderer;
           }
      }

◆ overrideType()

AutoForm::overrideType	(	$field,
		$type,
		$label = `""`
	)

Override the default type for the specified form field, providing a FieldRenderer based on the supplied type (and optionally also override the field label)

Parameters

string	$field	the name of the field that is to be overridden
string	$type	the field type to use as the override
string	$label	the new text to use for the label for the specified field (null or "" to use the default label).

Definition at line 569 of file auto_form.inc.

      {
           if ($type == "Timestamp") return; // No field renderer required for this type
           
           if (array_key_exists($type, AutoForm::$fieldRendererMap))
           {
                $renderer = new AutoForm::$fieldRendererMap[$type]($this, $field);
                $this->override($field, $label, $renderer);
                return;
           }
           
           throw new FakoliException("AutoForm::createRenderer(): Unknown type '$type'");
      }

◆ partialSaveButton()

AutoForm::partialSaveButton	(	$containerID,
		$label = `"Save"`
	)

Activate partial saves for this form.

A control will be added to the page that will allow users to save their progress without fully submitting the form. This is useful for long forms that required large amounts of text entry.

Parameters

string	$containerID	DOM ID of the element that will contain the partial save button
string	$label	Text to display on the partial save button

Definition at line 1176 of file auto_form.inc.

      {
           $this->allowPartialSave = true;
           $this->partialSaveContainerID = $containerID;
           $this->partialSaveLabel = $label;
      }

◆ password()

AutoForm::password	(	$field,
		$title
	)

Adds a password validator to the specified field.

Parameters

string	$field	The name of the field.
	string	The title of the field

Definition at line 1101 of file auto_form.inc.

      {
           $this->validator->add(new PasswordValidator($field, $title, $this->id));
      }

◆ patchUpReferences()

AutoForm::patchUpReferences ( )

Deprecated:

Attempt to patch up references in the data model to cope with PHP 4's insane object reference semantics. PHP 4 is now no longer actively supported by this framework, so this method is deprecated.

Definition at line 1760 of file auto_form.inc.

      {
           // Hack for PHP4 compatibility
           // Due to the indescribable brain-death that is PHP4's object reference semantics,
           // we have to resort to this method to try and ensure consistency within the form's
           // constituent objects. Oh, well.
  
           if (substr(phpVersion(), 0, 2) == "4.")
           {
                foreach(array_keys($this->renderers) as $renderer)
                {
                     $this->renderers[$renderer]->parent =& $this;
                }
                foreach(array_keys($this->overrides) as $override)
                {
                     $this->overrides[$override]["renderer"]->parent =& $this;
                }
           }
      }

◆ postProcessFields()

AutoForm::postProcessFields	(	$pk,
		$filter
	)

Definition at line 1705 of file auto_form.inc.

      {
           foreach (array_keys($this->fields) as $field)
           {
                if ($field != $pk  && !array_key_exists($field, $this->hidden) &&
                !($filter && $filter->isExcluded($field)))
                {
                     $renderer = $this->getRenderer($field);
                     if ($renderer)
                     {
                          $renderer->postProcess($field);
                     }
                }
           }
  
           foreach($this->additional as $r)
           {
                $renderer = $r['renderer'];
                $field = $r['field'];
  
                $renderer->postProcess($field);
           }
      }

◆ preProcessFields()

AutoForm::preProcessFields	(	$pk,
		$filter
	)

Definition at line 1681 of file auto_form.inc.

      {
           foreach (array_keys($this->fields) as $field)
           {
                if ($field != $pk  && !array_key_exists($field, $this->hidden) &&
                !($filter && $filter->isExcluded($field)))
                {
                     $renderer = $this->getRenderer($field);
                     if ($renderer)
                     {
                          $renderer->preProcess($field);
                     }
                }
           }
           
           foreach($this->additional as $r)
           {
                $renderer = $r['renderer'];
                $field = $r['field'];
  
                $renderer->preProcess($field);
           }
      }

◆ prettifyFieldName()

AutoForm::prettifyFieldName ( $field )

Generates a human-readable label from the given field name.

If an explicit alias has been specified using the alias() method, then that is returned. If not, a simple set of text replacements is performed.

Parameters

string $field the field to prettify

Returns: string

Definition at line 1512 of file auto_form.inc.

      {
           if (array_key_exists($field, $this->overrides))
           {
                $l = $this->overrides[$field]['label'];
                if ($l != "") return $l;
           }
  
           $field = preg_replace("/([a-z])([A-Z0-9])/", "$1 $2", $field);
           $field = str_replace("_", " ", $field);
  
           switch($this->capitalizationMode)
           {
           case "lower":
  
                $field = strtolower($field);
                break;
                     
           case "upper":
  
                $field = strtoupper($field);
                break;
                
           case "first":
                
                $field = ucfirst($field);
                break;
                
           case "word":
           default:
                
                $field = ucwords($field);
                break;
           }
  
           return $field;
      }

◆ radio()

AutoForm::radio	(	$field,
		$label,
		$options,
		$onchange = `null`
	)

Utility function to add a RadioButtonFieldRenderer.

Parameters

string	$field	the field name
string	$label	the label for the field
array	$options	associative array of grouped options

See also: RadioButtonFieldRenderer

Parameters

string $onchange Javascript onchange handler function name (optional)

Returns: RadioButtonFieldRenderer

Definition at line 768 of file auto_form.inc.

      {
           return new RadioButtonFieldRenderer($this, $field, $label, $options);
      }

◆ range()

AutoForm::range	(	$field,
		$min,
		$max,
		$message = `null`
	)

Adds a range validator to the specified field.

Definition at line 1073 of file auto_form.inc.

      {
           if ($this->data->hasField($field))
           {
                $this->validator->add(new RangeValidator($field, $this->prettifyFieldName($field), $min, $max, $message));
           }
      }

◆ readonly()

AutoForm::readonly ( )

Call this method to make one or more fields read-only in the form's user interface.

For instance, calling readonly("field1", "field3") would cause field1 and field3 to be rendered read-only.

Definition at line 910 of file auto_form.inc.

      {
           foreach(func_get_args() as $readonly)
           {
                $this->readonly[$readonly] = true;
           }
      }

◆ regexp()

AutoForm::regexp	(	$field,
		$expr,
		$message
	)

Validate the user input for the specified field against a regular expression, outputting the supplied message if the entered value does not match.

This can be used to provide general format-based validation for fields.

Parameters

string	$field	the field to be validated
string	$expr	the Regular Expression against which to validate
string	$message	the message to display if the match fails.

Definition at line 1014 of file auto_form.inc.

      {
           if ($this->data->hasField($field))
           {
                $this->validator->add(new RegularExpressionValidator($field, $this->prettifyFieldName($field), $expr, $message));
           }
      }

◆ registerFieldRendererClass()

static AutoForm::registerFieldRendererClass	(	$type,
		$rendererClass
	)

static

Registers a custom type-to-renderer mapping.

Parameters

string	$type	the type identifier
string	$rendererClass	the class name of the renderer to handle fields of this type

Definition at line 299 of file auto_form.inc.

      {
           AutoForm::$fieldRendererMap[$type] = $rendererClass;
      }

◆ related()

AutoForm::related	(	$class,
		$constraint = `""`,
		$format = `null`,
		$field = `null`,
		$label = `null`,
		$allowAdd = `false`,
		$allowNone = `true`
	)

Utility function to add a RelatedItemSelectFieldRender.

Definition at line 697 of file auto_form.inc.

      {
           $obj = new $class;
           if (!$format) $format = $obj->default_format;
           if (!$field) $field = $obj->getPrimaryKey();
           if (!$label) $label = $obj->prettifyClassName();
           
           if (!$this->data->hasField($field))
           {
                throw new FakoliException(get_class($this->data)." has no field '{$field}'");
           }
           
           if (!$format)
           {
                throw new FakoliException("Format not specified for related $class");
           }
           
           return new RelatedItemSelectFieldRenderer($this, $field, $label, $class, $constraint, $format, $obj->getPrimaryKey(), $allowAdd, $allowNone);
      }

◆ remove()

AutoForm::remove ( & $obj )

Definition at line 1729 of file auto_form.inc.

      {
           $obj->delete();
      }

◆ removeGroup()

AutoForm::removeGroup ( $name )

Remove the specified field grouping from the form.

Any fields within the group will be displayed ungrouped if they are not hidden.

Parameters

string $name the legend of the group

Definition at line 889 of file auto_form.inc.

      {
           unset($this->groups[$name]);
      }

◆ renderAdditionalFields()

AutoForm::renderAdditionalFields ( $obj )

Reimplemented in SearchForm.

Definition at line 1431 of file auto_form.inc.

      {
           foreach($this->additional as $r)
           {
                $renderer = $r['renderer'];
                // JDG 5/24/11 - fix get field name
                $field = $r['field'];
                if(!$field)
                     $field = $renderer->field;
           
                if(array_key_exists($field, $this->renderedFields))
                     continue;
                          
                if ($this->readonly[$field] || $this->readOnlyForm)
                {
                     $renderer->renderReadOnly($field);
                }
                else
                {
                     $renderer->renderField($field);
                }
           }         
      }

◆ renderAllFields()

AutoForm::renderAllFields ( $obj )

Definition at line 1330 of file auto_form.inc.

      {
           $this->renderedFields = array();
           
           if($this->additional_at_top)
                $this->renderAdditionalFields($obj);    
           $this->renderFields($obj);
           if(!$this->additional_at_top)
                $this->renderAdditionalFields($obj);         
      }

◆ renderFields()

AutoForm::renderFields ( $obj )

Definition at line 1346 of file auto_form.inc.

      {
           $filter = $obj->getFilter();
           
           if (count($this->groups) > 0)
           {
                $this->layout->endUngrouped();
                
                foreach($this->groups as $legend => $fields)
                {
                     $collapsible = array_key_exists($legend, $this->collapsibleGroups);
                     if ($collapsible)
                     {
                          $cf = $this->collapsibleGroups[$legend];
                          //AJG: Allow direct specification of boolean for collapsed group state
                          $collapsed = is_bool($cf) ? $cf : !$this->data->get($cf);
                     }
                     
                     $this->layout->startGroup($legend, $collapsible, $collapsed);
                     
                     foreach($fields as $field)
                     {
                          if ($field != $pk && !array_key_exists($field, $this->hidden) && !array_key_exists($field, $this->renderedFields) && 
                                    ($this->hasAdditional($field) || !($filter && $filter->isExcluded($field))))
                          {
                               $this->renderOneField($field);
                          }                        
                     }
                     
                     $this->layout->endGroup();
                }
                
                $this->layout->startUngrouped();
                
           }
           
           foreach($this->fieldOrder as $field)
           {
                if ($field != $pk && !array_key_exists($field, $this->hidden) && !array_key_exists($field, $this->renderedFields) &&
                     ($this->hasAdditional($field) || !($filter && $filter->isExcluded($field))))
                {
                     $this->renderOneField($field);
                }
           }
           
           foreach(array_keys($this->fields) as $field)
           {
                if ($field != $pk && !array_key_exists($field, $this->hidden) && !array_key_exists($field, $this->renderedFields) &&
                          ($this->hasAdditional($field) || !($filter && $filter->isExcluded($field))))
                {
                     $this->renderOneField($field);
                }
           }
      }

◆ renderOneField()

AutoForm::renderOneField	(	$field,
		$renderScript = `false`
	)

Definition at line 1401 of file auto_form.inc.

      {
           $renderer = $this->getRenderer($field);
                
           if ($renderer)
           {
                if ($this->readonly[$field] || $this->readOnlyForm)
                {
                     if (!$this->hideEmptyFields || !$this->data->hasField($field) ||  $this->data->get($field))
                     {
                          $renderer->renderReadOnly($field);
                     }
                }
                else
                {
                     if ($renderScript)
                     {
                          $renderer->renderScript($field);
                     }
                     $renderer->renderField($field);
                }
                
                $this->renderedFields[$field] = true;
           }
      }

◆ required()

AutoForm::required ( )

Call this method to mark one or more fields as being required fields.

These fields will be assigned validators to ensure that the user enters a value for each required field. For instance, calling required("field1", "field3") would cause field1 and field3 to be required fields.

Definition at line 933 of file auto_form.inc.

      {
           foreach(func_get_args() as $required)
           {
                if ($this->data->hasField($required) || $this->hasAdditional($required))
                {
                     array_push($this->required, $required);
                }
           }
      }

◆ requiredIfChecked()

AutoForm::requiredIfChecked	(	$field,
		$checkbox,
		$fieldTitle = `""`,
		$checkboxTitle = `""`,
		$message = `""`
	)

Make a field required if a given checkbox is checked.

Parameters

string	$field	the field to be validated
string	$checkbox	the checkbox controlling whether the field is required
string	$message	the message to display if validation fails.

Definition at line 977 of file auto_form.inc.

      {
           if ($this->data->hasField($field))
           {
                $this->validator->add(new RequiredIfCheckedValidator($field, $checkbox, 
                                                                                  $fieldTitle ? $fieldTitle : $this->prettifyFieldName($field), 
                                                                                  $checkboxTitle ? $checkboxTitle : $this->prettifyFieldName($checkbox), $message));
           }
      }

◆ requiredSubSelect()

AutoForm::requiredSubSelect	(	$field,
		$fieldTitle,
		$subFieldTitle = `""`,
		$message = `""`
	)

Make a subselect field required.

The main option must always be selected. If there is a sub-select option, that must also be selected.

Parameters

string	$field	the field to be validated
string	$fieldTitle	custom human-readable name for the field
string	$subFieldTitle	custom human-readable name for the sub-field
string	$message	the message to display if validation fails.

Definition at line 995 of file auto_form.inc.

      {
           if ($this->data->hasField($field))
           {
                $this->validator->add(new SubSelectFieldRequiredValidator($field, 
                                                                                        $fieldTitle ? $fieldTitle : $this->prettifyFieldName($field),  
                                                                                        $subFieldTitle, $message));
           }
      }

◆ save()

AutoForm::save ( )

Saves the posted values to the database.

Returns: boolean - true if the save was successful.

Reimplemented in SubordinateAutoForm.

Definition at line 1566 of file auto_form.inc.

      {
           $this->patchUpReferences();
  
           $this->configureValidators();
  
           $obj =& $this->data;
           $obj->fromPOST();
           
           $filter = $obj->getFilter();
           $pk = $obj->getPrimaryKey();
           
           if (isset($_POST["#FORMID#"]))
           {
                trace("FORM ID: {$this->id} - {$_POST["#FORMID#"]}", 3);
                $this->id = $_POST["#FORMID#"];
           }
  
           if (!isset($_POST["#SESSIONTIE#"]) || $_POST["#SESSIONTIE#"] != $_SESSION["csrfToken"])
           {
                trace("Invalid Session Token - {$_POST["#SESSIONTIE#"]} vs {$_SESSION["csrfToken"]}", 3);
                throw new FakoliException("Invalid Session Token");
           }
           
           if ($_POST["{$this->id}_delete"])
           {
                if(!$this->onDelete)
                {
                     $obj->delete(); // no callback function defined
                }
                else
                {
                     call_user_func_array($this->onDelete, array($obj));    
                }
                $this->deleted = true;
                return true;
           }
  
           $this->msg = $this->validator->validate();
           if ($this->msg != "") return $this->handlePartialSave(false);
  
           $this->preProcessFields($pk, $filter);
      
           // Call the onInsertPreProcess callback if the primary key of the target object is not set (i.e. is a new object)
           
           if (!$this->data->getPrimaryKeyValue() & $this->onInsertPreProcess)
           {
                if (call_user_func_array($this->onInsertPreProcess, array($this)) === false)
                {
                     return $this->handlePartialSave(false);
                }
           }
           
           // Call the onSavePreProcess callback if set
           
           if ($this->onSavePreProcess)
           {
                if (call_user_func_array($this->onSavePreProcess, array($this)) === false) 
                {
                     return $this->handlePartialSave(false);
                }
           }
           
           // Defer to the customSaveHandler if it has been defined, otherwise tell the target object to save itself
           
           if ($this->customSaveHandler)
           {
                if (!call_user_func_array($this->customSaveHandler, array($this))) 
                {
                     return $this->handlePartialSave(false);
                }
           }
           else
           {
                $obj->save();
           }
           
           $this->postProcessFields($pk, $filter);
           
           // onComplete event is fired once all processing has been completed
  
           if ($this->onSaveComplete)
           {
                call_user_func_array($this->onSaveComplete, array($this));
           }
  
           return $this->handlePartialSave(true);
      }

◆ setDataSet()

AutoForm::setDataSet ( $params )

Reimplemented in SubordinateAutoForm.

Definition at line 246 of file auto_form.inc.

      {
           $this->dataSet = $params;
      }

◆ setFieldOrder()

AutoForm::setFieldOrder ( )

Override the display order for ungrouped field.

Definition at line 263 of file auto_form.inc.

      {
           for($i = 0; $i < func_num_args(); ++$i)
           {
                $this->fieldOrder[] = func_get_arg($i);
           }
      }

◆ setGroupCSSClass()

AutoForm::setGroupCSSClass	(	$name,
		$cssClass
	)

Sets a specific CSS class on the specified CSS group.

Parameters

string	$name	the name of the group
string	$cssClass	the CSS class to apply to the group

Definition at line 869 of file auto_form.inc.

      {
           $this->groupCSSClasses[$name] = $cssClass;
      }

◆ setLayout()

AutoForm::setLayout ( $layout )

Override the default layout manager.

Definition at line 255 of file auto_form.inc.

      {
           $this->layout = $layout;
      }

◆ toggle()

AutoForm::toggle	(	$field,
		$label = `""`,
		$ragged = `false`
	)

Utility function to create a ToggleFieldRenderer.

Parameters

string	$field	the field name
string	$label	the label for the field

Definition at line 789 of file auto_form.inc.

      {
           $renderer = new ToggleFieldRenderer($this, $ragged);
           $this->override($field, $label, $renderer);
           return $renderer;
      }

◆ unique()

AutoForm::unique ( )

Adds a uniqueness validator to the specified field(s).

This is a server-side only validator that checks that the supplied value for the field is not present for any row in the underlying database table.

Definition at line 1048 of file auto_form.inc.

      {
           for($i = 0; $i < func_num_args(); $i += 2)
           {
                $field = func_get_arg($i);
                $message = func_get_arg($i + 1);
  
                if ($this->data->hasField($field))
                {
                     $this->validator->add(new UniqueValidator($field, $this->prettifyFieldName($field), $this->data, $message));
                }
           }
      }

◆ uniqueWithConstraint()

AutoForm::uniqueWithConstraint	(	$field,
		$message,
		$constraint = `""`
	)

Definition at line 1062 of file auto_form.inc.

      {
           if ($this->data->hasField($field))
           {
                $this->validator->add(new UniqueValidator($field, $this->prettifyFieldName($field), $this->data, $message, $constraint));
           }
      }

◆ validate()

AutoForm::validate ( )

Validate the posted values for the form.

This is performed automatically when calling AutoForm::save(), but sometimes it might be necessary to validate the form values manually (for instance, you might need to perform some destructive database operations prior to calling AutoForm::save(), but only if you know the form to be valid).

Any validation errors encountered are stored in the form, and will be displayed when the form is subsequently rendered.

Returns: true if the form is valid, false otherwise.

Definition at line 1746 of file auto_form.inc.

      {
           $this->patchUpReferences();
           $this->msg = $this->validator->validate();
           return ($this->msg == "");
      }

◆ writeScript()

AutoForm::writeScript ( )

This method writes any Javascript code that will be required for the generated form to operate, including code for Rich Text Editors, Date Pickers and field validation.

Returns: string the script required for the generated form.

Reimplemented in SearchForm, FilterForm, and SubordinateAutoForm.

Definition at line 374 of file auto_form.inc.

      {
           $this->patchUpReferences();
  
           ob_start();
  
           $this->configureValidators();
           
           $obj =& $this->data;
           $filter = $obj->getFilter();
           $pk = $obj->getPrimaryKey();
           
           $script = "";
           foreach(array_keys($this->fields) as $field)
           {
                if ($field != $pk && !($filter && $filter->isExcluded($field)))
                {
                     $renderer = $this->getRenderer($field);
                     if ($renderer)
                     {
                          $renderer->renderScript($field);
                     }
                }
           }
  
           foreach($this->additional as $r)
           {
                $r['renderer']->renderScript($r['field']);
           }
           
           echo "<script type='text/javascript'>\n";
           echo $this->validator->writeScript();
           echo "\n\n";
           echo "function onSubmit{$this->id}(form)\n{\n";
           
           echo "\tif (validate_{$this->id} != null && !validate_{$this->id}(form)) return false;\n";
  
           foreach(array_keys($this->fields) as $field)
           {
                if ($field != $pk && !($filter && $filter->isExcluded($field)))
                {
                     $renderer = $this->getRenderer($field);
                     if ($renderer)
                     {
                          $renderer->renderOnSubmitHandler($field);
                     }
                }
           }
  
           foreach($this->additional as $r)
           {
                $r['renderer']->renderOnSubmitHandler($r['field']);
           }
      
           if ($this->onSubmitHandler)
           {
                echo "\t if (!{$this->onSubmitHandler}(form)) return false;\n;";
           }
  
           if ($this->confirmPrompt)
           {
                echo "\t if (!confirm(\"".jsSafe($this->confirmPrompt)."\")) return false;\n";
           }
           
           if ($this->interstitialMessage)
           {
                echo "\tinterstitial('".jsSafe($this->interstitialMessage)."', '".jsSafe($this->interstitialSpinner)."');\n;";
           }
           
           echo "\treturn true;\n}\n\n";
           
           echo "\twindow.addEvent('domready', function() {\n";
  
           if ($this->allowPartialSave && $this->partialSaveContainerID)
           {
                $managerOptions = "{partialSaveContainer: '{$this->partialSaveContainerID}', partialSaveLabel: '{$this->partialSaveLabel}'}";
           }
           else
           {
                $managerOptions = "{}";
           }
           
           echo "\tnew AutoFormManager('{$this->id}', {$managerOptions});\n";
           
           if ($this->ajaxSubmitHandler && !$this->readOnlyForm)
           {
 ?>
      document.id('<?echo $this->id?>').iFrameFormRequest(
      {
           'onRequest': function() { return onSubmit<?echo $this->id?>(document.id('<?echo $this->id?>')); }, 
           'onComplete': <?echo $this->ajaxSubmitHandler; ?>, 
           'onFailure': <?echo $this->ajaxFailureHandler; ?>
      });
 <?
  
           }
  
           // Add collapsible group handlers
           
           foreach($this->collapsibleGroups as $group => $toggle)
           {
                if (is_bool($toggle))
                {
                     $groupID = $this->id . "_" . codify($group) . "_group";
                     echo "\tdocument.id('$groupID').getElement('legend').addEvent('click', function(e) { var g = document.id('$groupID'); if (g.hasClass('collapsed')) { g.removeClass('collapsed'); g.addClass('expanded'); } else { g.removeClass('expanded'); g.addClass('collapsed'); } });\n";
                     echo "\tdocument.id('$groupID').addClass('toggleSelf');\n";
                }
                else
                {    
                     $groupID = $this->id . "_" . codify($group) . "_group";
                     $toggleID = $this->id . "_" . $toggle;
                     
                     $renderer = $this->getRenderer($toggle);
                     if ($renderer instanceof BooleanFieldRenderer)
                     {
                          echo "\tdocument.id('$toggleID').addEvent('click', function(e) { AutoFormManager.toggleGroup('$groupID', this.checked); });\n";
                     }
                     else
                     {
                          echo "\tdocument.id('$toggleID').addEvent('change', function(e) { AutoFormManager.toggleGroup('$groupID', (this.value != '0')); });\n";
                     }
                }
           }
           echo "\t});\n";
           echo "</script>\n";
           $script = ob_get_contents();
           ob_end_clean();
           return $script;
      }

Member Data Documentation

◆ $action

AutoForm::$action = ""

Action URL for submitting the form. Generally this can be left blank to submit back to the same page.

Definition at line 68 of file auto_form.inc.

◆ $additional

AutoForm::$additional = array()

The additional (pseudo) fields collection.

Definition at line 73 of file auto_form.inc.

◆ $additional_at_top

AutoForm::$additional_at_top = false

whether additional fields are rendered above the datamodel's field list; if false, then rendered below

Definition at line 74 of file auto_form.inc.

◆ $ajaxFailureHandler

AutoForm::$ajaxFailureHandler = false

JavaScript Callback for AJAX Submit mode - called on failure.

Definition at line 104 of file auto_form.inc.

◆ $ajaxSubmitHandler

AutoForm::$ajaxSubmitHandler = false

JavaScript Callback for AJAX Submit mode - called on success.

Definition at line 103 of file auto_form.inc.

◆ $allowDelete

AutoForm::$allowDelete = false

If true, the form will display a delete button if editing an existing item.

Definition at line 63 of file auto_form.inc.

◆ $allowPartialSave

AutoForm::$allowPartialSave = false

Whether to allow partial (i.e. in-progress) saves via AJAX.

Definition at line 128 of file auto_form.inc.

◆ $annotations

AutoForm::$annotations = array()

The field annotations collection.

Definition at line 76 of file auto_form.inc.

◆ $buttonAlignment

AutoForm::$buttonAlignment = "left"

Default Form button alignment.

Definition at line 56 of file auto_form.inc.

◆ $buttonCSS

AutoForm::$buttonCSS = ""

CSS Class to use for buttons.

Definition at line 50 of file auto_form.inc.

◆ $buttonLineCSS

AutoForm::$buttonLineCSS = "submit"

CSS Class to use for the button line (container for form buttons)

Definition at line 51 of file auto_form.inc.

◆ $buttons

AutoForm::$buttons = array()

The custom buttons collection.

Definition at line 77 of file auto_form.inc.

◆ $buttons_at_top

AutoForm::$buttons_at_top = false

Definition at line 102 of file auto_form.inc.

◆ $capitalizationMode

AutoForm::$capitalizationMode = "word"

Capitalization to be used for labels. Can be 'lower', 'upper', 'first' or 'word'.

Definition at line 60 of file auto_form.inc.

◆ $checkboxCSS

AutoForm::$checkboxCSS = ""

CSS Class to use for checkbox fields.

Definition at line 53 of file auto_form.inc.

◆ $collapsibleGroups

AutoForm::$collapsibleGroups = array()

List of collapsible groups and their default states.

Definition at line 114 of file auto_form.inc.

◆ $componentPath

AutoForm::$componentPath ="/fakoli"

Definition at line 55 of file auto_form.inc.

◆ $confirmPrompt

AutoForm::$confirmPrompt = null

Specify a confirmation message. This will be shown to the user to have them confirm the form submission after the submit button is pressed.

Definition at line 97 of file auto_form.inc.

◆ $customSaveHandler

AutoForm::$customSaveHandler = null

Use this field to override the default save behavior of your form.

Definition at line 99 of file auto_form.inc.

◆ $default_layout

AutoForm::$default_layout = "table"

Definition at line 126 of file auto_form.inc.

◆ $deleteLabel

AutoForm::$deleteLabel = ""

Text to display on the form's delete button. If not specified defaut text will be generated based on the target DataItem.

Definition at line 64 of file auto_form.inc.

◆ $deleteMessage

AutoForm::$deleteMessage = ""

Confirmation message to display when the form's delete button is pressed. If not specified defaut text will be generated based on the target DataItem.

Definition at line 65 of file auto_form.inc.

◆ $fieldOrder

AutoForm::$fieldOrder = array()

The order in which to display ungrouped fields.

Definition at line 78 of file auto_form.inc.

◆ $fieldRendererMap

AutoForm::$fieldRendererMap

static

Initial value:

= array (
     'String'            =>   StringFieldRenderer,
     'HTML'                   =>   HTMLFieldRenderer,
          'Date'                   =>   DateFieldRenderer,
     'DateTime'               =>   DateTimeFieldRenderer,
     'Number'            =>   NumberFieldRenderer,
     'Currency'               =>   CurrencyFieldRenderer,
     'Currency3'              =>   Currency3FieldRenderer,
          'Boolean'           =>   BooleanFieldRenderer,
          'TimeZone'               =>   TimezoneFieldRenderer,
          'Password'               =>   PasswordFieldRenderer,
          'Text'                   =>   TextFieldRenderer,
          'Time'                   =>   TimeFieldRenderer,
          'Rating'            =>   RatingFieldRenderer,
          'ZipCode'           =>   ZipCodeFieldRenderer,
          'PhoneNumber'       =>   PhoneNumberFieldRenderer,
     'URL'                    =>   URLFieldRenderer,
     'DateOfBirth'       =>   DateOfBirthFieldRenderer,
     'CreditCardNumber'  => CreditCardNumberFieldRenderer,
     'Signature'              =>   SignatureFieldRenderer,
     'Color'                  =>   ColorFieldRenderer
     )

Provides the mapping from Type identifier to FieldRenderer.

Definition at line 134 of file auto_form.inc.

◆ $fields

AutoForm::$fields

Local field cache.

Definition at line 111 of file auto_form.inc.

◆ $formCSS

AutoForm::$formCSS = ""

CSS Class to use for the table containing the form.

Definition at line 47 of file auto_form.inc.

◆ $groupCSSClasses

AutoForm::$groupCSSClasses = array()

Additional classes for specific groups.

Definition at line 118 of file auto_form.inc.

◆ $groupDescriptionCSS

AutoForm::$groupDescriptionCSS = "group_description"

CSS class for group description blocks.

Definition at line 117 of file auto_form.inc.

◆ $groupDescriptions

AutoForm::$groupDescriptions = array()

List of group descriptions.

Definition at line 115 of file auto_form.inc.

◆ $groups

AutoForm::$groups = array()

List of field groups.

Definition at line 113 of file auto_form.inc.

◆ $hidden

AutoForm::$hidden = array()

The hidden fields collection.

Definition at line 72 of file auto_form.inc.

◆ $hideButtons

AutoForm::$hideButtons = false

Set to true to hide form submission button line(s)

Definition at line 59 of file auto_form.inc.

◆ $hideEmptyFields

AutoForm::$hideEmptyFields = false

Specifies whether to hide empty fields when displaying a read-only form.

Definition at line 122 of file auto_form.inc.

◆ $HTMLEditorDefaultHeight

AutoForm::$HTMLEditorDefaultHeight = "200px"

Default height for Rich Text Editor controls.

Definition at line 85 of file auto_form.inc.

◆ $HTMLEditorDefaultWidth

AutoForm::$HTMLEditorDefaultWidth = "540px"

Default width for Rich Text Editor controls.

Definition at line 84 of file auto_form.inc.

◆ $HTMLEditorHideStyleBar

AutoForm::$HTMLEditorHideStyleBar = false

Flag to indicate that Rich Text Editors should be displayed with or without the style editing toolbar.

Definition at line 83 of file auto_form.inc.

◆ $inputCSS

AutoForm::$inputCSS = ""

CSS Class to use for input fields.

Definition at line 52 of file auto_form.inc.

◆ $interstitialMessage

AutoForm::$interstitialMessage = null

Specifies the message to display in an interstitial while the form is being submitted.

Definition at line 108 of file auto_form.inc.

◆ $interstitialSpinner

AutoForm::$interstitialSpinner = '/fakoli/images/loader.gif'

Set this property to override the default interstitial spinner animation.

Definition at line 109 of file auto_form.inc.

◆ $labelCSS

AutoForm::$labelCSS = ""

CSS Class to use for label cells.

Definition at line 48 of file auto_form.inc.

◆ $layout

AutoForm::$layout

Layout handler object.

Definition at line 125 of file auto_form.inc.

◆ $markRequiredFields

AutoForm::$markRequiredFields = false

Set to true to add an asterisk after required field labels.

Definition at line 100 of file auto_form.inc.

◆ $method

AutoForm::$method = "POST"

HTTP method that will be used to submit the form.

Definition at line 67 of file auto_form.inc.

◆ $onDelete

AutoForm::$onDelete = ""

delete method name

Definition at line 98 of file auto_form.inc.

◆ $onDrawComplete

AutoForm::$onDrawComplete = null

Callback event handler that is fired just after the form been drawn.

Definition at line 91 of file auto_form.inc.

◆ $onDrawStart

AutoForm::$onDrawStart = null

Callback event handler that is fired just prior to drawing the form.

Definition at line 90 of file auto_form.inc.

◆ $onFormatLabel

AutoForm::$onFormatLabel = null

Label Processing hook.

Definition at line 101 of file auto_form.inc.

◆ $onInsertPreProcess

AutoForm::$onInsertPreProcess = null

Callback event handler that is fired after fields have been preprocessed, but before the data has been saved to the database as a new record.

Definition at line 93 of file auto_form.inc.

◆ $onSaveComplete

AutoForm::$onSaveComplete = null

Callback event handler that is fired after the AutoForm has finished saving data to the database.

Definition at line 95 of file auto_form.inc.

◆ $onSavePreProcess

AutoForm::$onSavePreProcess = null

Callback event handler that is fired after fields have been preprocessed, but before the data has been saved to the database.

Definition at line 94 of file auto_form.inc.

◆ $onSubmitHandler

AutoForm::$onSubmitHandler = null

Javascript Callback for user-defined onsubmit hook.

Definition at line 105 of file auto_form.inc.

◆ $overrides

AutoForm::$overrides = array()

The field overrides collection.

Definition at line 71 of file auto_form.inc.

◆ $partialSaveContainerID

AutoForm::$partialSaveContainerID

DOM ID for the element that will contain the partial save button.

Definition at line 129 of file auto_form.inc.

◆ $partialSaveLabel

AutoForm::$partialSaveLabel = "Save"

Label text for the partial save button.

Definition at line 130 of file auto_form.inc.

◆ $passwordConfirmLabel

AutoForm::$passwordConfirmLabel = "Confirm"

Text for Password Confirm label.

Definition at line 88 of file auto_form.inc.

◆ $passwordEncryptor

AutoForm::$passwordEncryptor = ""

Password Encryption method name.

Definition at line 57 of file auto_form.inc.

◆ $passwordEnterLabel

AutoForm::$passwordEnterLabel = "Enter"

Text for Password Enter label.

Definition at line 87 of file auto_form.inc.

◆ $readonly

AutoForm::$readonly = array()

The read-only fields collection.

Definition at line 75 of file auto_form.inc.

◆ $readOnlyForm

AutoForm::$readOnlyForm

Specifies whether the entire form is read-only.

Definition at line 120 of file auto_form.inc.

◆ $renderers

AutoForm::$renderers = array()

The field renderers collection.

Definition at line 70 of file auto_form.inc.

◆ $required

AutoForm::$required = array()

List of required fields.

Definition at line 106 of file auto_form.inc.

◆ $requiredFieldsText

AutoForm::$requiredFieldsText = "* indicates required field"

Text prompt to display when a form contains required fields.

Definition at line 107 of file auto_form.inc.

◆ $showAnnotations

AutoForm::$showAnnotations = true

Set to false to hide field annotations.

Definition at line 123 of file auto_form.inc.

◆ $style

AutoForm::$style = ""

Definition at line 54 of file auto_form.inc.

◆ $submitLabel

AutoForm::$submitLabel = ""

Text to display on the form's submit button. If not specified defaut text will be generated based on the target DataItem.

Definition at line 62 of file auto_form.inc.

◆ $subordinate

AutoForm::$subordinate

Specifies whether this form is a subordinate member of a composite form.

Definition at line 121 of file auto_form.inc.

◆ $useLinkSubmit

AutoForm::$useLinkSubmit = false

Flag to indicate whether the submit button for the form should be rendered as a link (not common).

Definition at line 81 of file auto_form.inc.

◆ $validator

AutoForm::$validator

The ValidationEngine for this form.

Definition at line 80 of file auto_form.inc.

◆ $valueCSS

AutoForm::$valueCSS = ""

CSS Class to use for field/value cells.

Definition at line 49 of file auto_form.inc.

The documentation for this class was generated from the following file:

C:/code/cms.sonjara.com/framework/auto_form.inc

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

◆ add()

◆ addDefaultValidators()

◆ addToGroup()

◆ ajaxSubmit()

◆ alias()

◆ annotate()

◆ AutoForm()

◆ button()

◆ checklist()

◆ configureValidators()

◆ createRenderer()

◆ crossReference()

◆ dateRange()

◆ disableAutoComplete()

◆ drawButtons()

◆ drawForm()

◆ drawReadOnly()

◆ drawSubmitButtons()

◆ dropdown()

◆ getData()

◆ getGroupCSSClass()

◆ getGroupDescription()

◆ getRenderer()

◆ getValidationEngine()

◆ group()

◆ groupDescription()

◆ groupedDropdown()

◆ handlePartialSave()

◆ hasAdditional()

◆ hide()

◆ hideExcept()

◆ hideLabel()

◆ isHidden()

◆ isReadOnly()

◆ isRequired()

◆ load()

◆ makeGroupCollapsible()

◆ makeSubordinate()

◆ match()

◆ matchesSubmitted()

◆ override()

◆ overrideType()

◆ partialSaveButton()

◆ password()

◆ patchUpReferences()

◆ postProcessFields()

◆ preProcessFields()

◆ prettifyFieldName()

◆ radio()

◆ range()

◆ readonly()

◆ regexp()

◆ registerFieldRendererClass()

◆ related()

◆ remove()

◆ removeGroup()

◆ renderAdditionalFields()

◆ renderAllFields()

◆ renderFields()

◆ renderOneField()

◆ required()

◆ requiredIfChecked()

◆ requiredSubSelect()

◆ save()

◆ setDataSet()

◆ setFieldOrder()

◆ setGroupCSSClass()

◆ setLayout()

◆ toggle()

◆ unique()

◆ uniqueWithConstraint()

◆ validate()

◆ writeScript()

Member Data Documentation