Field renderer for handling taxonomy term relationships. More...

Inherits FieldRenderer.

Public Member Functions
	TaxonomyTermFieldRenderer (&$form, $taxonomy)

	setSize ($width, $height)

	groupBy ($groupBy, $format="")

	renderScript ($field)

	renderSearchScript ($field, $mode)

	getMatchingPK ($xref, $obj)

	renderField ($field="")

	renderCheckboxes ($field, $items, $selected, $mode=null)

	renderReadOnly ($field="")

	renderSearchField ($field, $mode)

	preProcess ($field="")

	postProcess ($field="")

Public Attributes
	$field

	$label

	$taxonomy

	$dropdown

	$dropdownMaxWidth = "340px"

	$dropdownMessage = "Click to Select Terms"

	$options

	$showSelectAll

	$resizable = true

Static Public Attributes
static	$readOnlyTermSeparator = "<br>"

Detailed Description

Field renderer for handling taxonomy term relationships.

Definition at line 44 of file taxonomy_term_field_renderer.inc.

Member Function Documentation

◆ getMatchingPK()

TaxonomyTermFieldRenderer::getMatchingPK	(	$xref,
		$obj
	)

Definition at line 151 of file taxonomy_term_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");
      }

◆ groupBy()

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

Definition at line 88 of file taxonomy_term_field_renderer.inc.

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

◆ postProcess()

TaxonomyTermFieldRenderer::postProcess ( $field = "" )

Definition at line 325 of file taxonomy_term_field_renderer.inc.

      {
           if (count($this->options) == 0) return;
           
           $obj = $this->parent->data;
           $class = get_class($obj);
           $pk = $obj->get($obj->getPrimaryKey());
           
           $assoc = new TaxonomyTermAssociation();
           $assoc->delete("WHERE class='$class' AND taxonomy_id={$this->taxonomy->taxonomy_id} AND id=$pk");
           
           if (isset($_POST[$this->field]))
           {
                foreach($_POST[$this->field] as $term_id => $dummy)
                {
                     $assoc = new TaxonomyTermAssociation();
                     $assoc->class = $class;
                     $assoc->taxonomy_id = $this->taxonomy->taxonomy_id;
                     $assoc->id = $pk;
                     $assoc->term_id = $term_id;
                     $assoc->save();
                }
           }
      }

◆ preProcess()

TaxonomyTermFieldRenderer::preProcess ( $field = "" )

Definition at line 305 of file taxonomy_term_field_renderer.inc.

      {
           if (count($this->options) == 0) return;
           
           $obj = $this->parent->data;
           if ($obj->hasField($this->field) && is_array($_POST[$this->field]))
           {
                // If overriding a field, unpack the terms
                $terms = array();
                foreach($_POST[$this->field] as $term_id => $dummy)
                {
                     $terms[] = new TaxonomyTerm($term_id);
                }
                
                $obj->set($this->field, formatItems($terms, "{term}", ","));
           }
           
           return true;
      }

◆ renderCheckboxes()

TaxonomyTermFieldRenderer::renderCheckboxes	(	$field,
		$items,
		$selected,
		$mode = `null`
	)

Definition at line 209 of file taxonomy_term_field_renderer.inc.

      {
           foreach($items as $item)
           {
                $p = $item->term_id;
                
                $name = $mode ? "{$field}:{$mode}" : $field;
                $val = $mode ? $p : "1";
                
                echo "<label for='checkbox_{$field}_$p'><input type='checkbox' class='checkbox' name='{$name}[$p]' id='checkbox_{$field}_$p' value='{$val}'";
                if (array_key_exists($p, $selected))
                {
                     echo " checked";
                }
                echo ">";
                echo $item->term."</label>";
           }
      }

◆ renderField()

TaxonomyTermFieldRenderer::renderField ( $field = "" )

Definition at line 162 of file taxonomy_term_field_renderer.inc.

      {
           if (count($this->options) == 0) return;
           
           $field = $this->field;
           
           $this->_startField($field);
           
           $obj = $this->parent->data;
           
           if ($this->showSelectAll)
           {
                echo "<a href='#' onclick='return {$this->parent->id}_{$field}_toggleSelectAll(this);'>Select All</a><br/>";
           }
           if ($this->width && $this->height)
           {
                $width = is_numeric($this->width) ? "{$this->width}px" : $this->width;
                $height = is_numeric($this->height) ? "{$this->height}px" : $this->height;
                $padding = ($width == "auto") ? "padding-right: 20px; overflow-x: hidden" : "";
                
                $resizable = ($this->resizable && !$this->dropdown) ? " resizable": "";
                $dropdown = $this->dropdown ? " multi_select_dropdown_list" : "";
                echo "<div id='{$this->parent->id}_{$field}_container' class='scrollbox{$resizable}{$dropdown}' style='width: {$width}; height: {$height};overflow: auto; $padding'>\n";
           }
           
           $countOptions = count($this->options);
           
           $class = get_class($obj);
           $pk = $obj->get($obj->getPrimaryKey());
           
           $selected = IndexedQuery::create(TaxonomyTermAssociation, "WHERE taxonomy_id=:id AND class=:class AND id=:pk", "term_id")
                                         ->bind(":id", $this->taxonomy->taxonomy_id, ":class", $class, ":pk", $pk)
                                         ->execute();
                                         
           $this->renderCheckBoxes($field, $this->options, $selected);  
  
           if ($this->width && $this->height)
           {
                echo "</div>\n";
           }
  
           // Save this count to loop through checkboxes on required validation
           echo "<input type=\"hidden\" name=\"count_{$field}\" value=\"$countOptions\">";      
           
           $this->_endField($field);
      }

◆ renderReadOnly()

TaxonomyTermFieldRenderer::renderReadOnly ( $field = "" )

Don't display the taxonomy if nothing selected

Definition at line 228 of file taxonomy_term_field_renderer.inc.

      {
           if (count($this->options) == 0) return;
           
           $field = $this->field;
           
           $obj = $this->parent->data;
                     
           $class = get_class($obj);
           $pk = $obj->get($obj->getPrimaryKey());
           
           $selected = IndexedQuery::create(TaxonomyTermAssociation, "WHERE taxonomy_id=:id AND class=:class AND id=:pk", "term_id")
                                         ->bind(":id", $this->taxonomy->taxonomy_id, ":class", $class, ":pk", $pk)
                                         ->execute();
                                         
           foreach($this->options as $option)
           {
                $p = $option->term_id;
                     
                if (array_key_exists($p, $selected))
                {
                     $answers[] = $option->term;
                }
           }
           
           if(count($answers))
           {
                $this->_startField($field);
                echo implode(TaxonomyTermFieldRenderer::$readOnlyTermSeparator, $answers);
                $this->_endField($field);
           }
      }

◆ renderScript()

TaxonomyTermFieldRenderer::renderScript ( $field )

Definition at line 94 of file taxonomy_term_field_renderer.inc.

      {
           if ($this->showSelectAll)
           {
 ?>
 <script type="text/javascript">
  
 function <?echo $this->parent->id?>_<?echo $this->field ?>_toggleSelectAll(link)
 {
      link = document.id(link);
      
      var value = (link.innerHTML == "Select All");
  
      var container = document.id('<?echo $this->parent->id?>_<?echo $this->field?>_container');
      
      container.getElements("input[type=checkbox]").each(function(cbox)
      {
           cbox.set('checked', value);
      });
  
      link.innerHTML = (value) ? "Deselect All" : "Select All";
      if (container.multiSelect) container.multiSelect.selectionChanged();
      return false;
 }
  
 </script>
 <?
           }
           
           if ($this->dropdown)
           {
 ?>
 <script type='text/javascript'>
 window.addEvent('domready', function()
 {
      new MultiSelect('<?echo $this->parent->id?>_<?echo $this->field?>_container', {maxWidth: '<?echo $this->dropdownMaxWidth?>', message: '<?echo jsSafe($this->dropdownMessage)?>'});
 });
 </script>                
 <?
           }
      }

◆ renderSearchField()

TaxonomyTermFieldRenderer::renderSearchField	(	$field,
		$mode
	)

Definition at line 265 of file taxonomy_term_field_renderer.inc.

      {
           $this->_startField($field);
           
  
           $obj = $this->parent->data;
           
           if ($this->width && $this->height)
           {
                $width = is_numeric($this->width) ? "{$this->width}px" : $this->width;
                $height = is_numeric($this->height) ? "{$this->height}px" : $this->height;
                $padding = ($width == "auto") ? "padding-right: 20px; overflow-x: hidden" : "";
           
                $resizable = ($this->resizable && !$this->dropdown) ? " resizable": "";
                $dropdown = $this->dropdown ? " multi_select_dropdown_list" : "";
                echo "<div id='{$this->parent->id}_{$field}_container' class='scrollbox{$resizable}{$dropdown}' style='width: {$width}; height: {$height};overflow: auto; $padding'>\n";
           }
           
           $countOptions = count($this->options);
           
           $class = get_class($obj);
           $pk = $obj->get($obj->getPrimaryKey());
           
           $selected = IndexedQuery::create(TaxonomyTermAssociation, "WHERE taxonomy_id=:id AND class=:class AND id=:pk", "term_id")
                                         ->bind(":id", $this->taxonomy->taxonomy_id, ":class", $class, ":pk", $pk)
                                         ->execute();
           
           $this->renderCheckBoxes($field, $this->options, $selected, $mode);
  
           if ($this->width && $this->height)
           {
                echo "</div>\n";
           }
  
           // Save this count to loop through checkboxes on required validation
           echo "<input type=\"hidden\" name=\"count_{$field}\" value=\"$countOptions\">";      
  
           $this->_endField($field);
      }

◆ renderSearchScript()

TaxonomyTermFieldRenderer::renderSearchScript	(	$field,
		$mode
	)

Definition at line 136 of file taxonomy_term_field_renderer.inc.

      {
  
           if ($this->dropdown)
           {
                ?>
           <script type='text/javascript'>
           window.addEvent('domready', function()
           {
                new MultiSelect('<?echo $this->parent->id?>_<?echo $this->field?>_container', {maxWidth: '<?echo $this->dropdownMaxWidth?>', message: '<?echo jsSafe($this->dropdownMessage)?>'});
           });
           </script>                
           <?
           }
      }

◆ setSize()

TaxonomyTermFieldRenderer::setSize	(	$width,
		$height
	)

Definition at line 82 of file taxonomy_term_field_renderer.inc.

      {
           $this->width = $width;
           $this->height = $height;
      }

◆ TaxonomyTermFieldRenderer()

TaxonomyTermFieldRenderer::TaxonomyTermFieldRenderer	(	&	$form,
			$taxonomy
	)

Definition at line 58 of file taxonomy_term_field_renderer.inc.

      {
           $this->taxonomy = $taxonomy;
           $this->field = $taxonomy->identifier;
           $this->label = $taxonomy->taxonomy_name;
           $this->options = $taxonomy->Terms("ORDER BY sort_order, term");
           $this->dropdown = true;
           
           $this->showSelectAll = true;
           
           $this->FieldRenderer($form);
           
           // JDG 7/31/2011 - allow override
           if ($form->data->hasField($this->field))
           {
                $form->override($this->field, $label, $this);
           }
           else
           {
                $form->add($this, $this->field);
                $form->overrides[$this->field]['label'] = $label;
           }    
      }