Field renderer for handling one-to-many relationships that are implemented through a back-reference table. More...

Inheritance diagram for RelatedItemCheckListFieldRenderer:

Collaboration diagram for RelatedItemCheckListFieldRenderer:

Public Member Functions
	__construct (&$form, $field, $label, $relatedClass, $constraint, $nameField)

	setSize ($width, $height)

	groupBy ($groupBy, $format="")

	getMatchingPK ($relatedClass, $obj)
	Find the field in the DataItem obj displayed in the AutoForm that exists in the back-reference class e.g., if ProductCategory AutoForm's obj, and products are the option items displayed, then product_category_id would exist in the Product table. More...

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

	getRelatedItems ()

	getSelected ($obj, $itempk, $pk)

	renderCheckboxes ($field, $items, $pk, $selected)

	renderReadOnly ($field="")

	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...

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...

	renderScript ($field)
	FieldRenderers can override this method to provide any Javascript that their control requires for an edit form. 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
	$relatedClass

	$constraint

	$nameField

	$field

	$label

	$options

	$groupBy

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

Field renderer for handling one-to-many relationships that are implemented through a back-reference table.

The postProcess() method is used to automatically update the table records when the form is submitted.

e.g., AutoForm renders instance of ProductCategory containing a RelatedItemCheckListFieldRenderer additional field "products" to select the products that belong to the category. Selections are saved to the product table's field product_category_id.

Definition at line 51 of file related_item_checklist_field_renderer.inc.

Constructor & Destructor Documentation

◆ __construct()

RelatedItemCheckListFieldRenderer::__construct	(	&	$form,
			$field,
			$label,
			$relatedClass,
			$constraint,
			$nameField
	)

Definition at line 61 of file related_item_checklist_field_renderer.inc.

      {
           $this->field = $field;
           $this->label = $label;
           $this->nameField = $nameField;
           $this->relatedClass = $relatedClass;
           $this->constraint = $constraint;
           $this->options = $this->getRelatedItems();
           
           $this->FieldRenderer($form);
           
           if ($form->data->hasField($field))
           {
                $form->override($field, $label, $this);
           }
           else
           {
                $form->add($this, $field);
                $form->overrides[$field]['label'] = $label;
           }
      }

Member Function Documentation

◆ getMatchingPK()

RelatedItemCheckListFieldRenderer::getMatchingPK	(	$relatedClass,
		$obj
	)

Find the field in the DataItem obj displayed in the AutoForm that exists in the back-reference class e.g., if ProductCategory AutoForm's obj, and products are the option items displayed, then product_category_id would exist in the Product table.

Parameters

unknown	$relatedClass
unknown	$obj

Exceptions

DataItemException

Returns: unknown

Definition at line 106 of file related_item_checklist_field_renderer.inc.

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

◆ getRelatedItems()

RelatedItemCheckListFieldRenderer::getRelatedItems ( )

Definition at line 182 of file related_item_checklist_field_renderer.inc.

      {
           return Query::create($this->relatedClass, $this->constraint)->execute();
      }

◆ getSelected()

RelatedItemCheckListFieldRenderer::getSelected	(	$obj,
		$itempk,
		$pk
	)

Parameters

obj	$obj	DataItem class in AutoForm
String	$itempk	back-reference key of the related class
String	$pk	- primary key of the back-reference related table

Returns: array of objects of related class

Definition at line 194 of file related_item_checklist_field_renderer.inc.

      {
           return IndexedQuery::create($this->relatedClass, "WHERE {$itempk}=:{$itempk}", $pk)
                ->bind("{$itempk}", $obj->get($itempk))
                ->execute();
      }    

◆ groupBy()

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

Definition at line 89 of file related_item_checklist_field_renderer.inc.

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

◆ postProcess()

RelatedItemCheckListFieldRenderer::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

Save each checked item to the back-reference related table

Remove the link from the back-reference related table to the form's data obj if no longer selected.

Reimplemented from FieldRenderer.

Definition at line 242 of file related_item_checklist_field_renderer.inc.

      {
           if (count($this->options) == 0) return;
  
           $option_pk = $this->options[0]->getPrimaryKey();
           $obj_pk = $this->parent->data->getPrimaryKey();
           $obj_id = $this->parent->data->$obj_pk;
           
           $items = reindexList($this->options, $option_pk);
           
           $selected = $_POST[$this->field];
      
           foreach($selected as $selected_pk => $value)
           {
                if(!array_key_exists($selected_pk, $items)) continue;
                
                $item = $items[$selected_pk];
                $item->filter = new InclusionFilter($obj_pk);
                $item->$obj_pk= $obj_id;
                $item->save();
           } 
           
           foreach($items as $item_id => $item)
           {
                if($item->$obj_pk == $obj_id && !array_key_exists($item->$option_pk, $selected))
                {
                     $item->filter = new InclusionFilter($obj_pk);
                     $item->$obj_pk = 0;
                     $item->save();
                }
           }
      }    

◆ renderCheckboxes()

RelatedItemCheckListFieldRenderer::renderCheckboxes	(	$field,
		$items,
		$pk,
		$selected
	)

Definition at line 201 of file related_item_checklist_field_renderer.inc.

      {
           foreach($items as $item)
           {
                $item_id = $item->$pk;
                     
                echo "<input type='checkbox' class='checkbox' name='{$field}[$item_id]' id='checkbox_{$field}_$item_id' value='1'";
                if (array_key_exists($item_id, $selected))
                {
                     echo " checked";
                }
                echo ">&nbsp;";
      
                echo "<label for='checkbox_{$field}_$item_id'>".$this->formatName($item, $this->nameField)."</label>";
                echo "<br/>";
           }
      }

◆ renderField()

RelatedItemCheckListFieldRenderer::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 117 of file related_item_checklist_field_renderer.inc.

      {
           if (count($this->options) == 0) return;
                
           $field = $this->field;
                
           $this->_startField($field);
                
           $obj = $this->parent->data;
      
           if (is_array($this->groupBy) && count($this->groupBy) > 0)
           {
                $keys = array_keys($this->options);
           }
      
           $itempk = $this->getMatchingPK($this->options[0], $obj);
           $related_pk = $this->options[0]->getPrimaryKey();
           $selected = $this->getSelected($obj, $itempk, $related_pk);
           
           if ($this->width && $this->height)
           {              
                echo "<div id='{$this->parent->id}_{$field}_container' class='selectbox scrollbox{$resizable}{$dropdown}' style='width: {$this->width}px; height: {$this->height}px; overflow: auto'>\n";
           }
           else
           {
                echo "<div class='selectbox'>\n";
           }         
           $countOptions = count($this->options);
                
           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->renderCheckboxes($field, $this->options[$group->get($gpk)], $related_pk, $selected); 
                     }
                }
           }
           else if (is_string($this->groupBy))
           {
                $options = regroupList($this->options, $this->groupBy);
  
                foreach($options as $group => $choices)
                {
                     echo "<br/><h4>$group</h4>";
                     $this->renderCheckboxes($field, $choices, $related_pk, $selected);
                }
           }
           else
           {
                $this->renderCheckBoxes($field, $this->options, $related_pk, $selected);  
           }
                
           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()

RelatedItemCheckListFieldRenderer::renderReadOnly ( $field = "" )

Definition at line 219 of file related_item_checklist_field_renderer.inc.

      {
           if (count($this->options) == 0) return;
                
           $obj = $this->parent->data;
           $itempk = $this->getMatchingPK($this->options[0], $obj);
           $related_pk = $this->options[0]->getPrimaryKey();
           $selected = $this->getSelected($obj, $itempk, $related_pk);
           
           
           $this->_startField($field);
           
           foreach($this->options as $item)
           {
                if (array_key_exists($item->$related_pk, $selected))
                {
                     echo $this->formatName($item, $this->nameField)."<br/>";
                }
           }
                
           $this->_endField($field);
      }

◆ setSize()

RelatedItemCheckListFieldRenderer::setSize	(	$width,
		$height
	)

Definition at line 83 of file related_item_checklist_field_renderer.inc.

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

Member Data Documentation

◆ $constraint

RelatedItemCheckListFieldRenderer::$constraint

Definition at line 54 of file related_item_checklist_field_renderer.inc.

◆ $field

RelatedItemCheckListFieldRenderer::$field

Definition at line 56 of file related_item_checklist_field_renderer.inc.

◆ $groupBy

RelatedItemCheckListFieldRenderer::$groupBy

Definition at line 59 of file related_item_checklist_field_renderer.inc.

◆ $label

RelatedItemCheckListFieldRenderer::$label

Definition at line 57 of file related_item_checklist_field_renderer.inc.

◆ $nameField

RelatedItemCheckListFieldRenderer::$nameField

Definition at line 55 of file related_item_checklist_field_renderer.inc.

◆ $options

RelatedItemCheckListFieldRenderer::$options

Definition at line 58 of file related_item_checklist_field_renderer.inc.

◆ $relatedClass

RelatedItemCheckListFieldRenderer::$relatedClass

Definition at line 53 of file related_item_checklist_field_renderer.inc.

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

C:/code/cms.sonjara.com/framework/field_renderers/related_item_checklist_field_renderer.inc

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getMatchingPK()

◆ getRelatedItems()

◆ getSelected()

◆ groupBy()

◆ postProcess()

◆ renderCheckboxes()

◆ renderField()

◆ renderReadOnly()

◆ setSize()

Member Data Documentation

◆ $constraint

◆ $field

◆ $groupBy

◆ $label

◆ $nameField

◆ $options

◆ $relatedClass