Inheritance diagram for TableSelectFieldRenderer:

Collaboration diagram for TableSelectFieldRenderer:

Public Member Functions
	__construct ($form, $field, $label, $handler, $processor=null, $mode="single", $data=null)

	buildTable ($field)

	formatSelector ($item)

	renderScript ($field)
	FieldRenderers can override this method to provide any Javascript that their control requires for an edit form. More...

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

	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
	$table = null

	$field

	$label

	$colspan = 2

	$mode = "single"
	"single" or "multi" selection More...

	$handler = null

	$processor = null

	$data = null

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

Definition at line 8 of file table_select_field_renderer.inc.

Constructor & Destructor Documentation

◆ __construct()

TableSelectFieldRenderer::__construct	(	$form,
		$field,
		$label,
		$handler,
		$processor = `null`,
		$mode = `"single"`,
		$data = `null`
	)

Definition at line 23 of file table_select_field_renderer.inc.

      {
           $this->FieldRenderer($form);
  
           $this->field = $field;
           $this->label = $label;
           $this->handler = $handler;
           $this->processor = $processor;
           $this->mode = $mode;
           $this->data = $data;
           
           if ($form->data->hasField($field))
           {
                $form->override($field, $label, $this);
           }
           else
           {
                $form->add($this, $field);
                // JDG 8/14/2011 - allow "additional" fields to override label
                $form->overrides[$field]['label'] = $label;
           }
           
      }

Member Function Documentation

◆ buildTable()

TableSelectFieldRenderer::buildTable ( $field )

Definition at line 47 of file table_select_field_renderer.inc.

      {
           $this->table = new DataListView($this->data, "{$field}_table");
           $this->table->rowId = true;
  
           $this->table->pageSize = 5;
           $this->table->filter = true;
           $this->table->emptyMessage = $this->emptyMessage;
           
           $this->table->selectable = true;
           $this->table->selector(array($this, 'formatSelector'));
  
           call_user_func_array($this->handler, array($this->table));
      }

◆ formatSelector()

TableSelectFieldRenderer::formatSelector ( $item )

Definition at line 62 of file table_select_field_renderer.inc.

      {
           $pk = $item->getPrimaryKey();
           $pkval = $item->get($pk);
  
           switch($this->mode)
           {
           case "multi":
                $control = "checkbox";
                $name = "{$this->field}[]";
                break;
                
           case "single":
           default:
                $control = "radio";
                $name = $this->field;
                break;
           }
           
           $checked = array_key_exists($pkval, $this->related) ? " checked='checked'" : "";
  
           return $item->format("<input type='{$control}' class='{$control}' name='{$name}' id='{$this->field}_{{$pk}}' value='{{$pk}}'{$checked}/>");
      }

◆ postProcess()

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

Reimplemented from FieldRenderer.

Definition at line 114 of file table_select_field_renderer.inc.

      {
           if (!$field) $field = $this->field;
  
           if ($this->processor)
           {
                call_user_func_array($this->processor, array($field));
           }
  
           return true;
      }

◆ renderField()

TableSelectFieldRenderer::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 98 of file table_select_field_renderer.inc.

      {
           if (!$field) $field = $this->field;
           
           if (!$this->table)
           {
                $this->buildTable($field);
           }
           
           $this->_startField($field);
           
           echo $this->table->drawView();
           
           $this->_endField($field);
      }

◆ renderScript()

TableSelectFieldRenderer::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 86 of file table_select_field_renderer.inc.

      {
           if (!$field) $field = $this->field;
           
           if (!$this->table)
           {
                $this->buildTable($field);
           }
           
           echo $this->table->writeScript();
      }