Provides a very simple digital signature implementation. More...

Inheritance diagram for SignatureFieldRenderer:

Collaboration diagram for SignatureFieldRenderer:

Public Member Functions
	SignatureFieldRenderer (&$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...

	setSignatureField ($signatureField, $errorMessage)
	Overrides the default field used to match when signing. More...

	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 StringFieldRenderer
	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)

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

	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
	$errorMessage = "Your signature does not match your password. Please try again."

	$password = true
	Whether to mask the input in the signature field. More...

	$autocomplete = false
	Whether to allow autocomplete. More...

	$signatureField = "password"
	The field to check for a match when signing. More...

Public Attributes inherited from StringFieldRenderer
	$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

Provides a very simple digital signature implementation.

All it can say is that the correct password was entered by the given user at a given point in time.

Author: andy

Definition at line 14 of file signature_field_renderer.inc.

Member Function Documentation

◆ addValidatorsToForm()

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

Definition at line 29 of file signature_field_renderer.inc.

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

◆ preProcess()

SignatureFieldRenderer::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 100 of file signature_field_renderer.inc.

      {
           global $user;
           
           if (!$_POST[$field]) return;
           
           $obj = $this->parent->data;
           if ($this->signatureField == "password")
           {
                $obj->set($field, $user->hashPassword($_POST[$field]).":".today().":".$user->get($user->getPrimaryKey()));
           }
           else
           {
                $obj->set($field, $_POST[$field]).":".today().":".$user->get($user->getPrimaryKey());
           }
      }

◆ renderField()

SignatureFieldRenderer::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 51 of file signature_field_renderer.inc.

      {
           if ($this->parent->msg)
           {
                //Clear out field if the form is in error, to force user to re-enter
                $this->parent->data->set($field, '');
           }
           
           if ($this->parent->data->get($field))
           {
                $this->renderReadOnly($field);
           }
           else
           {
                parent::renderField($field);
           }
      }

◆ renderReadOnly()

SignatureFieldRenderer::renderReadOnly ( $field = "" )

Reimplemented from StringFieldRenderer.

Definition at line 69 of file signature_field_renderer.inc.

      {
           if (!$field) $field = $this->field;
           $value = $this->parent->data->get($field);
           list($signature,$date,$user_id) = explode(":", $value);
           
           if ($user_id)
           {
                try
                {
                     $mgr = new UserManager();
                     $u = $mgr->getUser($user_id);
                     $msg = "Signed by ".$mgr->getUserFullName($u)." on $date";
                }
                catch(Exception $e)
                {
                     $msg = "Invalid Signature";
                }
           }
           else
           {
                $msg = "Not signed";
           }
           
           $this->_startField($field);
  
           echo $msg;
           
           $this->_endField($field);
      }

◆ setSignatureField()

SignatureFieldRenderer::setSignatureField	(	$signatureField,
		$errorMessage
	)

Overrides the default field used to match when signing.

Parameters

string	$signatureField	the field that is to be match (i.e. email, username)
string	$errorMessage	the error message to display when the match fails

Definition at line 45 of file signature_field_renderer.inc.

      {
           $this->signatureField = $signatureField;
           $this->errorMessage = $errorMessage;
      }

◆ SignatureFieldRenderer()

SignatureFieldRenderer::SignatureFieldRenderer ( & $parent )

Definition at line 22 of file signature_field_renderer.inc.

      {
           $this->StringFieldRenderer($parent);
           $this->password = true;
           $this->autocomplete = false;
      }

Member Data Documentation

◆ $autocomplete

SignatureFieldRenderer::$autocomplete = false

Whether to allow autocomplete.

Definition at line 19 of file signature_field_renderer.inc.

◆ $errorMessage

SignatureFieldRenderer::$errorMessage = "Your signature does not match your password. Please try again."

Definition at line 16 of file signature_field_renderer.inc.

◆ $password

SignatureFieldRenderer::$password = true

Whether to mask the input in the signature field.

Definition at line 18 of file signature_field_renderer.inc.

◆ $signatureField

SignatureFieldRenderer::$signatureField = "password"

The field to check for a match when signing.

Definition at line 20 of file signature_field_renderer.inc.

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

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

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ addValidatorsToForm()

◆ preProcess()

◆ renderField()

◆ renderReadOnly()

◆ setSignatureField()

◆ SignatureFieldRenderer()

Member Data Documentation

◆ $autocomplete

◆ $errorMessage

◆ $password

◆ $signatureField