Field renderer for numeric data fields. More...

Inheritance diagram for NumberFieldRenderer:

Collaboration diagram for NumberFieldRenderer:

Public Member Functions
	NumberFieldRenderer (&$parent, $field=null)

	addValidatorsToForm ($field, $required=false)
	This method is called by the AutoForm to add any default input validators that are required by the FieldRenderer. More...

	setUnits ($units, $position)
	Sets the displayed units and their position. More...

	setRange ($min, $max, $step=1)
	Specifies that the field should be rendered with a "number" HTML control with the supplied range and step. More...

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

	renderReadOnly ($field)

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

	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
	$allowNegative = false
	Whether user can enter a negative number. More...

	$autocomplete = true
	Whether the browser is allowed to show autocomplete for this field. More...

	$size = 15
	Size of the displayed control in characters. More...

	$onKeyUp
	optional javascript callback function for key up events More...

	$disable = false
	alternative to readonly; field can be reenabled or set thru javascript More...

	$onChange = ""
	optional javascript callback on data input change More...

	$units = ""
	units text to display More...

	$unitsPosition = ""
	whether to display units before or after the control More...

	$blankZero = false
	Leave field blank if value is zero. More...

	$control = "text"
	The HTML control type to use when rendering. This gets set to "number" if a range is specified. More...

	$static = false
	Render the field as a static (readonly) value, that is visible, non-editable and the value is submitted when the form is submitted. 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

Field renderer for numeric data fields.

Renders as a text box with numerically masked input (user cannot enter non-numeric characters).

Allow negative defaults to false; if a field should allow negative numbers, calling script should add the following line: $form->getRenderer("field_name")->allowNegative = true;

Definition at line 48 of file number_field_renderer.inc.

Member Function Documentation

◆ addValidatorsToForm()

NumberFieldRenderer::addValidatorsToForm	(	$field,
		$required = `false`
	)

This method is called by the AutoForm to add any default input validators that are required by the FieldRenderer.

Fields that need custom validation or a custom required validator should override this function.

Parameters

string	$field	the field name
boolean	$required	- whether the field is required

Reimplemented from FieldRenderer.

Definition at line 72 of file number_field_renderer.inc.

      {
           parent::addValidatorsToForm($field);
           
           if ($this->control == "number")
           {
                $label = isset($this->label) ? $this->label : $this->parent->prettifyFieldName($field);
           
                $this->parent->validator->add(new RangeValidator($field, $label, $this->min, $this->max));
           }
      }

◆ NumberFieldRenderer()

NumberFieldRenderer::NumberFieldRenderer	(	&	$parent,
			$field = `null`
	)

Definition at line 63 of file number_field_renderer.inc.

      {
           $this->FieldRenderer($parent);
           if ($field && !$parent->data->hasField($field))
           {
                $parent->add($this, $field);
           }
      }

◆ preProcess()

NumberFieldRenderer::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 168 of file number_field_renderer.inc.

      {
           $current = $this->parent->data->get($field);
                     
           $value = str_replace(",", "", $current);
           
           if($this->allowNegative)
           {              
                if(substr($value, 0,1) == '-')
                     $value = '-' . str_replace("-", "", $value);
                else
                     $value = str_replace("-", "", $value);
           }
           $this->parent->data->$field = $value;
      }    

◆ renderField()

NumberFieldRenderer::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 113 of file number_field_renderer.inc.

      {
           $this->_startField($field);
           
           $readonly = ($this->static) ? " readonly='readonly'" : "";
           $disable = ($this->disable) ? "disabled='disabled'" : "";
           $onKeyUp = ($this->onKeyUp) ? " onkeyup='{$this->onKeyUp}(this)'" : "";
           // JDG - maskInput function doesn't recognize boolean var value
           // translate to 0 or 1
           $allowneg = ($this->allowNegative) ? 1 : 0;
           $autocomplete = ($this->autocomplete) ? "" : " autocomplete='off' ";
           $onchange = ($this->onChange) ? "onchange='{$this->onChange}(this)'" : "";      
           
           if ($this->unitsPosition == "before") echo $this->units." ";
           
           $value = $this->parent->data->get($field);
           if ($value == 0 && $this->blankZero)
           {
                $value = "";
           }
           
           if ($this->control == "number")
           {
                $control = "number";
                $rangeAttrs = " min='{$this->min}' max='{$this->max}' step='{$this->step}'";
           }
           else 
           {
                $control = "text";
                $rangeAttrs = "";
           }
           echo "<input id='{$this->parent->id}_$field' type='{$control}' style='width: auto' name='$field' 
           value='".$value."' $rangeAttrs $autocomplete 
           size='{$this->size}' onkeypress='return maskInput(event, $allowneg);' $disable $static $onchange $onKeyUp/>";
           
           if ($this->unitsPosition == "after") echo " ".$this->units;
           
           $this->_endField($field);
      }

◆ renderReadOnly()

NumberFieldRenderer::renderReadOnly ( $field )

Definition at line 153 of file number_field_renderer.inc.

      {
           $this->_startField($field);
  
           if ($this->unitsPosition == "before") echo $this->units." ";
           
           echo $this->parent->data->get($field);
  
           if ($this->unitsPosition == "after") echo " ".$this->units;
           
           $this->_endField($field);
      }

◆ setRange()

NumberFieldRenderer::setRange	(	$min,
		$max,
		$step = `1`
	)

Specifies that the field should be rendered with a "number" HTML control with the supplied range and step.

Parameters

mixed	$min	the minimum value for the field
mixed	$max	the maximum value for the field
mixed	$step	the amount to step when the spinner up/down buttons are clicked

Definition at line 103 of file number_field_renderer.inc.

      {
           $this->min = min($max, $min);
           $this->max = max($max, $min);
           $this->step = $step;
           $this->control = "number";
           
           return $this;
      }

◆ setUnits()

NumberFieldRenderer::setUnits	(	$units,
		$position
	)

Sets the displayed units and their position.

Parameters

string	$units
string	$position

Definition at line 89 of file number_field_renderer.inc.

      {
           $this->units = $units;
           $this->unitsPosition = $position;
           return $this;
      }

Member Data Documentation

◆ $allowNegative

NumberFieldRenderer::$allowNegative = false

Whether user can enter a negative number.

Definition at line 51 of file number_field_renderer.inc.

◆ $autocomplete

NumberFieldRenderer::$autocomplete = true

Whether the browser is allowed to show autocomplete for this field.

Definition at line 52 of file number_field_renderer.inc.

◆ $blankZero

NumberFieldRenderer::$blankZero = false

Leave field blank if value is zero.

Definition at line 59 of file number_field_renderer.inc.

◆ $control

NumberFieldRenderer::$control = "text"

The HTML control type to use when rendering. This gets set to "number" if a range is specified.

Definition at line 60 of file number_field_renderer.inc.

◆ $disable

NumberFieldRenderer::$disable = false

alternative to readonly; field can be reenabled or set thru javascript

Definition at line 55 of file number_field_renderer.inc.

◆ $onChange

NumberFieldRenderer::$onChange = ""

optional javascript callback on data input change

Definition at line 56 of file number_field_renderer.inc.

◆ $onKeyUp

NumberFieldRenderer::$onKeyUp

optional javascript callback function for key up events

Definition at line 54 of file number_field_renderer.inc.

◆ $size

NumberFieldRenderer::$size = 15

Size of the displayed control in characters.

Definition at line 53 of file number_field_renderer.inc.

◆ $static

NumberFieldRenderer::$static = false

Render the field as a static (readonly) value, that is visible, non-editable and the value is submitted when the form is submitted.

Definition at line 61 of file number_field_renderer.inc.

◆ $units

NumberFieldRenderer::$units = ""

units text to display

Definition at line 57 of file number_field_renderer.inc.

◆ $unitsPosition

NumberFieldRenderer::$unitsPosition = ""

whether to display units before or after the control

Definition at line 58 of file number_field_renderer.inc.

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

C:/code/cms.sonjara.com/framework/field_renderers/number_field_renderer.inc

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ addValidatorsToForm()

◆ NumberFieldRenderer()

◆ preProcess()

◆ renderField()

◆ renderReadOnly()

◆ setRange()

◆ setUnits()

Member Data Documentation

◆ $allowNegative

◆ $autocomplete

◆ $blankZero

◆ $control

◆ $disable

◆ $onChange

◆ $onKeyUp

◆ $size

◆ $static

◆ $units

◆ $unitsPosition