Displays a control that provides a highly styleable set of options from which the user can select a number of items. More...

Inheritance diagram for OptionCrossReferenceFieldRenderer:

Collaboration diagram for OptionCrossReferenceFieldRenderer:

Public Member Functions
	OptionCrossReferenceFieldRenderer (&$form, $field, $label, $options, $nameField, $xrefClass, $grouped=false)

	groupBy ($groupBy, $format="")

	renderScript ($field)
	FieldRenderers can override this method to provide any Javascript that their control requires for an edit form. More...

	renderField ($field)
	FieldRenderers must override this method to provide the HTML implementation of the control used to edit the field. More...

	renderOptions ($field, $options, $selectedItems)

	renderReadOnly ($field)

	getSelected ($obj, $rc, $pk)

	getMatchingPK ($xref, $obj)

	postProcess ($field="")
	FieldRenderers can override this method to provide behavior that occurs after the parent form's target object has been saved to the database. More...

	clearOutRelations ($obj, $pk, $tx)
	Clear out the current relations stored in the xref class. More...

Public Member Functions inherited from FieldRenderer
	FieldRenderer ($parent)
	Constructor. More...

	_printLabel ($field, $colspan=1, $styles="", $annotation="")
	Internal method to generate the HTML for the field label. More...

	_getLabel ($field, $addSuffix=true)

	_startField ($field, $styles="")
	Internal method to generate the starting HTML for the field (including the label) More...

	_endField ($field)
	Internal method to generate the closing HTML for the field. More...

	addValidatorsToForm ($field, $required=false)
	This method is called by the AutoForm to add any default input validators that are required by the FieldRenderer. More...

	addSearchValidatorsToForm ($field, $mode, $required=false)
	For SearchForm, the validator field needs to match the name tag in the form which is in the format field:mode. More...

	formatName ($item, $name)
	Formats the given DataItem based on the supplied format string. More...

	renderSearchScript ($field, $mode)
	FieldRenderers can override this method to provide any Javascript that the control requires when being used in a search form. More...

	renderSearchField ($field, $mode)
	FieldRenderers must override this method to provide the HTML implementation of the control displayed for the field in a search form. More...

	renderOnSubmitHandler ($field)
	FieldRenderers can override this method to provide any Javascript that must be executed when the form is submitted on the client. More...

	preProcess ($field="")
	FieldRenderers can override this method to provide behavior that occurs prior to the saving of the parent form's target object to the database. More...

Public Attributes
	$options = array()

	$cssClass = "options_list"

	$separator = ", "

	$nameField

	$xrefClass

	$onStartOption = null

	$grouped = false

	$groupTag = "h4"

	$containerClass = ""

Public Attributes inherited from FieldRenderer
	$parent = null

	$labelSuffix = ""

	$colspan = 1

	$annotateBefore = false

	$annotateNextLine = true

	$hideLabel = false

	$onPreProcess = null
	callback hook for processing prior to saving the form's data object - individual renderers may override with custom processing More...

	$onPostProcess = null
	callback hook for processing after saving the form's data object - individual renderers may override with custom processing More...

Detailed Description

Displays a control that provides a highly styleable set of options from which the user can select a number of items.

The options are provided as an array of DataItems that are associated with the target item of the form via a cross-reference table that contains foreign keys to both. The options are rendered as an unordered list in HTML, with javascript to provide the selection interaction. Clicking on one of the items will select the associated value. The currently selected list item is given the "selected" CSS class.

Options can be grouped by three distinct mechanisms. Firstly, the array of items passed in can be an associative array with the group headings as the keys. Secondly the options can be automatically grouped by the values in a specified field by calling the groupBy() method with the name of the field and a formatting string for the group heading. Finally the options can be grouped by a secondary list of DataItems by passing an array to the groupBy() method. In this case the options will be grouped by the primary key values of the supplied objects, and must contain a matching foreign key.

Author: Andy

Definition at line 21 of file option_cross_reference_field_renderer.inc.

Member Function Documentation

◆ clearOutRelations()

OptionCrossReferenceFieldRenderer::clearOutRelations	(	$obj,
		$pk,
		$tx
	)

Clear out the current relations stored in the xref class.

Parameters

Object	$obj
String	$pk

Definition at line 311 of file option_cross_reference_field_renderer.inc.

      {
           $xref = new $this->xrefClass;
           $xref->joinTransaction($tx);
           $xref->delete("WHERE {$pk}=".$obj->get($pk));
      }    

◆ getMatchingPK()

OptionCrossReferenceFieldRenderer::getMatchingPK	(	$xref,
		$obj
	)

Definition at line 245 of file option_cross_reference_field_renderer.inc.

      {
           $pks = $obj->getPrimaryKeyList();
           foreach($pks as $pk)
           {
                if ($xref->hasField($pk)) return $pk;
           }
      
           throw new DataItemException("No matching foreign key in xref table");
      }

◆ getSelected()

OptionCrossReferenceFieldRenderer::getSelected	(	$obj,
		$rc,
		$pk
	)

Definition at line 240 of file option_cross_reference_field_renderer.inc.

      {
           return ($obj->get($pk) != "") ? indexedQuery($this->xrefClass, "WHERE {$pk}={$obj->get($pk)}", $rc->getPrimaryKey()) : array();
      }

◆ groupBy()

OptionCrossReferenceFieldRenderer::groupBy	(	$groupBy,
		$format = `""`
	)

Definition at line 53 of file option_cross_reference_field_renderer.inc.

      {
           $this->groupBy = $groupBy;
           $this->groupByFormat = $format;
      }

◆ OptionCrossReferenceFieldRenderer()

OptionCrossReferenceFieldRenderer::OptionCrossReferenceFieldRenderer	(	&	$form,
			$field,
			$label,
			$options,
			$nameField,
			$xrefClass,
			$grouped = `false`
	)

Definition at line 33 of file option_cross_reference_field_renderer.inc.

      {
           $this->options = $options;
           $this->nameField = $nameField;
           $this->xrefClass = $xrefClass;
           $this->grouped = $grouped;
           
           $this->FieldRenderer($form);
           if ($form->data->hasField($field))
           {
                $form->override($field, $label, $this);
           }
           else
           {
                $form->add($this, $field);
                if ($label) $form->alias($field, $label);
           }
      }

◆ postProcess()

OptionCrossReferenceFieldRenderer::postProcess ( $field = "" )

FieldRenderers can override this method to provide behavior that occurs after the parent form's target object has been saved to the database.

For example, the CrossReferenceSelectFieldRenderer overrides this method to update crossference tables based on the user's selection.

Parameters

string $field

Reimplemented from FieldRenderer.

Definition at line 256 of file option_cross_reference_field_renderer.inc.

      {
           if (count($this->options) == 0) return;
  
           $xref = new $this->xrefClass;
           
           $obj = $this->parent->data;
           $pk =  $this->getMatchingPK($xref, $obj);
           
           if (is_array($this->groupBy) && count($this->groupBy) > 0)
           {
                $keys = array_keys($this->options);
                $rc = $this->options[$keys[0]][0];
           }
           else
           {
                $rc = $this->options[0];
           }
           
           $optpk = $this->getMatchingPK($xref, $rc);
      
           $tx = new DataTransaction();
           try 
           {
                $this->clearOutRelations($obj, $pk, $tx);
           
                if (isset($_POST[$field]))
                {
                     $ids = explode(",", $_POST[$field]);
                          
                     foreach($ids as $id)
                     {
                          $xref = new $this->xrefClass;
                          $xref->joinTransaction($tx);
                          $xref->set($pk, $obj->get($pk));
                          $xref->set($optpk, $id);
                          $xref->save();
                     }
                }
                
                $tx->commit();
           } 
           catch (Exception $e) 
           {
                $tx->rollback();
                throw $e;
           }         
      }

◆ renderField()

OptionCrossReferenceFieldRenderer::renderField ( $field )

FieldRenderers must override this method to provide the HTML implementation of the control used to edit the field.

Parameters

string $field the field name

Reimplemented from FieldRenderer.

Definition at line 100 of file option_cross_reference_field_renderer.inc.

      {
           $this->_startField($field);
                     
           trace("# of Options: ".count($this->options), 3);
           
           if (count($this->options))
           {
                if ($this->containerClass) { echo "<div class='{$this->containerClass}'>\n"; }
                
                $obj = $this->parent->data;
  
                if (is_array($this->groupBy) && count($this->groupBy) > 0)
                {
                     $keys = array_keys($this->options);
                     $rc = $this->options[$keys[0]][0];
                }
                else if ($this->grouped)
                {
                     $keys = array_keys($this->options);
                     $rc = $this->options[$keys[0]][0];
                }
                else
                {
                     $rc = $this->options[0];
                }
                $pk = $obj->getPrimaryKey();
                
                if (!$rc)
                {
                     $this->_endField($field);
                     return;
                }
                
                $selectedItems = $this->getSelected($obj, $rc, $pk);
  
                
                $value = implode(",", array_keys($selectedItems));
                
                $id = "{$this->parent->id}_{$field}";
                
                echo "<input type='hidden' id='{$id}' name='{$field}' value='{$value}'/>";
                          
                if (is_array($this->groupBy) && count($this->groupBy) > 0)
                {
                     $gpk = $this->groupBy[0]->getPrimaryKey();
                                    
                     foreach($this->groupBy as $group)
                     {
                          if (array_key_exists($group->get($gpk), $this->options))
                          {
                               echo $group->format($this->groupByFormat);
                               $this->renderOptions($field, $this->options[$group->get($gpk)], $selectedItems); 
                          }
                     }
                }
                else if (is_string($this->groupBy))
                {
                     trace("Rendering grouped by", 3);
                     $options = regroupList($this->options, $this->groupBy);
      
                     foreach($options as $group => $choices)
                     {
                          echo "<{$this->groupTag}>$group</{$this->groupTag}>";
                          $this->renderOptions($field, $choices, $selectedItems);
                     }
                }
                else if ($this->grouped)
                {
                     trace("Rendering grouped", 3);
                     foreach($this->options as $group => $choices)
                     {
                          echo "<{$this->groupTag}>$group</{$this->groupTag}>";
                          $this->renderOptions($field, $choices, $selectedItems);
                     }
                }              
                else
                {
                     trace("Rendering simple", 3);
                     $this->renderOptions($field, $this->options, $selectedItems);
                }
                
                if ($this->containerClass) { echo "</div>\n"; }
           }
           $this->_endField($field);
      }

◆ renderOptions()

OptionCrossReferenceFieldRenderer::renderOptions	(	$field,
		$options,
		$selectedItems
	)

Definition at line 187 of file option_cross_reference_field_renderer.inc.

      {
           $id = "{$this->parent->id}_{$field}";
  
           echo "<ul class='{$id}_list {$this->cssClass}'>";
           foreach($options as $option)
           {
                $val = $option->get($option->getPrimaryKey());
                $classes = array();
                if (array_key_exists($val, $selectedItems)) $classes[] = "selected";
           
                if ($this->onStartOption)
                {
                     $flag = call_user_func($this->onStartOption, $option);
                     if ($flag === false) continue;
                     if ($flag) $classes[] = $flag;
                }
           
                $classes = implode(" ", $classes);
           
                $description = $this->formatName($option, $this->nameField);
                echo "<li class='{$classes}' data-value='{$val}' onclick='{$id}_update(this); return false;'>{$description}</li>\n";
           }
           echo "</ul>";
      }

◆ renderReadOnly()

OptionCrossReferenceFieldRenderer::renderReadOnly ( $field )

Definition at line 213 of file option_cross_reference_field_renderer.inc.

      {
           $this->_startField($field);
           
           if (count($this->options))
           {
  
                $obj = $this->parent->data;
                
                $rc = $this->options[0];
                $pk = $obj->getPrimaryKey();
                     
                $selectedItems = $this->getSelected($obj, $rc, $pk);
                
                $selected = array();
                foreach($this->options as $option)
                {
                     $val = $option->get($option->getPrimaryKey());
                     if (array_key_exists($val, $selectedItems)) $selected[] = $option;
                }
                
                echo formatItems($selected, "{".$this->nameField."}", $this->separator);
           }
           
           $this->_endField($field);
      }

◆ renderScript()

OptionCrossReferenceFieldRenderer::renderScript ( $field )

FieldRenderers can override this method to provide any Javascript that their control requires for an edit form.

Parameters

string $field the field name

Reimplemented from FieldRenderer.

Definition at line 59 of file option_cross_reference_field_renderer.inc.

      {
           if ($this->parent->readOnlyForm || $this->parent->isReadOnly($field)) return;
           $id = "{$this->parent->id}_{$field}";
           ?>
      <script type='text/javascript'>
      function <?echo $id?>_update(sel)
      {
           if (sel.hasClass("selected"))
           {
                sel.removeClass("selected");
           }
           else
           {
                sel.addClass("selected");
           }
           
           var values = [];
           
           $$('.<?echo $id?>_list > li').each(function(elt) 
           { 
                if (elt.hasClass('selected'))
                {
                     var v = elt.get('data-value');
                     values.push(v);
                }
           });
  
           var hidden = document.id('<?echo $id?>');
           var v = hidden.value;
           hidden.value = values.join(",");
           var f = document.id('<?echo $this->parent->id?>');
           if (v != hidden.value && f && f.manager)
           {
                f.manager.dirty();
           }
      }
      </script>
 <?
      }