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

Inherits FieldRenderer.

Public Member Functions
	BindingTargetFieldRenderer (&$form, $bindingTarget)

	setSize ($width, $height)

	renderScript ($field)

	getMatchingPK ($xref, $obj)

	renderField ($field="")

	renderCheckboxes ($field, $items, $selected)

	renderReadOnly ($field="")

	postProcess ($field="")

Public Attributes
	$field

	$label

	$bindingTarget

	$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 357 of file taxonomy_term_field_renderer.inc.

Member Function Documentation

◆ BindingTargetFieldRenderer()

BindingTargetFieldRenderer::BindingTargetFieldRenderer	(	&	$form,
			$bindingTarget
	)

Definition at line 371 of file taxonomy_term_field_renderer.inc.

      {
           trace("## Creating BindingTargetFieldRenderer for {$bindingTarget->target_class}", 3);
           
           $this->bindingTarget = $bindingTarget;
           $this->field = $bindingTarget->target_class;
           $proto = new $bindingTarget->target_class;
           $this->label = $proto->prettifyClassName(true);
           
           $this->options = TaxonomyManager::getBindingOptions($bindingTarget->target_class);
           $this->format = TaxonomyManager::$bindableClasses[$bindingTarget->target_class]["format"];
           
           trace("## Found ".count($this->options)," options");
           
           $this->dropdown = true;
  
           $this->showSelectAll = true;
  
           $this->FieldRenderer($form);
  
           $field = $this->field;
           $label = $this->label;
           
           // JDG 7/31/2011 - allow override
           if ($form->data->hasField($field))
           {
                $form->override($field, $label, $this);
           }
           else
           {
                $form->add($this, $field);
                $form->overrides[$field]['label'] = $label;
           }
      }

◆ getMatchingPK()

BindingTargetFieldRenderer::getMatchingPK	(	$xref,
		$obj
	)

Definition at line 454 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");
      }

◆ postProcess()

BindingTargetFieldRenderer::postProcess ( $field = "" )

Definition at line 564 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 BindingRecord();
           $assoc->delete("WHERE target_class='{$this->bindingTarget->target_class}' AND class='$class' AND id=$pk");
           
           if (isset($_POST[$this->field]))
           {
                foreach($_POST[$this->field] as $target_id => $dummy)
                {
                     $assoc = new BindingRecord();
                     $assoc->class = $class;
                     $assoc->target_class = $this->bindingTarget->target_class;
                     $assoc->id = $pk;
                     $assoc->target_id = $target_id;
                     $assoc->save();
                }
           }
      }

◆ renderCheckboxes()

BindingTargetFieldRenderer::renderCheckboxes	(	$field,
		$items,
		$selected
	)

Definition at line 512 of file taxonomy_term_field_renderer.inc.

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

◆ renderField()

BindingTargetFieldRenderer::renderField ( $field = "" )

Definition at line 465 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(BindingRecord, "WHERE target_class=:tc AND class=:class AND id=:pk", "target_id")
                                         ->bind(":tc", $this->bindingTarget->target_class, ":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()

BindingTargetFieldRenderer::renderReadOnly ( $field = "" )

Don't display the taxonomy if nothing selected

Definition at line 528 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(BindingRecord, "WHERE target_class=:tc AND class=:class AND id=:pk", "target_id")
                                         ->bind(":tc", $this->bindingTarget->target_class, ":class", $class, ":pk", $pk)
                                         ->execute();
                                         
           foreach($this->options as $option)
           {
                $p = $option->get($option->getPrimaryKey());
                     
                if (array_key_exists($p, $selected))
                {
                     $answers[] = $option->format($this->format);
                }
           }
           
           if(count($answers))
           {
                $this->_startField($field);
                echo implode(TaxonomyTermFieldRenderer::$readOnlyTermSeparator, $answers);
                $this->_endField($field);
           }
      }

◆ renderScript()

BindingTargetFieldRenderer::renderScript ( $field )

Definition at line 412 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>                
 <?
           }
      }

◆ setSize()

BindingTargetFieldRenderer::setSize	(	$width,
		$height
	)

Definition at line 406 of file taxonomy_term_field_renderer.inc.

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

Member Data Documentation

◆ $bindingTarget

BindingTargetFieldRenderer::$bindingTarget

Definition at line 361 of file taxonomy_term_field_renderer.inc.

◆ $dropdown

BindingTargetFieldRenderer::$dropdown

Definition at line 362 of file taxonomy_term_field_renderer.inc.

◆ $dropdownMaxWidth

BindingTargetFieldRenderer::$dropdownMaxWidth = "340px"

Definition at line 363 of file taxonomy_term_field_renderer.inc.

◆ $dropdownMessage

BindingTargetFieldRenderer::$dropdownMessage = "Click to Select Terms"

Definition at line 364 of file taxonomy_term_field_renderer.inc.

◆ $field

BindingTargetFieldRenderer::$field

Definition at line 359 of file taxonomy_term_field_renderer.inc.

◆ $label

BindingTargetFieldRenderer::$label

Definition at line 360 of file taxonomy_term_field_renderer.inc.

◆ $options

BindingTargetFieldRenderer::$options

Definition at line 365 of file taxonomy_term_field_renderer.inc.

◆ $readOnlyTermSeparator

BindingTargetFieldRenderer::$readOnlyTermSeparator = "<br>"

static

Definition at line 369 of file taxonomy_term_field_renderer.inc.

◆ $resizable

BindingTargetFieldRenderer::$resizable = true

Definition at line 367 of file taxonomy_term_field_renderer.inc.

◆ $showSelectAll

BindingTargetFieldRenderer::$showSelectAll

Definition at line 366 of file taxonomy_term_field_renderer.inc.

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

C:/code/cms.sonjara.com/cms/components/taxonomy/taxonomy_term_field_renderer.inc

Public Member Functions

Public Attributes

Static Public Attributes