TimeFieldRenderer Class Reference

Field renderer for time data fields. More...

Inheritance diagram for TimeFieldRenderer:

Collaboration diagram for TimeFieldRenderer:

Public Member Functions
	TimeFieldRenderer (&$parent)
	writeScript ($field)
	renderField ($field)
	FieldRenderers must override this method to provide the HTML implementation of the control used to edit 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...
	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...
	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...
	renderScript ($field)
	FieldRenderers can override this method to provide any Javascript that their control requires for an edit form. 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...

Additional Inherited Members
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 time data fields.

Definition at line 43 of file time_field_renderer.inc.

Member Function Documentation

addValidatorsToForm()

TimeFieldRenderer::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 78 of file time_field_renderer.inc.

     {
          $prettyName = $this->parent->prettifyFieldName($field);
 
          $this->parent->validator->add(new TimeValidator($field, $label));
                    
          if($required)
          {
               $this->parent->validator->add(new RequiredTimeValidator($field, $label));
          }         
     }

preProcess()

TimeFieldRenderer::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 116 of file time_field_renderer.inc.

     {
          $hh = checkNumeric($_POST["{$field}_hh"]);
          $mm = checkNumeric($_POST["{$field}_mm"]);
          $aa = $_POST["{$field}_aa"];
          if ($aa != "AM" && $aa != "PM") die("Invalid meridiem");
 
          // JDG - allow time fields to be empty
          if(!$hh)
          {
               $this->parent->data->set($field, $this->parent->data->reformatToSQLDate("00:00"));
               return;
          }
     
          if ($aa == "PM" && $hh != "12") $hh += 12;
          if ($aa == "AM" && $hh == "12") $hh = "00";
          $this->parent->data->set($field, "$hh:$mm");
     }

renderField()

TimeFieldRenderer::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 55 of file time_field_renderer.inc.

     {
          $value = $this->parent->data->get($field);
 
          // JDG show as empty if value stored is 00
          if ($value AND $value != '00:00:00')
          {
               $text = date("h/i/A", strtotime($value));
               list($hh, $mm, $aa) = explode("/", $text);
          }
      
          $this->_startField($field);
          
          echo "<input type='text' value='$hh' name='{$field}_hh' size='2' maxlength='2' onkeydown='return maskInput(event);'>&nbsp;:&nbsp;<input type='text' value='$mm' name='{$field}_mm' size='2' maxlength='2' onkeydown='return maskInput(event);'>";
          echo "&nbsp;<select name='{$field}_aa'><option";
          if ($aa == 'AM') echo " selected";
          echo ">AM</option><option";
          if ($aa == 'PM') echo " selected";
          echo ">PM</option></select>";
          
          $this->_endField($field);
     }

renderReadOnly()

TimeFieldRenderer::renderReadOnly

(

$field

)

Definition at line 105 of file time_field_renderer.inc.

     {
          $this->_startField($field);
 
          //echo date('h:i A', strttotime($this->parent->data->get($field)));
 
          echo $this->parent->data->format("{{$field}:h:i A}");
          
          $this->_endField($field);
     }

renderSearchField()

TimeFieldRenderer::renderSearchField	(		$field,
			$mode
	)

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 90 of file time_field_renderer.inc.

     {
          echo "<tr>\n";
          echo "<td colspan='2'";
          if ($this->parent->labelCSS) echo " class='{$this->parent->labelCSS}'";
          echo "><input type='checkbox' value='1' name='$field:$mode'";
          if ($this->parent->data->get($field))
          {
               echo " checked";
          }
          echo ">&nbsp;";
          echo $this->parent->prettifyFieldName($field);
          echo "</td>\n</tr>\n";        
     }

TimeFieldRenderer()

TimeFieldRenderer::TimeFieldRenderer

(

&

$parent

)

Definition at line 45 of file time_field_renderer.inc.

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

writeScript()

TimeFieldRenderer::writeScript

(

$field

)

Definition at line 50 of file time_field_renderer.inc.

     {
          //TODO: Script to mask for correct input
     }

---

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

• C:/code/cms.sonjara.com/framework/field_renderers/time_field_renderer.inc