Field renderer for text data fields. More...

Inheritance diagram for TextFieldRenderer:

Collaboration diagram for TextFieldRenderer:

Public Member Functions
	TextFieldRenderer (&$parent)
	Constructs a new TextFieldRenderer object. More...

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

	renderReadOnly ($field)

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

	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
	$rows = 4
	The number of rows to display in the text area. More...

	$columns = 60
	The number of columns to display in the text area. More...

	$colspan = 2
	The number of table columns to display across. More...

	$limit = 0
	Optional limit on the number of characters allowed to be entered (enforced by Javascript). Note - make sure you have at least this many characters in your database field! More...

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

	$encoding = "UTF-8"
	Overrides the default text encoding. More...

	$style
	Inline styles for the text area element. 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 text data fields.

Renders as a multi-line text box area, with optional javascript character count display.

Example for $form= new autoform($document)

$fieldname=$form->getRenderer('field_name'); $fieldname->rows=3;

Definition at line 50 of file text_field_renderer.inc.

Member Function Documentation

◆ renderField()

TextFieldRenderer::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 101 of file text_field_renderer.inc.

      {
           $this->_startField($field);
           
           if ($this->limit)
           {
                echo "<div>";
                $onkeypress = " onkeyup='{$field}_keyup(event);'";
           }
           $disable = ($this->disable) ? "disabled='disabled'" : "";   
           
           if ($this->style) $style = "style='{$this->style}'";
           
           $placeholder = ($this->placeholder) ? " placeholder='".htmlSafe($this->placeholder)."'" : "";
           
           echo "<textarea id='{$this->parent->id}_$field' name='$field' rows='{$this->rows}' cols='{$this->columns}'{$placeholder} $style $disable $onkeypress>";
           echo cleanHTMLTags($this->parent->data->get($field));
           //echo htmlspecialchars($this->parent->data->get($field), ENT_QUOTES | ENT_IGNORE, $this->encoding);
           echo "</textarea>";
           
           if ($this->limit)
           {
                echo "<br /><div class='character_count' style='clear: left; float: right'><span id='{$field}_length'>";
                echo strlen(trim($this->parent->data->get($field)));
                echo "</span> of $this->limit characters</div></div>";
           }
           
           $this->_endField($field);
      }

◆ renderReadOnly()

TextFieldRenderer::renderReadOnly ( $field )

Definition at line 131 of file text_field_renderer.inc.

      {
           $this->_startField($field);
  
           $text = htmlspecialchars($this->parent->data->get($field), ENT_QUOTES | ENT_IGNORE, 'UTF-8');
           $text = str_replace("\n", "<br/>", $text);
           echo $text;
  
           $this->_endField($field);
      }

◆ renderScript()

TextFieldRenderer::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 75 of file text_field_renderer.inc.

      {
           if ($this->limit)
           {
 ?>
 <script type='text/javascript'>
 /* <![CDATA[ */
      function <?echo $field ?>_keyup(event)
      {
           var form = document.getElementById('<?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');
           count.innerHTML = len;
      }
 </script>
 <?
           }
      }

◆ renderSearchField()

TextFieldRenderer::renderSearchField	(	$field,
		$mode = `"like"`
	)

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 142 of file text_field_renderer.inc.

      {
           // AJG - Override default colspan when rendering in a search form
           $this->colspan = 1;
           
           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='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');
                echo "<tr>\n";
                $this->_printLabel($field);
                
                $placeholder = ($this->placeholder) ? " placeholder='".htmlSafe($this->placeholder)."'" : "";
                echo "<td><input type='text' name='$field:$mode' value='{$value}'{$placeholder} size='50'></td>\n";      
                echo "</tr>\n";
           }         
      }    

◆ TextFieldRenderer()

TextFieldRenderer::TextFieldRenderer ( & $parent )

Constructs a new TextFieldRenderer object.

Parameters

AutoForm $parent the parent AutoForm

Definition at line 65 of file text_field_renderer.inc.

      {
           global $config;
           
           $this->FieldRenderer($parent);
           
           $this->annotateBefore = true;
           if ($config["encoding"]) $this->encoding = $config["encoding"];
      }

Member Data Documentation

◆ $colspan

TextFieldRenderer::$colspan = 2

The number of table columns to display across.

Definition at line 54 of file text_field_renderer.inc.

◆ $columns

TextFieldRenderer::$columns = 60

The number of columns to display in the text area.

Definition at line 53 of file text_field_renderer.inc.

◆ $disable

TextFieldRenderer::$disable = false

Alternative to readonly; field can be reenabled thru javascript.

Definition at line 56 of file text_field_renderer.inc.

◆ $encoding

TextFieldRenderer::$encoding = "UTF-8"

Overrides the default text encoding.

Definition at line 57 of file text_field_renderer.inc.

◆ $limit

TextFieldRenderer::$limit = 0

Optional limit on the number of characters allowed to be entered (enforced by Javascript). Note - make sure you have at least this many characters in your database field!

Definition at line 55 of file text_field_renderer.inc.

◆ $placeholder

TextFieldRenderer::$placeholder = null

Placeholder text to display when field is empty.

Definition at line 59 of file text_field_renderer.inc.

◆ $rows

TextFieldRenderer::$rows = 4

The number of rows to display in the text area.

Definition at line 52 of file text_field_renderer.inc.

◆ $style

TextFieldRenderer::$style

Inline styles for the text area element.

Definition at line 58 of file text_field_renderer.inc.

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

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

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ renderField()

◆ renderReadOnly()

◆ renderScript()

◆ renderSearchField()

◆ TextFieldRenderer()

Member Data Documentation

◆ $colspan

◆ $columns

◆ $disable

◆ $encoding

◆ $limit

◆ $placeholder

◆ $rows

◆ $style