SubSelectFieldRenderer Class Reference

SubSelectFieldRenderer - provides a second-level hierarchical selection mechanism based on the results of another select-based field renderer (such as SelectFieldRenderer or RelatedItemSelectFieldRenderer) More...

Inheritance diagram for SubSelectFieldRenderer:

Collaboration diagram for SubSelectFieldRenderer:

Public Member Functions
	SubSelectFieldRenderer (&$form, $field, $label, $super, $options, $format)
	extraControls ($field)
	Override this function to provide extra editing controls that follow the visibility rules of the main control. More...
	renderField ($field)
	FieldRenderers must override this method to provide the HTML implementation of the control used to edit the field. More...
	renderSearchField ($field, $mode, $value="")
	renderReadOnly ($field)
	renderScript ($field)
	FieldRenderers can override this method to provide any Javascript that their control requires for an edit form. More...
	setFormatTemplate ()
	We need to save the class var format into the object for use in the static call to formatOption. 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 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...
	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...

Static Public Member Functions
static	formatOption ($option)

Public Attributes
	$super
	$options
	$format
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

SubSelectFieldRenderer - provides a second-level hierarchical selection mechanism based on the results of another select-based field renderer (such as SelectFieldRenderer or RelatedItemSelectFieldRenderer)

Author

andy

Definition at line 46 of file subselect_field_renderer.inc.

Member Function Documentation

extraControls()

SubSelectFieldRenderer::extraControls

(

$field

)

Override this function to provide extra editing controls that follow the visibility rules of the main control.

Parameters

string

$field

Definition at line 77 of file subselect_field_renderer.inc.

     {
          
     }

formatOption()

static SubSelectFieldRenderer::formatOption (   $option )

static

Definition at line 200 of file subselect_field_renderer.inc.

     {
          $template = $option->get("_formatTemplate");
          return jsSafe($option->format("{$template}"));
     }    

preProcess()

SubSelectFieldRenderer::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 206 of file subselect_field_renderer.inc.

     {
          if(!$this->parent->data->hasField($this->super)) return;
          
          $super_id = $this->parent->data->get($this->super);
          
          if (!array_key_exists($super_id, $this->options))
          {
               $this->parent->data->set($field, 0);
          }         
     }

renderField()

SubSelectFieldRenderer::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 82 of file subselect_field_renderer.inc.

     {
          $this->_startField($field);
               
          if($this->width)
          {
               $style = "style='width: {$this->width}'";
          }
 
          echo "<span class='subselect_container'>";
          echo "<select $style name='$field' id='{$this->parent->id}_{$field}'";
          
          if ($this->onChange != "")
          {
               echo " onchange='$this->onChange(this)'";
          }
               
          echo ">\n";              
          echo "</select>\n";
          
          $this->extraControls($field);
          
          echo "</span>";
          
          $this->_endField($field);
     }

renderReadOnly()

SubSelectFieldRenderer::renderReadOnly

(

$field

)

Definition at line 131 of file subselect_field_renderer.inc.

     {
          $super_id = $this->parent->data->get($this->super);
          
          if (!array_key_exists($super_id, $this->options)) return;
          
          $this->_startField($field);
          
          $item = findItem($this->options[$super_id], $field, $this->parent->data->get($field));
          
          if ($item)
          {
               echo $item->format($this->format);
          }
          else
          {
               echo "Not specified";
          }
          
          $this->_endField($field);
     }

renderScript()

SubSelectFieldRenderer::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 153 of file subselect_field_renderer.inc.

     {
          if ($this->parent->readOnlyForm || $this->parent->isReadOnly($field)
               || array_key_exists($field, $this->parent->hidden)) return "";
 
          $mgr = "{$this->parent->id}_{$field}_mgr";
          $super_id = "{$this->parent->id}_{$this->super}";
          $value = $this->parent->data->get($field);
          $this->setFormatTemplate();
?>
<script type="text/javascript">
window.addEvent('domready', function()
{
     var <?echo $mgr?> = new SubSelectManager('<?echo $super_id?>', '<?echo $this->parent->id?>_<?echo $field?>', '<?echo $value?>');
<?
          foreach($this->options as $key => $options)
          {
               $pk = $options[0]->getPrimaryKey();               
               $values = formatItems($options, "{'name': '{SubSelectFieldRenderer::formatOption}', 'value': {{$pk}} }", ", ");
?>
     <?echo $mgr?>.addOptions(<?echo $key?>, [{'name': '', 'value': 0}, <?echo $values?>]);
<?
          }
?>
     <?echo $mgr?>.update();
});
</script>
<?
     } 

renderSearchField()

SubSelectFieldRenderer::renderSearchField	(		$field,
			$mode,
			$value = ""
	)

Definition at line 109 of file subselect_field_renderer.inc.

     {
          if ($mode != "equal") $mode = "equal";
          
          $searchValue = (!$value) ? $this->parent->params->get($field, $mode) : $value;
          
          $this->_startField($field);
          
          echo "<select id='$field' name='$field:$mode'><option value=''></option>\n";
          foreach($this->options as $value => $name)
          {
               $selected = ($searchValue == $value) ? " selected" : "";
               
               echo "<option value='".htmlSafe($value)."'$selected>$name</option>";
          }
          
          echo "</select>";
          
          $this->_endField($field);
     }

setFormatTemplate()

SubSelectFieldRenderer::setFormatTemplate

(

)

We need to save the class var format into the object for use in the static call to formatOption.

We can't call formatOption using the class instance $this through the formatItems function.

Definition at line 189 of file subselect_field_renderer.inc.

     {
          foreach($this->options as $key => $options)
          {
               foreach($options as $option)
               {
                    $option->set("_formatTemplate", $this->format);
               }
          }    
     }    

SubSelectFieldRenderer()

SubSelectFieldRenderer::SubSelectFieldRenderer	(	&	$form,
			$field,
			$label,
			$super,
			$options,
			$format
	)

Definition at line 52 of file subselect_field_renderer.inc.

     {
          $this->options = $options;
          $this->super = $super;
          $this->format = $format;
          $this->FieldRenderer($form);
          if ($form->data->hasField($field))
          {
               // JDG 5/30/11 - don't crash on additiona/psuedo fields
               // only query if real field
               $form->override($field, $label, $this);           
          }
          else
          {
               $form->add($this, $field);
               // JDG 7/22/2011 - allow "additional" fields to override label
               $form->overrides[$field]['label'] = $label;
          }
     }

Member Data Documentation

$format

SubSelectFieldRenderer::$format

Definition at line 50 of file subselect_field_renderer.inc.

$options

SubSelectFieldRenderer::$options

Definition at line 49 of file subselect_field_renderer.inc.

$super

SubSelectFieldRenderer::$super

Definition at line 48 of file subselect_field_renderer.inc.

---

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

• C:/code/cms.sonjara.com/framework/field_renderers/subselect_field_renderer.inc