Field renderer for currency data fields. More...

Inheritance diagram for CurrencyFieldRenderer:

Collaboration diagram for CurrencyFieldRenderer:

Public Member Functions
	CurrencyFieldRenderer (&$parent)

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

	renderSearchField ($field, $mode="equal")
	FieldRenderers must override this method to provide the HTML implementation of the control displayed for the field in a search form. 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...

	addValidatorsToForm ($field, $required=false)
	This method is called by the AutoForm to add any default input validators that are required by the FieldRenderer. 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...

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

	renderSearchScript ($field, $mode)
	FieldRenderers can override this method to provide any Javascript that the control requires when being used in a search form. 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...

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

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

	$onKeyUp
	optional javascript callback on key release within field More...

	$template = 2
	how to format readonly - 2 decimal places More...

	$size = 20
	size of the text field to be displayed (in characters) 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 currency data fields.

Provides a two decimal place display and some simple numeric validation as default behavior.

Definition at line 44 of file currency_field_renderer.inc.

Member Function Documentation

◆ addValidatorsToForm()

CurrencyFieldRenderer::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 130 of file currency_field_renderer.inc.

      {
           $label = isset($this->label) ? $this->label : $this->parent->prettifyFieldName($field);
           
           if($required)
           {
                $this->parent->validator->add(new RequiredCurrencyValidator($field, $label));
           }
           
      }

◆ CurrencyFieldRenderer()

CurrencyFieldRenderer::CurrencyFieldRenderer ( & $parent )

Definition at line 55 of file currency_field_renderer.inc.

      {
           $this->FieldRenderer($parent);
      }

◆ format()

CurrencyFieldRenderer::format ( $field )

Definition at line 149 of file currency_field_renderer.inc.

      {
           return CurrencyTypeRenderer::format($this->parent->data->get($field), $this->template);
      }

◆ preProcess()

CurrencyFieldRenderer::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 120 of file currency_field_renderer.inc.

      {
           if ($this->parent->readOnlyForm || $this->parent->isReadOnly($field) || array_key_exists($field, $this->parent->hidden)) return "";
                
           $value= $_POST[$field];
           $value =  str_replace(",", "", $value);
           $this->parent->data->set($field, $value);
           $_POST[$field] = $value;
      }

◆ renderField()

CurrencyFieldRenderer::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 65 of file currency_field_renderer.inc.

      {
           $value = htmlspecialchars($this->parent->data->get($field), ENT_QUOTES, 'UTF-8');
           
           $value = floatval($value);
           // display with commas between thousands
           $value = $this->format($field);
           $disable = ($this->disable) ? "disabled='disabled'" : "";
           $readonly = ($this->static) ? " readonly='readonly'" : "";
           $allowneg = ($this->allowNegative) ? 1 : 0;
           $autocomplete = ($this->autocomplete) ? "" : " autocomplete='off' ";
           $onchange = ($this->onChange) ? "onchange='$this->onChange(this)'" : "";        
           $onKeyUp = ($this->onKeyUp) ? " onkeyup='{$this->onKeyUp}(this)'" : "";
           
           $this->_startField($field);
  
           echo "$&nbsp;<input id='{$this->parent->id}_{$field}' 
           type='text' name='$field' value='{$value}' $autocomplete onkeypress='return maskInput(event, $allowneg);'
           $onchange $onKeyUp $disable $readonly size='{$this->size}'/>";
  
           $this->_endField($field);
      }

◆ renderOnSubmitHandler()

CurrencyFieldRenderer::renderOnSubmitHandler ( $field )

FieldRenderers can override this method to provide any Javascript that must be executed when the form is submitted on the client.

See HTMLFieldRenderer for an example of how this is used.

Parameters

string $field the field name

Reimplemented from FieldRenderer.

Definition at line 141 of file currency_field_renderer.inc.

      {
           // JDG 3/2/2011., no js for readonly field
           if ($this->parent->isReadOnly($field)) return "";
           
           echo "\tdocument.id('{$this->parent->id}_{$field}').value = rawNumber(document.id('{$this->parent->id}_{$field}').value);\n";
      }

◆ renderReadOnly()

CurrencyFieldRenderer::renderReadOnly ( $field )

Definition at line 110 of file currency_field_renderer.inc.

      {
           $this->_startField($field);
  
           echo "$". $this->format($field);        
  
           $this->_endField($field);
      }

◆ renderScript()

CurrencyFieldRenderer::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 60 of file currency_field_renderer.inc.

      {
           //TODO: Add Numeric handling script from ICT-in-Education Toolkit
      }

◆ renderSearchField()

CurrencyFieldRenderer::renderSearchField	(	$field,
		$mode = `"equal"`
	)

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 88 of file currency_field_renderer.inc.

      {
           if ($mode == "range")
           {
                $from = htmlspecialchars($this->parent->params->get($field, "from"), ENT_QUOTES, 'UTF-8');
                $to =  htmlspecialchars($this->parent->params->get($field, "to"), ENT_QUOTES, 'UTF-8');
                
                echo "<tr>\n";
                $this->_printLabel($field);
                echo "<td>From <input type='text' name='$field:from' value='{$from}' size='20'> to <input type='text' name='$field:to' value='{$to}' size='20'></td>\n";        
                echo "</tr>\n";
           }
           else
           {
                $value = htmlspecialchars($this->parent->params->get($field, $mode), ENT_QUOTES, 'UTF-8');
                echo "<tr>\n";
                $this->_printLabel($field);
                echo "<td><input type='text' name='$field:$mode' value='{$value}' size='20'></td>\n";          
                echo "</tr>\n";
           }         
      }

Member Data Documentation

◆ $allowNegative

CurrencyFieldRenderer::$allowNegative = false

Whether user can enter a negative number.

Definition at line 46 of file currency_field_renderer.inc.

◆ $autocomplete

CurrencyFieldRenderer::$autocomplete = true

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

Definition at line 47 of file currency_field_renderer.inc.

◆ $disable

CurrencyFieldRenderer::$disable = false

alternative to readonly; field can be reenabled thru javascript

Definition at line 48 of file currency_field_renderer.inc.

◆ $onChange

CurrencyFieldRenderer::$onChange = ""

optional javascript callback on data input change

Definition at line 49 of file currency_field_renderer.inc.

◆ $onKeyUp

CurrencyFieldRenderer::$onKeyUp

optional javascript callback on key release within field

Definition at line 50 of file currency_field_renderer.inc.

◆ $size

CurrencyFieldRenderer::$size = 20

size of the text field to be displayed (in characters)

Definition at line 52 of file currency_field_renderer.inc.

◆ $static

CurrencyFieldRenderer::$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 53 of file currency_field_renderer.inc.

◆ $template

CurrencyFieldRenderer::$template = 2

how to format readonly - 2 decimal places

Definition at line 51 of file currency_field_renderer.inc.

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

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

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ addValidatorsToForm()

◆ CurrencyFieldRenderer()

◆ format()

◆ preProcess()

◆ renderField()

◆ renderOnSubmitHandler()

◆ renderReadOnly()

◆ renderScript()

◆ renderSearchField()

Member Data Documentation

◆ $allowNegative

◆ $autocomplete

◆ $disable

◆ $onChange

◆ $onKeyUp

◆ $size

◆ $static

◆ $template