auto_form.inc

Go to the documentation of this file.

<?php
/**************************************************************
 
 Copyright (c) 2007-2010 Sonjara, Inc
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
 files (the "Software"), to deal in the Software without
 restriction, including without limitation the rights to use,
 copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the
 Software is furnished to do so, subject to the following
 conditions:
 
 The above copyright notice and this permission notice shall be
 included in all copies or substantial portions of the Software.
 
 Except as contained in this notice, the name(s) of the above 
 copyright holders shall not be used in advertising or otherwise 
 to promote the sale, use or other dealings in this Software 
 without prior written authorization.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 OTHER DEALINGS IN THE SOFTWARE.
 
*****************************************************************/
 
require_once realpath(dirname(__FILE__)."/auto_form_layout.inc");
require_once realpath(dirname(__FILE__)."/validation.inc");
require_once realpath(dirname(__FILE__)."/field_renderers.inc");
 
class AutoForm
{
     var $formCSS = "";                      
     var $labelCSS = "";                     
     var $valueCSS = "";                     
     var $buttonCSS = "";                    
     var $buttonLineCSS = "submit";          
     var $inputCSS = "";                     
     var $checkboxCSS = "";                  
     var $style = "";
     var $componentPath ="/fakoli";
     var $buttonAlignment = "left";          
     var $passwordEncryptor = "";       
 
     var $hideButtons = false;               
     var $capitalizationMode = "word";  
 
     var $submitLabel = "";                  
     var $allowDelete = false;               
     var $deleteLabel = "";                  
     var $deleteMessage = "";           
     
     var $method = "POST";                   
     var $action = "";                       
 
     var $renderers = array();               
     var $overrides = array();               
     var $hidden = array();                  
     var $additional = array();              
     var $additional_at_top = false;         
     var $readonly = array();           
     var $annotations = array();             
     var $buttons = array();                 
     var $fieldOrder = array();              
     
     var $validator;                              
     var $useLinkSubmit = false;             
 
     var $HTMLEditorHideStyleBar = false;    
     var $HTMLEditorDefaultWidth = "540px";  
     var $HTMLEditorDefaultHeight = "200px"; 
 
     var $passwordEnterLabel = "Enter";      
     var $passwordConfirmLabel = "Confirm";  
     
     var $onDrawStart = null;                
     var $onDrawComplete = null;        
     
     var $onInsertPreProcess = null;         
     var $onSavePreProcess = null;           
     var $onSaveComplete = null;             
 
     var $confirmPrompt = null;              
     var $onDelete = "";                     
    var $customSaveHandler = null;      
     var $markRequiredFields = false;   
     var $onFormatLabel = null;              
    var $buttons_at_top = false;
    var $ajaxSubmitHandler = false;          
    var $ajaxFailureHandler = false;    
    var $onSubmitHandler = null;        
    var $required = array();            
    var $requiredFieldsText = "* indicates required field"; 
     var $interstitialMessage = null;   
     var $interstitialSpinner = '/fakoli/images/loader.gif'; 
     
    var $fields;    
 
    var $groups = array();                   
    var $collapsibleGroups = array();   
    var $groupDescriptions = array();   
    
    var $groupDescriptionCSS = "group_description";    
    var $groupCSSClasses = array();     
    
    var $readOnlyForm;  
    var $subordinate;    
    var $hideEmptyFields = false; 
    var $showAnnotations = true; 
    
    var $layout; 
    var $default_layout = "table";
    
    var $allowPartialSave = false;      
     var $partialSaveContainerID;  
     var $partialSaveLabel = "Save";    
    
    // When adding new renderers, must also update
    // DataItem $dataTypeRendererMap
    static $fieldRendererMap = 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
     );   
     
     function AutoForm($target, $method="POST", $action="", $id="")
     {
          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);
     }
     
     function getData()
     {
          return $this->data;
     }
 
     function setDataSet($params)
     {
          $this->dataSet = $params;
     }
     
     function setLayout($layout)
     {
          $this->layout = $layout;
     }
     
     function setFieldOrder()
     {
          for($i = 0; $i < func_num_args(); ++$i)
          {
               $this->fieldOrder[] = func_get_arg($i);
          }
     }
     
     function createRenderer($field)
     {
          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'");
     }
 
     static function registerFieldRendererClass($type, $rendererClass)
     {
          AutoForm::$fieldRendererMap[$type] = $rendererClass;
     }
     
     function addDefaultValidators()
     {
          $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);
          }
     }
 
     function getValidationEngine()
     {
          return $this->validator;
     }
     
     function makeSubordinate()
     {
          $this->subordinate = true;
     }
     
     function configureValidators()
     {
          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;
     }
     
     function writeScript()
     {
          $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;
     }
 
     function getRenderer($field)
     {
          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;
     }
 
     function override($field, $label = "", $renderer = null)
     {
          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;
          }
     }
 
     function overrideType($field, $type, $label = "")
     {
          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'");
     }
 
     function add($renderer, $field = "", $label = "")
     {
          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);
          }
     }
 
     function hide()
     {
          foreach(func_get_args() as $hidden)
          {
               $this->hidden[$hidden] = true;
          }
     }
     
     function hideExcept()
     {
          $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;
               }
          }
     }
 
     function isHidden($field)
     {
          return array_key_exists($field, $this->hidden) ? $this->hidden[$field] : false;
     }
     
     function annotate($field, $text)
     {
          $this->annotations[$field] = $text;
     }
 
     function alias()
     {
          for($i = 0; $i < func_num_args(); $i += 2)
          {
               $field = func_get_arg($i);
               $label = func_get_arg($i + 1);
               $this->override($field, $label);
          }
     }
 
     function related($class, $constraint = "", $format = null, $field = null, $label = null, $allowAdd = false, $allowNone = true)
     {
          $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);
     }
     
     function crossReference($xrefClass, $options, $format, $field, $label = null, $xrefField = null)
     {
          if (!$label) $label = prettify($field);
          return new CrossReferenceSelectFieldRenderer($this, $field, $label, $options, $format, $xrefClass, $xrefField);
     }
     
     function dropdown($field, $label = "", $options = null, $onchange = null, $grouped = false)
     {
          return new SelectFieldRenderer($this, $field, $label, $options, $onchange, $grouped);
     }
 
     function groupedDropdown($field, $label, $options, $onchange = null)
     {
          return $this->dropdown($field, $label, $options, $onchange, true);
     }
     
     function radio($field, $label, $options, $onchange = null)
     {
          return new RadioButtonFieldRenderer($this, $field, $label, $options);
     }
     
     function checklist($field, $label, $options, $grouped = false)
     {
          return new CheckListFieldRenderer($this, $field, $label, $options, $grouped);
     }
     
     function toggle($field, $label = "", $ragged = false)
     {
          $renderer = new ToggleFieldRenderer($this, $ragged);
          $this->override($field, $label, $renderer);
          return $renderer;
     }
     
     function group($name)
     {
          $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;
     }
     
     function addToGroup($name)
     {
          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);
          }
     }
     
     function groupDescription($name, $description, $position = 'start')
     {
          $this->groupDescriptions["{$name}:{$position}"] = $description;
     }
     
     function getGroupDescription($name, $position = 'start')
     {
          $key = "{$name}:{$position}";
          if (array_key_exists($key, $this->groupDescriptions)) return $this->groupDescriptions[$key];
          return "";
     }
     
     function makeGroupCollapsible($name, $toggleControl)
     {
          $this->collapsibleGroups[$name] = $toggleControl;
     }
     
     function setGroupCSSClass($name, $cssClass)
     {
          $this->groupCSSClasses[$name] = $cssClass;
     }
     
     function getGroupCSSClass($name)
     {
          return array_key_exists($name, $this->groupCSSClasses) ? $this->groupCSSClasses[$name] : "";
     }
     
     function removeGroup($name)
     {
          unset($this->groups[$name]);
     }
     
     function hideLabel()
     {
          foreach(func_get_args() as $naked)
          {
               $this->getRenderer($naked)->hideLabel = true;
          }
     }
     
     function readonly()
     {
          foreach(func_get_args() as $readonly)
          {
               $this->readonly[$readonly] = true;
          }
     }
 
     function isReadOnly($field)
     {
          return $this->readonly[$field];
     }
     function required()
     {
          foreach(func_get_args() as $required)
          {
               if ($this->data->hasField($required) || $this->hasAdditional($required))
               {
                    array_push($this->required, $required);
               }
          }
     }
     
     function hasAdditional($field)
     {
          foreach($this->additional as $r)
          {
               $renderer = $r['renderer'];
               $rField = $r['field'];
               trace("## $field == $rField", 3);
               if($rField == $field)
                    return true;
          }
 
          return $false;
     }
 
     function isRequired($field)
     {
          return (array_search($field, $this->required) !== FALSE) ? true : false;
     }
 
     function requiredIfChecked($field, $checkbox, $fieldTitle = "", $checkboxTitle = "", $message = "")
     {
          if ($this->data->hasField($field))
          {
               $this->validator->add(new RequiredIfCheckedValidator($field, $checkbox, 
                                                                                 $fieldTitle ? $fieldTitle : $this->prettifyFieldName($field), 
                                                                                 $checkboxTitle ? $checkboxTitle : $this->prettifyFieldName($checkbox), $message));
          }
     }
     
     function requiredSubSelect($field, $fieldTitle, $subFieldTitle = "", $message = "")
     {
          if ($this->data->hasField($field))
          {
               $this->validator->add(new SubSelectFieldRequiredValidator($field, 
                                                                                       $fieldTitle ? $fieldTitle : $this->prettifyFieldName($field),  
                                                                                       $subFieldTitle, $message));
          }
     }
     
     function regexp($field, $expr, $message)
     {
          if ($this->data->hasField($field))
          {
               $this->validator->add(new RegularExpressionValidator($field, $this->prettifyFieldName($field), $expr, $message));
          }
     }
     
     function dateRange($field, $min = "", $max = "", $message = null)
     {
          if ($this->data->hasField($field))
          {
               $this->validator->add(new DateRangeValidator($field, $this->prettifyFieldName($field), $min, $max, $message));
          }
     }
     
     function unique()
     {
          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));
               }
          }
     }
 
     function uniqueWithConstraint($field, $message, $constraint = "")
     {
          if ($this->data->hasField($field))
          {
               $this->validator->add(new UniqueValidator($field, $this->prettifyFieldName($field), $this->data, $message, $constraint));
          }
     }
     
     function range($field, $min, $max, $message = null)
     {
          if ($this->data->hasField($field))
          {
               $this->validator->add(new RangeValidator($field, $this->prettifyFieldName($field), $min, $max, $message));
          }
     }
 
     function match($field, $title, $match, $matchTitle, $caseSensitive = true)
     {
          $this->validator->add(new MatchValidator($field, $title, $match, $matchTitle, $caseSensitive));
     }
 
     function password($field, $title)
     {
          $this->validator->add(new PasswordValidator($field, $title, $this->id));
     }
 
     function disableAutoComplete()
     {
          $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;
                    }
               }
          }
     }
               
     function button($text, $url, $confirm = null, $isScript = false, $cssClass = null)
     {
          $this->buttons[] = array('text' => $text, 'url' => $url, 'confirm' => $confirm, 'isScript' => $isScript, 'cssClass' => $cssClass);
     }
 
     function ajaxSubmit($success, $failure = null)
     {
          if ($failure == null)
          {
               $failure = "function() {document.id('{$form->id}_error').set('text','Failed to communicate with server'); }";
          }
          
          $this->ajaxSubmitHandler = $success;
          $this->ajaxFailureHandler = $failure;
     }
     
     function partialSaveButton($containerID, $label = "Save")
     {
          $this->allowPartialSave = true;
          $this->partialSaveContainerID = $containerID;
          $this->partialSaveLabel = $label;
     }
      
     function matchesSubmitted()
     {
          return (isset($_POST["#FORMID#"]) && $_POST["#FORMID#"] == $this->id);
     }
 
     function drawForm()
     {
          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));
          }
     }
     
     /*
      * JDG 12/17/2010 - break out from drawForm into into function 
      */
     function drawSubmitButtons($obj, $pk, $submitLabel)
     {
          $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}\");'/>";
          }    
     }
     
     function renderAllFields($obj)
     {
          $this->renderedFields = array();
          
          if($this->additional_at_top)
               $this->renderAdditionalFields($obj);    
          $this->renderFields($obj);
          if(!$this->additional_at_top)
               $this->renderAdditionalFields($obj);         
     }
     
     /*
      * JDG 9/14/2010
      * Break out this function to facilitate inheritence 
      * when fields needs custom layout.
      */
     function renderFields($obj)
     {
          $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);
               }
          }
     }
 
     function renderOneField($field, $renderScript = false)
     {
          $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;
          }
     }
     
     /*
      * JDG 12/17/2010 - break out into function to allow option
      * to render additional fields at the top.
      */
     function renderAdditionalFields($obj)
     {
          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);
               }
          }         
     }
 
     function drawButtons()
     {
          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']}\"/>";
          }
 
     }
 
     function drawReadOnly()
     {
          $this->readOnlyForm = true;
          
          $this->layout->startUngrouped();
          
          $obj =& $this->data;
          
          $this->renderAllFields($obj);
          
          $this->layout->endUngrouped();     
 
          $this->layout->finalizeLayout();
     }
 
     function prettifyFieldName($field)
     {
          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;
     }
 
     function load($id)
     {
          $this->data->load($id);
     }
 
     function save()
     {
          $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);
     }
 
     function handlePartialSave($success)
     {
          // 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;
     }
     
     function preProcessFields($pk, $filter)
     {
          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);
          }
     }
     
     function postProcessFields($pk, $filter)
     {
          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);
          }
     }
     
     function remove(&$obj)
     {
          $obj->delete();
     }
 
     function validate()
     {
          $this->patchUpReferences();
          $this->msg = $this->validator->validate();
          return ($this->msg == "");
     }
     
     function patchUpReferences()
     {
          // 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;
               }
          }
     }
}
 
 
?>