Field renderer for selected related items from a list of images. More...

Inheritance diagram for RelatedImageSelectFieldRenderer:

Collaboration diagram for RelatedImageSelectFieldRenderer:

Public Member Functions
	RelatedImageSelectFieldRenderer (&$form, $field, $label, $relatedClass, $constraint, $imageField, $valueField="")

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

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

	renderReadOnly ($field)

	getRelatedItems ()

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

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

	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 Attributes
	$items

	$default

	$field

	$imageField

	$valueField

	$relatedClass

	$constraint

	$onChange

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 selected related items from a list of images.

Renders as a custom drop-down-list style control, implemented via Javascript.

Definition at line 44 of file related_image_select_field_renderer.inc.

Member Function Documentation

◆ getRelatedItems()

RelatedImageSelectFieldRenderer::getRelatedItems ( )

Definition at line 202 of file related_image_select_field_renderer.inc.

      {
           $this->items = query($this->relatedClass, $this->constraint);
           if ($this->allowNone)
           {
                $this->items = array_merge(array(new $this->relatedClass), $this->items);
           }
           return $this->items;
      }

◆ preProcess()

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

For example, the FileUploadFieldRenderer overrides this method to process the uploading of the file and then store the location in the associated field in the target object.

Parameters

string $field the field name

Reimplemented from FieldRenderer.

Definition at line 213 of file related_image_select_field_renderer.inc.

      {
           /*trace("RelatedItemSelectFieldRenderer::process()", 3);
           
           $item = new $this->relatedClass;
           
           if (!$this->allowAdd) return;
           $valueField = $valueField ? $this->valueField : $item->primary_key;
           $field = "autoform_add_$valueField";
           $val = $_POST[$field];
           
           trace("Checking for value '$val' in field $field", 3);
           
           if ($val)
           {
                foreach($this->items as $item)
                {
                     if ($val == $this->formatName($item, $this->nameField))
                     {
                          $this->data->$valueField = $item->$valueField;
                          return;
                     }
                }
                
                $obj = new $this->relatedClass;
                $pk = $obj->primary_key;
                
                $nameField = $this->nameField;
                
                $obj->$nameField = $val;
                $obj->save();
                $this->parent->data->$valueField = $obj->$pk;
           }*/
      }

◆ RelatedImageSelectFieldRenderer()

RelatedImageSelectFieldRenderer::RelatedImageSelectFieldRenderer	(	&	$form,
			$field,
			$label,
			$relatedClass,
			$constraint,
			$imageField,
			$valueField = `""`
	)

Definition at line 55 of file related_image_select_field_renderer.inc.

      {
           $this->relatedClass = $relatedClass;
           $this->constraint = $constraint;
           $this->field = $field;
           $this->imageField = $imageField;
           $this->valueField = $valueField;
           $this->allowAdd = $allowAdd;
           $this->allowNone = $allowNone;
           $this->max_chars = $maxChars;
           
           $this->getRelatedItems();
           
           $this->FieldRenderer($form);
           $form->override($field, $label, $this);
      }

◆ renderField()

RelatedImageSelectFieldRenderer::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 72 of file related_image_select_field_renderer.inc.

      {         
           
           $obj =& $this->parent->data;
           $imgField = $this->imageField;
           
           if ($obj->$field)
           {
                $related = $obj->getRelated($this->relatedClass, $field);
                $valueField = ($this->valueField != "") ? $this->valueField : $related->getPrimaryKey();
                //trace("valueField: $valueField", 3);
                $img = "<img src='".$related->get($imgField)."'/>";
           }
           else
           {
                $img = "Click to Select";
           }
  
           $this->_startField($field);
           echo "<input id='{$this->parent->id}_{$field}' type='hidden' name='$field'  value='".$this->parent->data->get($field)."'><button name='{$field}_button' class='{$this->parent->buttonCSS}' onclick='{$field}_toggle(); return false;'>$img</button>";
           
           echo "<div style='display: none; position: absolute' id='{$field}_options'>";
      
           $items = $this->getRelatedItems();
           
           foreach($items as $item)
           {
                $valueField = ($this->valueField != "") ? $this->valueField : $item->getPrimaryKey();
                
                //trace("valueField: $valueField imageField: $imgField", 3);
                echo "<img style='cursor: pointer; float: left' src='{$item->$imgField}' onclick='{$field}_select(\"{$item->$valueField}\", \"{$item->$imgField}\"); return false;'/>";
           }
           
           echo "</div>";
           $this->_endField($field);
           
      }

◆ renderReadOnly()

RelatedImageSelectFieldRenderer::renderReadOnly ( $field )

Definition at line 178 of file related_image_select_field_renderer.inc.

      {         
           echo "<tr>\n";
           $this->_printLabel($field);
           echo "<td";
           if ($this->parent->valueCSS) echo " class='{$this->parent->valueCSS}'";
           echo ">";
           
           /*foreach($this->items as $item)
           {
                $valueField = $this->valueField ? $this->valueField : $item->primary_key;
                
                if ($this->parent->data->$field == $item->$valueField)
                {
                     $name = $this->formatName($item, $this->nameField);
                     echo $name;
                     break;
                }
           }*/
           
           echo "</td>\n";
           echo "</tr>\n";
      }

◆ renderScript()

RelatedImageSelectFieldRenderer::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 110 of file related_image_select_field_renderer.inc.

      {
 ?>
 <script type='text/javascript'>
 /* <![CDATA[ */
      function <?echo $field ?>_select(value, image)
      {
           var form = document.getElementById('<?echo $this->parent->id ?>');
           var ctrl = form['<?echo $field ?>'];
           var button = form['<?echo $field ?>_button'];
           ctrl.value = value;
           button.innerHTML = "<img src='" + image + "'/>";
           <?echo $field ?>_hide();
 <? if ($this->onChange)
 { ?>
           <?echo $this->onChange ?>(value, image);
 <?
 }
  ?>
      }
      
      function <?echo $field ?>_toggle()
      {
           var div = document.getElementById('<?echo $field ?>_options');
           if (div.style.display == 'none')
           {
                div.style.display = 'block';
           }
           else
           {
                div.style.display = 'none';
           }
      }
      
      function <?echo $field ?>_hide()
      {
           var div = document.getElementById('<?echo $field ?>_options');
           div.style.display = 'none';
      }
                
 // ]]>
 </script>
 <?
      }

◆ renderSearchField()

RelatedImageSelectFieldRenderer::renderSearchField	(	$field,
		$mode
	)

FieldRenderers must override this method to provide the HTML implementation of the control displayed for the field in a search form.

Parameters

string $field the field name

Reimplemented from FieldRenderer.

Definition at line 154 of file related_image_select_field_renderer.inc.

      {
           /*if ($mode != "equal") return;
           
           echo "<tr>\n";
           $this->_printLabel($field);
           echo "<td><select name='{$field}:$mode'>\n";
           echo "<option value=''></option>\n";
           $valueField = ($this->valueField != "") ? $this->valueField : $item->primary_key;
           //trace("valueField: $valueField", 3);
           
           $value = $this->parent->params->get($field, $mode);
           
           foreach($this->items as $item)
           {
                $name = $this->formatName($item, $this->nameField);
  
                echo "<option value='{$item->$valueField}'";
                if ($item->$valueField == $value) echo " selected";
                echo ">".ellipsis($name, $this->max_chars)."</option>\n";             
           }
           echo "</select>";*/
      }