Field renderer for string data fields. More...

Inheritance diagram for StringFieldRenderer:

Collaboration diagram for StringFieldRenderer:

Public Member Functions
	StringFieldRenderer (&$parent)

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

	renderField ($field, $readonly=false)

	renderReadOnly ($field)

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

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

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

	$limit = 0
	optional - restricts users from entering character count over limit More...

	$autocomplete = true
	default is true. Set to false to disable autocompletion More...

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

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

	$password = false
	Render the field as a password field (masked characters) More...

	$template = ""
	StringTypeRenderer template for readonly format (e.g., "prettify") More...

	$confirm = false
	Render a second field for the user to confirm their entry (for email addresses, etc) More...

	$width = ""
	Optionally specify a CSS width for the field. More...

	$CSSclass = ""
	Optionally specify a CSS class for the field. More...

	$numeric = false
	Restrict to numeric input. More...

	$onKeyPress = null
	Optional key press javascript callback. Note that if $limit is set, it will override this. More...

	$placeholder = null
	Placeholder text to display when field is empty. 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 string data fields.

Renders as a single-line text field.

size: the length of the input field

limit: maximum number of characters user may enter

autocomplete: whether field may attempt autocompletion based on the user-entered data string.

onChange: script-defined callback function to call when user edits the field (script is called on field exit, not for each key entered)

disable: alternative to readonly; field can be reenabled thru javascript

Example: to disable input in a field, add the following line of code to your calling script: $form->getRenderer("foo")->disable = true;

Definition at line 61 of file string_field_renderer.inc.

Member Function Documentation

◆ addValidatorsToForm()

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

Reimplemented in URLFieldRenderer, and SignatureFieldRenderer.

Definition at line 198 of file string_field_renderer.inc.

      {
           $label = isset($this->label) ? $this->label : $this->parent->prettifyFieldName($field);
           $confirm = "confirm_$field";
           $confirmLabel = "Confirm $label";
           
           if($required)
                $this->parent->validator->add(new RequiredValidator($field, $label));
                
           if ($this->confirm)
           {
                $this->parent->validator->add(new MatchValidator($field, $label, $confirm, $confirmLabel));
           }
      }

◆ format()

StringFieldRenderer::format ( $field )

Definition at line 214 of file string_field_renderer.inc.

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

◆ renderField()

StringFieldRenderer::renderField	(	$field,
		$readonly = `false`
	)

Definition at line 112 of file string_field_renderer.inc.

      {
           $this->_startField($field);
           
           if ($this->limit)
           {
                echo "<div>";
                $onkeypress = " onkeyup='{$field}_keyup(event);'";
           }
           
           if (!$onkeypress && $this->onKeyPress)
           {
                $onkeypress = " onkeyup='return {$this->onKeyPress}(this);'";
           }
           
           $autocomplete = (!$this->autocomplete) ? "autocomplete='off' " : "";       
           $onchange = ($this->onChange) ? "onchange='$this->onChange(this)'" : "";        
           $disable = ($this->disable) ? "disabled='disabled'" : "";        
           $inputType = (!$this->password) ? "text" : "password";
           $style = ($this->width) ? " style='width: {$this->width}'" : "";
           $class = ($this->CSSclass) ? "class='{$this->CSSclass}'" : "";
           $value = (!$this->password) ? htmlspecialchars($this->parent->data->get($field), ENT_QUOTES, 'UTF-8') : "";
           
           $keyPress = $this->numeric ? "onkeypress='return maskInput(event, false);'" : "";
           
           $placeholder = ($this->placeholder) ? " placeholder='".htmlSafe($this->placeholder)."'" : "";
           
           echo "<input id='{$this->parent->id}_{$field}' type='$inputType' name='$field' $placeholder $keyPress $onchange $autocomplete $class $style value='$value' size='{$this->size}' $disable $onkeypress/>";
  
           if ($this->limit)
           {
                echo "</div>";
           }
           $this->_endField($field);
           
           if ($this->confirm)
           {
                $confirm = "confirm_$field";
                $this->_startField($confirm);
                
                $autocomplete = (!$this->autocomplete) ? "autocomplete='off' " : "";       
                $disable = ($this->disable) ? "disabled='disabled'" : "";        
                $inputType = (!$this->password) ? "text" : "password";
                echo "<input id='{$this->parent->id}_{$confirm}' type='$inputType' name='$confirm' $autocomplete value='".htmlspecialchars($this->parent->data->get($field), ENT_QUOTES, 'UTF-8')."' size='{$this->size}' $disable/>";
           
                $this->_endField($field);
           }    
      }

◆ renderReadOnly()

StringFieldRenderer::renderReadOnly ( $field )

Reimplemented in SignatureFieldRenderer, and URLFieldRenderer.

Definition at line 161 of file string_field_renderer.inc.

      {
           $this->_startField($field);
           
           if (!$this->parent->readOnlyForm)
           {
                echo "<input id='{$this->parent->id}_{$field}' type='hidden' name='$field' value='".htmlspecialchars($this->parent->data->get($field), ENT_QUOTES, 'UTF-8')."'/>";
           }
           
           echo $this->format($field);
           
           $this->_endField($field);
      }

◆ renderScript()

StringFieldRenderer::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 82 of file string_field_renderer.inc.

      {
           if ($this->limit)
           {
 ?>
 <script type='text/javascript'>
 /* <![CDATA[ */
      function <?echo $field ?>_keyup(event)
      {
           var form = document.id('<?echo $this->parent->id ?>');
           
           var ctrl = form['<?echo $field ?>'];
           var len = ctrl.value.length;
           if (len >= <?echo $this->limit?>) 
           {
                ctrl.value = ctrl.value.substring(0, <?echo $this->limit ?>);
                len = <?echo $this->limit ?>;
           }
           
           var count = document.getElementById('<?echo $field ?>_length');
  
           // JDG 2/1/10 must check count to fix IE7 bug
           if(count)
                count.innerHTML = len;
      }
 </script>
 <?
           }
      }

◆ renderSearchField()

StringFieldRenderer::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 175 of file string_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' id='$field' name='$field:from' value='{$from}' size='25'> to <input type='text' name='$field:to' value='{$to}' size='25'></td>\n";      
                echo "</tr>\n";
           }
           else
           {
                $value =  htmlspecialchars($this->parent->params->get($field, $mode), ENT_QUOTES, 'UTF-8');
                $this->_startField($field);
                $placeholder = ($this->placeholder) ? " placeholder='".htmlSafe($this->placeholder)."'" : "";
                echo "<input type='text' id='$field' name='$field:$mode' {$placeholder} value='{$value}' size='{$this->size}' >\n";          
                $this->_endField($field);
           }         
      }

◆ StringFieldRenderer()

StringFieldRenderer::StringFieldRenderer ( & $parent )

Definition at line 77 of file string_field_renderer.inc.

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

Member Data Documentation

◆ $autocomplete

StringFieldRenderer::$autocomplete = true

default is true. Set to false to disable autocompletion

Definition at line 65 of file string_field_renderer.inc.

◆ $confirm

StringFieldRenderer::$confirm = false

Render a second field for the user to confirm their entry (for email addresses, etc)

Definition at line 70 of file string_field_renderer.inc.

◆ $CSSclass

StringFieldRenderer::$CSSclass = ""

Optionally specify a CSS class for the field.

Definition at line 72 of file string_field_renderer.inc.

◆ $disable

StringFieldRenderer::$disable = false

alternative to readonly; field can be reenabled thru javascript

Definition at line 67 of file string_field_renderer.inc.

◆ $limit

StringFieldRenderer::$limit = 0

optional - restricts users from entering character count over limit

Definition at line 64 of file string_field_renderer.inc.

◆ $numeric

StringFieldRenderer::$numeric = false

Restrict to numeric input.

Definition at line 73 of file string_field_renderer.inc.

◆ $onChange

StringFieldRenderer::$onChange = ""

optional (javascript) callback on data input change

Definition at line 66 of file string_field_renderer.inc.

◆ $onKeyPress

StringFieldRenderer::$onKeyPress = null

Optional key press javascript callback. Note that if $limit is set, it will override this.

Definition at line 74 of file string_field_renderer.inc.

◆ $password

StringFieldRenderer::$password = false

Render the field as a password field (masked characters)

Definition at line 68 of file string_field_renderer.inc.

◆ $placeholder

StringFieldRenderer::$placeholder = null

Placeholder text to display when field is empty.

Definition at line 75 of file string_field_renderer.inc.

◆ $size

StringFieldRenderer::$size = 50

Definition at line 63 of file string_field_renderer.inc.

◆ $template

StringFieldRenderer::$template = ""

StringTypeRenderer template for readonly format (e.g., "prettify")

Definition at line 69 of file string_field_renderer.inc.

◆ $width

StringFieldRenderer::$width = ""

Optionally specify a CSS width for the field.

Definition at line 71 of file string_field_renderer.inc.

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

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

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ addValidatorsToForm()

◆ format()

◆ renderField()

◆ renderReadOnly()

◆ renderScript()

◆ renderSearchField()

◆ StringFieldRenderer()

Member Data Documentation

◆ $autocomplete

◆ $confirm

◆ $CSSclass

◆ $disable

◆ $limit

◆ $numeric

◆ $onChange

◆ $onKeyPress

◆ $password

◆ $placeholder

◆ $size

◆ $template

◆ $width