Field renderer for password data fields. More...

Inheritance diagram for PasswordFieldRenderer:

Collaboration diagram for PasswordFieldRenderer:

Public Member Functions
	PasswordFieldRenderer (&$parent)

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

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

	renderPasswordBlock ($field, $display="block")

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

	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
	$encryptor

	$forceReset = false
	true if user logged in with a temporary token More...

	$numeric = false

	$allowEmpty = 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 password data fields.

Renders as a compound control with password and confirmation fields. Additionally, if updating an existing record the user must click "Update Password" to gain access to these fields.

Definition at line 46 of file password_field_renderer.inc.

Member Function Documentation

◆ addValidatorsToForm()

PasswordFieldRenderer::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 59 of file password_field_renderer.inc.

      {
           $label = str_replace("*", "", $this->parent->prettifyFieldName($field));
           $this->parent->match($field, $label, "{$field}_confirm", "Confirmation");
           $this->parent->password($field, $label);     
      }

◆ PasswordFieldRenderer()

PasswordFieldRenderer::PasswordFieldRenderer ( & $parent )

Definition at line 53 of file password_field_renderer.inc.

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

◆ preProcess()

PasswordFieldRenderer::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 142 of file password_field_renderer.inc.

      {
           $pk = $this->parent->data->getPrimaryKey();
           
           if (!$this->parent->data->$pk || $_POST["{$this->parent->id}_{$field}_reset_password"])
           {
                $password = $_POST[$field];
           }
           else
           {
                if ($this->parent->data->getFilter() == null)
                {
                     $this->parent->data->setFilter(new ExclusionFilter());
                }
                
                $filter = $this->parent->data->getFilter();
                
                if ($filter->type == "ExclusionFilter")
                {
                     $filter->add($field);
                }
                else
                {
                     $filter->remove($field);
                }
           }
           
           if ($this->allowEmpty && !$password)
           {
                $this->parent->data->set($field, "");
           }
           else
           {
                $encryptor = $this->parent->passwordEncryptor;
                
                trace("Encryptor: $encryptor", 3);
                
                if ($encryptor)
                {
                     $password = $this->parent->data->$encryptor($password);
                }
                else
                {
                     $password = crypt($password);
                }
                
                $this->parent->data->set($field, $password);
           }
      }    

◆ renderField()

PasswordFieldRenderer::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 109 of file password_field_renderer.inc.

      {
           $pk = $this->parent->data->getPrimaryKey();
      
           $this->_startField($field);
           
           if (($this->parent->data->get($pk) && !$this->forceReset) || $this->allowEmpty)
           {
                $verb = ($this->allowEmpty && !$this->parent->data->get($pk)) ? "set" : "reset";
                
                echo "<a id='{$this->parent->id}_{$field}_link' href='#' onclick='{$this->parent->id}_{$field}_showPassword();return false;'>Click to {$verb} password</a>\n";
                $this->renderPasswordBlock($field, "none");
                echo "<input type='hidden' id='{$this->parent->id}_{$field}_reset_password' name='{$this->parent->id}_{$field}_reset_password' value=''/>\n";
           }
           else
           {
                $this->renderPasswordBlock($field);
                echo "<input type='hidden' id='{$this->parent->id}_{$field}_reset_password' name='{$this->parent->id}_{$field}_reset_password' value='1'/>\n";
           }
           
           $this->_endField($field);
           
      }

◆ renderPasswordBlock()

PasswordFieldRenderer::renderPasswordBlock	(	$field,
		$display = `"block"`
	)

Definition at line 89 of file password_field_renderer.inc.

      {
           $enter = $this->parent->passwordEnterLabel;
           $confirm = $this->parent->passwordConfirmLabel;
           $size = $this->numeric ? "6" : "20";
           $onKeyPress = $this->numeric ? " onkeypress='return maskInput(event, $allowneg);'" : ""
 ?>
                 <table border="0" cellspacing="0" cellpadding="0" id="<?echo $this->parent->id ?>_<?echo $field?>_block" style="padding: 0px; display: <?echo $display ?>">
                  <tr>
                     <td style="vertical-align: top; text-align: left"><?echo $enter?>&nbsp;</td>
                     <td style="padding-bottom: 2px"><input type="password" autocomplete="new-password" name="<?echo $field?>" id="<?echo $this->parent->id?>_<?echo $field?>" size="<?echo $size?>"<?echo $onKeyPress?> value=""/></td>
                  </tr>
                  <tr>
                     <td style="vertical-align: top; text-align: left"><?echo $confirm?>&nbsp;</td>
                     <td><input type="password" name="<?echo $field?>_confirm" id="<?echo $this->parent->id?>_<?echo $field?>_confirm" size="<?echo $size?>"<?echo $onKeyPress?> value=""/></td>
                  </tr>
                 </table>      
 <?
      }

◆ renderReadOnly()

PasswordFieldRenderer::renderReadOnly ( $field )

Definition at line 133 of file password_field_renderer.inc.

      {
           $this->_startField($field);
  
           echo "<i>Password is hidden</i>\n";
           
           $this->_endField($field);
      }

◆ renderScript()

PasswordFieldRenderer::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 66 of file password_field_renderer.inc.

      {
           if (!$this->_includedPasswordScript)
           {
 ?>
 <script type='text/javascript'>
 <!--
 function <?echo $this->parent->id?>_<?echo $field?>_showPassword()
 {
      var link = document.getElementById("<?echo $this->parent->id?>_<?echo $field?>_link");
      var block = document.getElementById("<?echo $this->parent->id?>_<?echo $field?>_block");
      document.id("<?echo $this->parent->id ?>_<?echo $field?>_reset_password").value = 1;
      
      link.style.display = "none";
      block.style.display = "block";
      ModalDialog.recenterActiveDialog();
 }
 //-->
 </script>
 <?             $this->_includedPasswordScript = true;
           }         
      }

Member Data Documentation

◆ $allowEmpty

PasswordFieldRenderer::$allowEmpty = false

Definition at line 51 of file password_field_renderer.inc.

◆ $encryptor

PasswordFieldRenderer::$encryptor

Definition at line 48 of file password_field_renderer.inc.

◆ $forceReset

PasswordFieldRenderer::$forceReset = false

true if user logged in with a temporary token

Definition at line 49 of file password_field_renderer.inc.

◆ $numeric

PasswordFieldRenderer::$numeric = false

Definition at line 50 of file password_field_renderer.inc.

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

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

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ addValidatorsToForm()

◆ PasswordFieldRenderer()

◆ preProcess()

◆ renderField()

◆ renderPasswordBlock()

◆ renderReadOnly()

◆ renderScript()

Member Data Documentation

◆ $allowEmpty

◆ $encryptor

◆ $forceReset

◆ $numeric