Field renderer for related item data fields. More...

Inheritance diagram for RelatedItemRadioButtonFieldRenderer:

Collaboration diagram for RelatedItemRadioButtonFieldRenderer:

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

	getRelatedItems ()

	renderField ($field)
	FieldRenderers must override this method to provide the HTML implementation of the control used to edit the field. 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)

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

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

	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

	$nameField

	$valueField

	$relatedClass

	$constraint

	$horizontal

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 related item data fields.

Renders as a list of radio button options.

Definition at line 44 of file related_item_radio_button_field_renderer.inc.

Member Function Documentation

◆ getRelatedItems()

RelatedItemRadioButtonFieldRenderer::getRelatedItems ( )

Definition at line 70 of file related_item_radio_button_field_renderer.inc.

      {
           $this->items = query($this->relatedClass, $this->constraint);
           return $this->items;
      }    

◆ RelatedItemRadioButtonFieldRenderer()

RelatedItemRadioButtonFieldRenderer::RelatedItemRadioButtonFieldRenderer	(	&	$form,
			$field,
			$label,
			$relatedClass,
			$constraint,
			$nameField,
			$valueField = `""`
	)

Definition at line 55 of file related_item_radio_button_field_renderer.inc.

      {
           $this->relatedClass = $relatedClass;
           $this->constraint = $constraint;
           $this->field = $field;
           $this->nameField = $nameField;
           $this->valueField = $valueField;
           $this->horizontal = true;
           
           $this->getRelatedItems();
           
           $this->FieldRenderer($form);
           $form->override($field, $label, $this);
      }

◆ renderField()

RelatedItemRadioButtonFieldRenderer::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 76 of file related_item_radio_button_field_renderer.inc.

      {         
           $this->_startField($field);
  
           $current = $this->parent->data->get($field);
           
           foreach($this->items as $item)
           {
                $name = $this->formatName($item, $this->nameField);
                $valueField = ($this->valueField != "") ? $this->valueField : $item->getPrimaryKey();
                //trace("valueField: $valueField", 3);
                
                echo "<input type='radio' name='{$field}' value='{$item->$valueField}'";
                if ($item->get($valueField) == $current) echo " selected";
                echo ">&nbsp;$name\n";
  
                echo ($this->horizontal) ? "&nbsp;&nbsp;&nbsp;" : "<br/>";
           }
      
           $this->_endField($field);
      }

◆ renderReadOnly()

RelatedItemRadioButtonFieldRenderer::renderReadOnly ( $field )

Definition at line 124 of file related_item_radio_button_field_renderer.inc.

      {         
           $this->_startField($field);
                     
           foreach($this->items as $item)
           {
                $valueField = $this->valueField ? $this->valueField : $item->getPrimaryKey();
                
                if ($this->parent->data->get($field) == $item->get($valueField))
                {
                     $name = $this->formatName($item, $this->nameField);
                     echo $name;
                     break;
                }
           }    
           $this->_endField($field);
      }    

◆ renderSearchField()

RelatedItemRadioButtonFieldRenderer::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 98 of file related_item_radio_button_field_renderer.inc.

      {
           if ($mode != "equal") return;
           
           echo "<tr>\n";
           $this->_printLabel($field);
           echo "<td>";
           $valueField = ($this->valueField != "") ? $this->valueField : $item->primary_key;
           //trace("valueField: $valueField", 3);
           
           $value = $this->parent->params->get($field, $mode);
           $current = $this->parent->data->get($field);
           
           foreach($this->items as $item)
           {
                $name = $this->formatName($item, $this->nameField);
  
                echo "<input type='radio' name='{$field}:$mode' value='{$value}'";
                if ($item->get($valueField) == $current) echo " selected";
                echo ">&nbsp;$name\n";
  
                echo ($this->horizontal) ? "&nbsp;&nbsp;&nbsp;" : "<br/>";            
           }
           echo "</select>";
      }