spreadsheet_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__)."/composite_auto_form.inc");
 
class SpreadsheetForm extends CompositeAutoForm
{    
     var $colCount = 0;
     var $subform;                      
     var $columnWidths = array();  
     var $msg;                          
     var $onStartRow = null;       
     var $isRowSelected = null;    
     var $isRowEmpty = null;            
     var $rowLabelFormat = null;
     var $rowLabelTitle = null;
     var $rowLabelDefaultText = "";
     var $emptyMessage = "The spreadsheet is empty"; 
     var $onFormChanged = null; 
     var $ajaxSubmitHandler = false;         
     var $ajaxFailureHandler = false;   
     
     function SpreadsheetForm($subform, $items = array(), $blanks = 5, $method="POST", $action="", $id="", $onStartRow = null, $isRowSelected = null)
     {
          $this->subform = $subform;
          $this->onStartRow = $onStartRow;
          $this->isRowSelected = $isRowSelected;
          
          // Create one instance of AutoForm to apply certain setting
          // for all forms, e.g., aliases and hiddens
          parent::CompositeAutoForm($method, $action);
          $this->formCSS = "list spreadsheet";
          $this->layout = AutoFormLayout::create("spreadsheet", $this);
 
          $target = $subform->data;
          
          $this->id = get_class($target)."_form";
          
          for($i=0; $i < $blanks; $i++)
          {
               $items[] = clone($target);
          }         
 
          $this->createSpreadsheetRowForms($items, $subform);
     }    
     
     function showRowLabels($columnTitle, $format, $defaultText)
     {
          $this->rowLabelTitle = $columnTitle;
          $this->rowLabelFormat = $format;
          $this->rowLabelDefaultText = $defaultText;
     }
     
     function createSpreadsheetRowForms($items, $subform)
     {
          $subform->subordinate = true;
          $subform->layout = AutoFormLayout::create("table_row", $subform);
 
          // Don't allow HTMLEditor in spreadsheet form,
          // override with Text Editor
          $fields = $subform->data->getFields();
          foreach($fields as $field => $type)
          {
               $renderer = $subform->getRenderer($field);
               if(get_class($renderer) == "HTMLFieldRenderer")
               {
                    $subform->override($field, "", new TextFieldRenderer($subform));
               }         
          }
          
          $idx = 1;
          foreach($items as $item)
          {
               $this->createOneSpreadsheetRow($item, clone($subform), clone($subform->validator), $idx);           
               $idx++;
          }
     }
     
     function createOneSpreadsheetRow($item, $row, $validator, $idx)
     {
          $layout = "table_row";
          
          if ($this->onStartRow) 
          {
               $ret = call_user_func($this->onStartRow, $item);
          }
          
          // If the row callback explicitly returns false, omit this row
          if ($ret === false) return;
          
          $row->data =& $item;
          $row->id = $this->id . "_$idx";
          $row->validator = $validator;
          $row->validator->id = $row->id;
          if ($ret) $row->formCSS = $ret;
          
          
          $fields = $row->data->getFields();
          // clone a new instance of each field renderer
          // created for the template subform.
          foreach($fields as $field => $type)
          {
               if ($item->filter && $item->filter->isExcluded($field)) continue;
               
               $r = $row->getRenderer($field);
               if($r)
               {
                    $renderer = clone($r);
                    $renderer->parent = $row;
                    $row->override($field, "", $renderer);
               }         
          }
          
          $additional = array();
          foreach($row->additional as $r)
          {
               $renderer = $r['renderer'];
               // JDG 5/24/11 - fix get field name
               $r2 = clone($renderer);
               $r2->parent = &$row;
               $r['renderer'] = $r2;
               
               $additional[] = $r;
               
               trace("#@#@#@ ID: {$r2->parent->id}", 3);
               $row->override($r['field'], $r['label'], $r2);
          }
          
          $row->additional = $additional;
                    
          trace(print_r($row->additional, true), 3);
          
          //$form = SubordinateAutoForm::create($this, $row, true);
          $subform = new SubordinateAutoForm($this, $row, true);
 
          if ($this->isRowSelected)
          {
               $layout = "selectable_table_row";
               $subform->isSelected = call_user_func($this->isRowSelected, $item);
          }    
          
          $subform->form->layout = AutoFormLayout::create($layout, $subform);
 
          if ($ret)
          {
               $subform->containerClass = trim($this->containerClass. " " . $ret);
          }
     }
     
     function setColumnWidth($field, $width)
     {
          $this->columnWidths[$field] = $width;
     }
 
     function ajaxSubmit($success, $failure = null)
     {
          $id = $this->id ? $this->id : "composite_auto_form";
          if ($failure == null)
          {
               $failure = "function() {document.id('{$id}_error').set('text','Failed to communicate with server'); }";
          }
          
          $this->ajaxSubmitHandler = $success;
          $this->ajaxFailureHandler = $failure;
     }
     
     function writeScript()
     {
          if (!count($this->forms)) return;
          
          $script = parent::writeScript();
          
          $id = $this->id ? $this->id : "composite_auto_form";
          
          if ($this->onFormChanged) $options = "onFormChanged: {$this->onFormChanged}";
          
          $script .= <<<ENDSCRIPT
          <script type='text/javascript'>
          window.addEvent('domready', function()
          {
               document.id('{$id}').manager = new SpreadsheetFormManager('{$id}', {{$options}});              
          });
          </script>
ENDSCRIPT;
               
          if ($this->ajaxSubmitHandler && !$this->readOnlyForm)
          {
               $script .= <<<ENDSCRIPT
     <script>
     document.id('{$id}').iFrameFormRequest(
     {
          'onRequest': function() { return onCompositeFormSubmit(document.id('{$id}')); }, 
          'onComplete': {$this->ajaxSubmitHandler}, 
          'onFailure': {$this->ajaxFailureHandler}
     });
     </script>
ENDSCRIPT;
          }
               
          return $script;
     }
     
     function drawForm()
     {    
          if (!count($this->forms))
          {
               echo $this->emptyMessage;
               return;
          }
          
          $id = $this->id ? $this->id : "composite_auto_form";
               
          echo "<form id='$id' method='{$this->method}' action='{$this->action}' enctype='multipart/form-data'";
          echo " onsubmit='return onCompositeFormSubmit(this);'";
          echo ">\n";
               
          $layout = ($this->isRowSelected) ? "selectable_table_header" : "table_header";
          $form = $this->subform;
          $form->layout = AutoFormLayout::create($layout, $form);
          $obj =& $form->getData();
          $pk = $obj->getPrimaryKey();
     
          $filter = $obj->getFilter();
          $fields = $obj->getFields();
 
          
          if ($this->layout->externalErrorBox) $this->layout->errorBox();
          
          if ($this->buttons_at_top) 
          {
               echo "<p>";
               $this->drawButtons();
               echo "</p>";
          }
          
          if (!$this->layout->externalErrorBox) $this->layout->errorBox();
          
          if ($form->markRequiredFields && $form->validator->hasRequiredFields())
          {
               $this->layout->requiredFields($form->requiredFieldsText);
          }
                    
          $this->layout->startUngrouped();
     
          // Draw headings
          echo "<thead><tr>\n";
          
          if ($this->isRowSelected)
          {
               echo "<th>&nbsp;</th>";
          }
          
          if ($this->rowLabelTitle)
          {
               echo "<th>{$this->rowLabelTitle}</th>";
          }
          
          foreach($fields as $field => $type)
          {
               if ($field != $pk && !array_key_exists($field, $form->hidden) && !($filter && $filter->isExcluded($field)))
               {
                    $renderer = $form->getRenderer($field);
                    if($renderer)
                    {
                         $styles = "text-align: center;";
                         if(array_key_exists($field, $this->columnWidths))
                         {
                              $width = $this->columnWidths[$field];
                              if ($width)
                              {
                                   if (is_numeric($width))
                                   {
                                        $styles .= " width: {$width}px";
                                   }
                                   else
                                   {
                                        $styles .= "width: {$width}";
                                   }
                              }
                         }
                         $renderer->_printLabel($field, 1, $styles);
                         $this->colCount++;
                    }
               }
          }    
 
          foreach($form->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, $form->hidden))
                    continue;
                         
               $styles = "text-align: center;";
               if(array_key_exists($field, $this->columnWidths))
               {
                    $width = $this->columnWidths[$field];
                    if ($width)
                    {
                         if (is_numeric($width))
                         {
                              $styles .= " width: {$width}px";
                         }
                         else
                         {
                              $styles .= "width: {$width}";
                         }
                    }
               }
               $renderer->_printLabel($field, 1, $styles);
               $this->colCount++;
          }         
          echo "</tr></thead>\n";       
          
          foreach($this->forms as $form)
          {
               ob_start();
               $form->drawForm();
               $output = ob_get_contents();
               ob_end_clean();
               
               $output = preg_replace("/\\bname=(['\"])([^'\"]*?)['\"]/", "name=$1{$form->id}__$2$1", $output);
 
               if ($this->rowLabelTitle)
               {
                    $output = preg_replace("/<tr id=(.*?)>/", "<tr id=$1><td>".($form->getData()->format($this->rowLabelFormat))."</td>", $output);
               }
               
               //$form->form->layout->startUngrouped();
               echo $output;
               //$form->form->layout->endUngrouped();
          }
 
          $this->layout->endUngrouped();
          $this->drawButtons();         
          echo "</form>\n";
     }
     
     function save()
     {
          global $method;
     
          // Do magic
     
          $valid = true;
 
          
          foreach($this->forms as $form)
          {
               if ($this->isRowSelected != null)
               {
                    // Selectable mode - skip form save if not selected
 
                    if (!$_POST[$form->id."__#selected"])                       
                    {
                         trace("SKIPPING {$form->id}", 4);
                         continue;
                    }
               }
               
               foreach($_POST as $name => $value)
               {
                    if (strpos($name, "__") === false)
                    {
                         unset($_POST[$name]);
                    }
               }
 
               $prefix = $form->id."__";
               $len = strlen($prefix);
                    
               foreach($_POST as $name => $value)
               {
                    if (!strncmp($name, $prefix, $len))
                    {
                         $_POST[substr($name, $len)] = $value;
                    }
               }
               
               if (is_callable($this->isRowEmpty))
               {
                    if (call_user_func($this->isRowEmpty)) continue;
               }
               
               if (!$form->save()) $valid = false;
          }
     
          return $valid;
     }
     /*
      * Create a queryString containing all the
      * keys of the objects that saved successfully
      * to use to reload the page after save.
      */
     function getQueryString($qs = "")
     {
          $values = array();
          
          foreach($this->forms as $form)
          {
               $obj = $form->getData();
               $pk = $obj->getPrimaryKey();
               $val = $obj->$pk;
               if($val)
               {
                    $name = "{$form->id}_$pk}";
                    $params .= $sep.urlencode($pk)."[".urlencode($name)."]=".urlencode($val);
                    $sep = "&";
               }
          }
          
          if($params && $qs)
               $params = appendToQueryString($qs, $params);
          
          return $params;
     }
}
?>