CompoundSelectFieldRenderer allows you to provide a consolidated grouped dropdown selector that processes selection for multiple fields. More...

Inheritance diagram for CompoundSelectFieldRenderer:

Collaboration diagram for CompoundSelectFieldRenderer:

Public Member Functions
	CompoundSelectFieldRenderer (&$form, $field, $label, $onChange)

	add ($title, $field, $items, $format)

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

	getValue ()

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

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

	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
	$options

	$onChange
	optional selection change handler More...

	$width

	$max_chars

	$defaultBlank = true
	whether the drop down includes a blank as the default More...

	$defaultText = "Choose One"

	$emptyValue = 0
	The value to which the non-selected fields should be set. More...

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

CompoundSelectFieldRenderer allows you to provide a consolidated grouped dropdown selector that processes selection for multiple fields.

Author: andy

Definition at line 47 of file compound_select_field_renderer.inc.

Member Function Documentation

◆ add()

CompoundSelectFieldRenderer::add	(	$title,
		$field,
		$items,
		$format
	)

Definition at line 88 of file compound_select_field_renderer.inc.

      {
           $this->options[$field] = array("title"  =>   $title,
                                                 "items"     =>   $items,
                                                 "format"    =>   $format);
           
           $this->parent->hide($field);
           
           return $this;
      }

◆ CompoundSelectFieldRenderer()

CompoundSelectFieldRenderer::CompoundSelectFieldRenderer	(	&	$form,
			$field,
			$label,
			$onChange
	)

Definition at line 58 of file compound_select_field_renderer.inc.

      {
           $this->options = array();
           $this->onChange = $onChange;
  
           $this->FieldRenderer($form);
           if ($form->data->hasField($field))
           {
                $form->override($field, $label, $this);
                if ($this->options == null)
                {
                     $opt = $form->data->distinctValues($field, true);
                     if (count($opt) > 0)
                     {
                          $this->options = array_combine($opt, $opt);
                     }
                     else
                     {
                          $this->options = array();
                     }
                }
           }
           else
           {
                $form->add($this, $field);
                // JDG 7/22/2011 - allow "additional" fields to override label
                $form->overrides[$field]['label'] = $label;
           }    
      }

◆ getValue()

CompoundSelectFieldRenderer::getValue ( )

Definition at line 157 of file compound_select_field_renderer.inc.

      {
           $obj = $this->parent->data;
           
           foreach(array_keys($this->options) as $field)
           {
                $value = $obj->get($field);
                if ($value)
                {
                     return "$field:$value";
                }
           }
           
           return "";
      }

◆ preProcess()

CompoundSelectFieldRenderer::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 173 of file compound_select_field_renderer.inc.

      {         
           $obj = $this->parent->data;
           
           $value = ($this->parent->method == "POST") ? $_POST[$field] : $_GET[$field];
           
           list($targetField, $value) = explode(":", $value);
           
           foreach(array_keys($this->options) as $f)
           {
                if ($targetField == $f)
                {
                     $obj->set($f, $value);
                }
                else
                {
                     $obj->set($f, $this->emptyValue);
                }
           }
      }

◆ renderField()

CompoundSelectFieldRenderer::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 99 of file compound_select_field_renderer.inc.

      {
           $this->_startField($field);
                
           $current = $this->getValue();
           
           if($this->width)
                $style = "style='width: {$this->width}'";
           echo "<select $style name='$field' id='{$this->parent->id}_{$field}'";
                
           if ($this->onChange != "")
           echo " onchange='$this->onChange(this)'";
           elseif($this->addEntry)
           echo " onchange='onChange_{$this->parent->id}_{$field}(this)'";
                
           echo ">\n";
      
           if ($this->defaultBlank)
           {
                echo "<option value=''></option>";
           }
           
           foreach($this->options as $subField => $group)
           {                                  
  
                $groupName = $group["title"];
                
                echo "<optgroup label=\"$groupName\">\n";
                
                foreach($group["items"] as $item)
                {
                     $value = "$subField:".$item->get($subField);
                     $name = $item->format($group["format"]);
                     
                     $name = htmlSafe($name);
                     $trunced = $this->max_chars ? ellipsis($name, $this->max_chars, true) : $name;
           
                     if($current == $value)
                     {
                          $selected = " selected";
                     }
                     else
                          $selected = "";
  
                     $optionTitle = ($name != $trunced) ? " title='$name'" : "";
      
                     echo "<option$optionTitle value='".htmlSafe($value)."'$selected>$trunced</option>\n";
                }
                
                echo "</optgroup>\n";
           }
           
           echo "</select>\n";
      
           $this->_endField($field);
      }