Field renderer for zipcode data fields. More...

Inheritance diagram for PhoneNumberFieldRenderer:

Collaboration diagram for PhoneNumberFieldRenderer:

Public Member Functions
	PhoneNumberFieldRenderer (&$parent)

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

	renderScriptOnePart ($field, $limit)

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

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

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

	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
	$disable = false

	$template = "standard"

	$extension = false

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 zipcode data fields.

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 66 of file phone_number_field_renderer.inc.

Member Function Documentation

◆ addValidatorsToForm()

PhoneNumberFieldRenderer::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 215 of file phone_number_field_renderer.inc.

      {
           $label = isset($this->label) ? $this->label : $this->parent->prettifyFieldName($field);
  
           $parts = PhoneNumberTypeRenderer::$parts;
           
           $message = "Please supply phone as a 10-digit number.";
           foreach($parts as $part => $limit)
           {
                $partField = ($part) ? "{$field}_{$part}" : $field;
                if($part == "extension") continue;
                $regexp = "^\\d{" . $limit . "}$";
                $this->parent->validator->add(new RegularExpressionValidator($partField, $label, $regexp, $message));
           }
                
           if($required)
                $this->parent->validator->add(new RequiredValidator($field, $label));
      }

◆ format()

PhoneNumberFieldRenderer::format ( $field )

Definition at line 235 of file phone_number_field_renderer.inc.

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

◆ PhoneNumberFieldRenderer()

PhoneNumberFieldRenderer::PhoneNumberFieldRenderer ( & $parent )

Definition at line 72 of file phone_number_field_renderer.inc.

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

◆ preProcess()

PhoneNumberFieldRenderer::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 191 of file phone_number_field_renderer.inc.

      {         
           $parts = PhoneNumberTypeRenderer::$parts;
           
           $partValues = array();
           
           foreach($parts as $part => $limit)
           {
                $partField = ($part) ? "{$field}_{$part}" : $field;
                $partValues[] = $_POST[$partField];
           }
  
           $value = implode($partValues, "");
           $this->parent->data->set($field, $value);
      }

◆ renderField()

PhoneNumberFieldRenderer::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 123 of file phone_number_field_renderer.inc.

      {
           $parts = PhoneNumberTypeRenderer::$parts;
           
           $this->_startField($field);
  
           $value = $this->parent->data->get($field);
  
           $valueParts = PhoneNumberTypeRenderer::getValueParts($value);
           
           $idx = 0;
           foreach($parts as $part => $limit)
           {
                if($part == "extension" && !$this->extension)
                     continue;
                
                if($part == "area_code")
                     $pre = "(&nbsp;";
                elseif($part == "exchange")
                     $pre = ")&nbsp;&nbsp;";
                elseif($part == "extension")
                     $pre = "ext ";
                else
                     $pre = "<b>&#65293;</b>";
                     
                $partField = ($part) ? "{$field}_{$part}" : $field;
                
                $onkeypress = " onkeyup='{$this->parent->id}_{$partField}_keyup(event);'"; 
                $disable = ($this->disable) ? "disabled='disabled'" : "";
                echo "$pre<input id='{$this->parent->id}_{$partField}' style='width: auto' data-name='{$field}' type='text' name='{$partField}' value='".htmlspecialchars($valueParts[$part], ENT_QUOTES, 'UTF-8')."' size='$limit' onkeypress='return maskInput(event, false);' $disable $onkeypress/>&nbsp;";
                $idx++;   
           }
           
           $this->_endField($field);
      }

◆ renderReadOnly()

PhoneNumberFieldRenderer::renderReadOnly ( $field )

Definition at line 160 of file phone_number_field_renderer.inc.

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

◆ renderScript()

PhoneNumberFieldRenderer::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 77 of file phone_number_field_renderer.inc.

      {
           if ($this->parent->readOnlyForm || $this->parent->isReadOnly($field)
                || array_key_exists($field, $this->parent->hidden)) return "";
  
           $parts = PhoneNumberTypeRenderer::$parts;
 ?>
 <script type='text/javascript'>
 <?php          
      foreach($parts as $part => $limit)
      {
           if($part == "extension" && !$this->extension) 
                continue;
           $partField = ($part) ? "{$field}_{$part}" : $field;
           $this->renderScriptOnePart($partField, $limit);
      }
 ?></script><?php
      }

◆ renderScriptOnePart()

PhoneNumberFieldRenderer::renderScriptOnePart	(	$field,
		$limit
	)

Definition at line 96 of file phone_number_field_renderer.inc.

      {
 ?>
 function <?echo $this->parent->id?>_<?echo $field ?>_keyup(event)
 {
      var ctrl = document.id('<?echo "{$this->parent->id}_{$field}" ?>');
      if(!ctrl) return;
           
      if (event.key == "Tab" || event.key == "Shift") return;
      
      if(ctrl.value.length == <?php echo $limit ?>)
      {
           var next = ctrl.getNext("input");
           if(next && next.getAttribute('data-name') == ctrl.getAttribute('data-name'))
           {
                next.focus();
           }
      }
      else if (ctrl.value.length >= <?echo $limit ?>) 
      {
           ctrl.value = ctrl.value.substring(0, <?echo $limit ?>);
      }
      
 }
 <?php
      }

◆ renderSearchField()

PhoneNumberFieldRenderer::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 169 of file phone_number_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');
                echo "<tr>\n";
                $this->_printLabel($field);
                echo "<td><input type='text' id='$field' name='$field:$mode' value='{$value}' size='50'></td>\n";        
                echo "</tr>\n";
           }         
      }

Member Data Documentation

◆ $disable

PhoneNumberFieldRenderer::$disable = false

Definition at line 68 of file phone_number_field_renderer.inc.

◆ $extension

PhoneNumberFieldRenderer::$extension = false

Definition at line 70 of file phone_number_field_renderer.inc.

◆ $template

PhoneNumberFieldRenderer::$template = "standard"

Definition at line 69 of file phone_number_field_renderer.inc.

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

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

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ addValidatorsToForm()

◆ format()

◆ PhoneNumberFieldRenderer()

◆ preProcess()

◆ renderField()

◆ renderReadOnly()

◆ renderScript()

◆ renderScriptOnePart()

◆ renderSearchField()

Member Data Documentation

◆ $disable

◆ $extension

◆ $template