Inheritance diagram for FilterFieldRenderer\BooleanFilterFieldRenderer:

Collaboration diagram for FilterFieldRenderer\BooleanFilterFieldRenderer:

Public Member Functions
	BooleanFilterFieldRenderer (&$parent, $field="", $label="", $default=0)

	renderSearchScript ($field)

	renderSearchField ($field)

Public Member Functions inherited from BooleanFieldRenderer
	BooleanFieldRenderer (&$parent, $field=null, $label=null)
	Create a new BooleanFieldRenderer. 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...

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

	renderSearchField ($field, $mode="match")
	FieldRenderers must override this method to provide the HTML implementation of the control displayed for the field in a search form. More...

	renderReadOnly ($field)

	format ($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...

	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
	$cssClass = "boolean"

	$default

Public Attributes inherited from BooleanFieldRenderer
	$disable = false

	$template = "Yes/No"
	, alternative to readonly; field can be reenabled thru javascript More...

	$onClick = null
	Name of Javascript function to be called when checkbox is toggled. 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

Definition at line 579 of file filter_form.inc.

Member Function Documentation

◆ BooleanFilterFieldRenderer()

FilterFieldRenderer\BooleanFilterFieldRenderer::BooleanFilterFieldRenderer	(	&	$parent,
			$field = `""`,
			$label = `""`,
			$default = `0`
	)

Parameters

FilterForm	$parent	the parent FilterForm
string	$field	the name of the field
string	$label	label to display for the field
bool	$default	whether the checkbox should be check or unchecked as the default

Definition at line 591 of file filter_form.inc.

      {
           $this->label = ($label) ? $label : prettify($field);
      
           $this->default = $default;
           
           $this->FieldRenderer($parent);
           if ($parent->data->hasField($field))
           {
                $parent->override($field, $label, $this);
           }
           else
           {
                $parent->add($this, $field);
                $parent->overrides[$field]['label'] = $this->label;
           }
  
           $value = $this->getValue($field);
           // The search parameter value is used for the constraint
           $this->parent->params->clearParam($field);
           $this->parent->params->setParam($field, "checked", $value);
      }

◆ renderSearchField()

FilterFieldRenderer\BooleanFilterFieldRenderer::renderSearchField ( $field )

Definition at line 666 of file filter_form.inc.

      {
           $this->_startField($field, $this->styles);
                
           echo "<input type='checkbox' value='1' name='{$field}_box'";
  
           $value = $this->getValue($field);
      
           if ($value)
           {
                echo " checked='checked'";
           }
           echo " onclick='selChanged_{$field}_box(this);'/>\n";
                     
           if(!$value) $value = 0;
           echo "<input id='{$field}' type='hidden' name='{$field}' value='$value'/>\n";
           echo "&nbsp;&nbsp;<label for='{$field}'>{$label}</label>";
           
           $this->_endField($field);
      }

◆ renderSearchScript()

FilterFieldRenderer\BooleanFilterFieldRenderer::renderSearchScript ( $field )

Definition at line 641 of file filter_form.inc.

      {
           $selChanged = "selChanged_" . $field . "_box";
           $onSubmit = $this->parent->getOnSubmitFunction();
 ?>
 <script type="text/javascript">
  
 function <? echo $selChanged ?>(elt)
 {
      var value_field = document.id('<?php echo $field ?>');
      var new_value = "0";
  
      if(value_field && elt)
      {
           if(elt.checked == true)
                new_value = "1";
           
           value_field.set("value", new_value);
      }
      if (<?php echo $onSubmit?>(elt.form)) elt.form.manager.submit();
 }
 </script>
 <?   
      }

Member Data Documentation

◆ $cssClass

FilterFieldRenderer\BooleanFilterFieldRenderer::$cssClass = "boolean"

Definition at line 581 of file filter_form.inc.

◆ $default

FilterFieldRenderer\BooleanFilterFieldRenderer::$default

Definition at line 582 of file filter_form.inc.

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

C:/code/cms.sonjara.com/framework/filter_form.inc

Public Member Functions

Public Attributes