Inheritance diagram for SpreadsheetForm:

Collaboration diagram for SpreadsheetForm:

Public Member Functions
	SpreadsheetForm ($subform, $items=array(), $blanks=5, $method="POST", $action="", $id="", $onStartRow=null, $isRowSelected=null)
	Creates a new SpreadsheetForm. More...

	showRowLabels ($columnTitle, $format, $defaultText)

	createSpreadsheetRowForms ($items, $subform)

	createOneSpreadsheetRow ($item, $row, $validator, $idx)

	setColumnWidth ($field, $width)
	Set the td width for the table. More...

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

	writeScript ()
	Generates the Javascript for all the subforms, and creates a SpreadsheetFormManager object. More...

	drawForm ()
	Draws the spreadsheet. More...

	save ()
	Overrides CompositeAutoForm::save() to provide support for selectable spreadsheet forms. More...

	getQueryString ($qs="")

Public Member Functions inherited from CompositeAutoForm
	CompositeAutoForm ($method="POST", $action="", $containerClass="")
	Creates a new CompositeAutoForm. More...

	addForm ($form, $enableValidation=false)
	Add a sub-form to this form. More...

	preset ()
	Array of fields to be ignored when determining if a record is empty in cases where empty records should not trigger an error. More...

	drawReadOnly ()
	Draw the read-only sub-forms. More...

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

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

Public Attributes
	$colCount = 0

	$subform
	The prototype subform used to model each row in the spreadsheet. More...

	$columnWidths = array()
	Array of column widths, used to control relative cell sizes in the table output. More...

	$msg
	Text to appear below buttons at top and above table. More...

	$onStartRow = null
	Callback hook to determine row style or suppression of row. More...

	$isRowSelected = null
	Callback hook to determine whether a given row is selected. Assigning a callback to this hook turns on selection mode. Only selected sub-forms are saved. More...

	$isRowEmpty = null
	Callback hook to determine if a given row should be saved, or skipped because it is an empty row. More...

	$rowLabelFormat = null

	$rowLabelTitle = null

	$rowLabelDefaultText = ""

	$emptyMessage = "The spreadsheet is empty"
	The message to display if the item list is empty and the number of blank rows is set to zero. More...

	$onFormChanged = null
	Javascript function to be called when any value is changed within the spreadsheet. More...

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

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

Public Attributes inherited from CompositeAutoForm
	$forms

	$buttons = array()

	$method

	$action

	$containerClass

	$buttonAlignment = "left"

	$preset = array()

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

	$onSaveComplete = null
	Callback event handler that is fired after all the subordinate AutoForms have finished saving data to the database. More...

Detailed Description

SpreadsheetForm.

Provides input forms in a spreadsheet layout where each row is a subform containing one dataitem object's field renderers.

Definition at line 48 of file spreadsheet_form.inc.

Member Function Documentation

◆ ajaxSubmit()

SpreadsheetForm::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 234 of file spreadsheet_form.inc.

      {
           $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;
      }

◆ createOneSpreadsheetRow()

SpreadsheetForm::createOneSpreadsheetRow	(	$item,
		$row,
		$validator,
		$idx
	)

Definition at line 146 of file spreadsheet_form.inc.

      {
           $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);
           }
      }

◆ createSpreadsheetRowForms()

SpreadsheetForm::createSpreadsheetRowForms	(	$items,
		$subform
	)

Definition at line 121 of file spreadsheet_form.inc.

      {
           $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++;
           }
      }

◆ drawForm()

SpreadsheetForm::drawForm ( )

Draws the spreadsheet.

Each row is a subordinate form instance with the renderers cloned from the prototype row form supplied in the constructor.

Reimplemented from CompositeAutoForm.

Definition at line 289 of file spreadsheet_form.inc.

      {    
           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";
      }

◆ getQueryString()

SpreadsheetForm::getQueryString ( $qs = "" )

Definition at line 489 of file spreadsheet_form.inc.

      {
           $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;
      }

◆ save()

SpreadsheetForm::save ( )

Overrides CompositeAutoForm::save() to provide support for selectable spreadsheet forms.

See also: CompositeAutoForm::save()

Reimplemented from CompositeAutoForm.

Definition at line 433 of file spreadsheet_form.inc.

      {
           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;
      }

◆ setColumnWidth()

SpreadsheetForm::setColumnWidth	(	$field,
		$width
	)

Set the td width for the table.

Parameters

string	$field
number	$width

Definition at line 223 of file spreadsheet_form.inc.

      {
           $this->columnWidths[$field] = $width;
      }

◆ showRowLabels()

SpreadsheetForm::showRowLabels	(	$columnTitle,
		$format,
		$defaultText
	)

Definition at line 114 of file spreadsheet_form.inc.

      {
           $this->rowLabelTitle = $columnTitle;
           $this->rowLabelFormat = $format;
           $this->rowLabelDefaultText = $defaultText;
      }

◆ SpreadsheetForm()

SpreadsheetForm::SpreadsheetForm	(	$subform,
		$items = `array()`,
		$blanks = `5`,
		$method = `"POST"`,
		$action = `""`,
		$id = `""`,
		$onStartRow = `null`,
		$isRowSelected = `null`
	)

Creates a new SpreadsheetForm.

Parameters

AutoForm	$subform	an instance of AutoForm containing the target DataItem object. The target should have the filters set as desired and those filters will apply to all objects displayed in the spreadsheet. The "template" form should have any field aliases, hidden fields, and any other options set. The template form will be used for all the items displayed.
array	$items	array of dataitem objects to be displayed in an editable table row. If you wish to display only empty rows, send an empty array.
number	$blanks	the number of blank rows desired, 0 if only previously saved dataitem objects supplied in the items array will be displayed.
string	$method	the form submission method (i.e. GET or POST)
string	$action	the target action URI (leave blank for default post-back processing)
string	$id	the DOM id for the spreadsheet
string	$onStartRow	callback to be called before generating each row
string	$isRowSelected	callback to determine the selection status for each row

Definition at line 90 of file spreadsheet_form.inc.

      {
           $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);
      }    

◆ writeScript()

SpreadsheetForm::writeScript ( )

Generates the Javascript for all the subforms, and creates a SpreadsheetFormManager object.

Reimplemented from CompositeAutoForm.

Definition at line 249 of file spreadsheet_form.inc.

      {
           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;
      }

Member Data Documentation

◆ $ajaxFailureHandler

SpreadsheetForm::$ajaxFailureHandler = false

JavaScript Callback for AJAX Submit mode - called on failure.

Definition at line 63 of file spreadsheet_form.inc.

◆ $ajaxSubmitHandler

SpreadsheetForm::$ajaxSubmitHandler = false

JavaScript Callback for AJAX Submit mode - called on success.

Definition at line 62 of file spreadsheet_form.inc.

◆ $colCount

SpreadsheetForm::$colCount = 0

Definition at line 50 of file spreadsheet_form.inc.

◆ $columnWidths

SpreadsheetForm::$columnWidths = array()

Array of column widths, used to control relative cell sizes in the table output.

Definition at line 52 of file spreadsheet_form.inc.

◆ $emptyMessage

SpreadsheetForm::$emptyMessage = "The spreadsheet is empty"

The message to display if the item list is empty and the number of blank rows is set to zero.

Definition at line 60 of file spreadsheet_form.inc.

◆ $isRowEmpty

SpreadsheetForm::$isRowEmpty = null

Callback hook to determine if a given row should be saved, or skipped because it is an empty row.

Definition at line 56 of file spreadsheet_form.inc.

◆ $isRowSelected

SpreadsheetForm::$isRowSelected = null

Callback hook to determine whether a given row is selected. Assigning a callback to this hook turns on selection mode. Only selected sub-forms are saved.

Definition at line 55 of file spreadsheet_form.inc.

◆ $msg

SpreadsheetForm::$msg

Text to appear below buttons at top and above table.

Definition at line 53 of file spreadsheet_form.inc.

◆ $onFormChanged

SpreadsheetForm::$onFormChanged = null

Javascript function to be called when any value is changed within the spreadsheet.

Definition at line 61 of file spreadsheet_form.inc.

◆ $onStartRow

SpreadsheetForm::$onStartRow = null

Callback hook to determine row style or suppression of row.

Definition at line 54 of file spreadsheet_form.inc.

◆ $rowLabelDefaultText

SpreadsheetForm::$rowLabelDefaultText = ""

Definition at line 59 of file spreadsheet_form.inc.

◆ $rowLabelFormat

SpreadsheetForm::$rowLabelFormat = null

Definition at line 57 of file spreadsheet_form.inc.

◆ $rowLabelTitle

SpreadsheetForm::$rowLabelTitle = null

Definition at line 58 of file spreadsheet_form.inc.

◆ $subform

SpreadsheetForm::$subform

The prototype subform used to model each row in the spreadsheet.

Definition at line 51 of file spreadsheet_form.inc.

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

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

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ ajaxSubmit()

◆ createOneSpreadsheetRow()

◆ createSpreadsheetRowForms()

◆ drawForm()

◆ getQueryString()

◆ save()

◆ setColumnWidth()

◆ showRowLabels()

◆ SpreadsheetForm()

◆ writeScript()

Member Data Documentation

◆ $ajaxFailureHandler

◆ $ajaxSubmitHandler

◆ $colCount

◆ $columnWidths

◆ $emptyMessage

◆ $isRowEmpty

◆ $isRowSelected

◆ $msg

◆ $onFormChanged

◆ $onStartRow

◆ $rowLabelDefaultText

◆ $rowLabelFormat

◆ $rowLabelTitle

◆ $subform