Field renderer for date data fields. More...

Inheritance diagram for DateTimeFieldRenderer:

Collaboration diagram for DateTimeFieldRenderer:

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

	renderField ($field)
	FieldRenderers must override this method to provide the HTML implementation of the control used to edit the field. 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...

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

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

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

	$requireTime = true

	$template = ""

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

Renders with date format validation and a date picking popup widget.

@template - field formatting format for readonly is standard "F d, Y", accepts "long", "daylong", and "short" and any format string used by php date function

Definition at line 48 of file datetime_field_renderer.inc.

Member Function Documentation

◆ addValidatorsToForm()

DateTimeFieldRenderer::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 datetime_field_renderer.inc.

      {
           $label = isset($this->label) ? $this->label : $this->parent->prettifyFieldName($field);
      
           $this->parent->validator->add(new DateValidator($field, $label));
           $this->parent->validator->add(new TimeValidator($field, $label));
                
           if($required)
           {
                $this->parent->validator->add(new RequiredValidator($field, $label));
                if($this->requireTime)
                     $this->parent->validator->add(new RequiredTimeValidator($field, $label . " Time"));
           }    
      }

◆ DateTimeFieldRenderer()

DateTimeFieldRenderer::DateTimeFieldRenderer ( & $parent )

Definition at line 54 of file datetime_field_renderer.inc.

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

◆ format()

DateTimeFieldRenderer::format ( $field )

Definition at line 224 of file datetime_field_renderer.inc.

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

◆ preProcess()

DateTimeFieldRenderer::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 198 of file datetime_field_renderer.inc.

      {         
           $hh = checkNumeric($_POST["{$field}_hh"]);
           if(intval($hh) == 0) $hh = "00";
           $mm = checkNumeric($_POST["{$field}_mm"]);
           if(intval($mm) == 0) $mm = "00";
           $aa = $_POST["{$field}_aa"];
           $dd = $_POST["{$field}"];
           
           if (!$dd)
           {
                $this->parent->data->set($field, $this->parent->data->reformatToSQLDate("00/00/0000 00:00:00"));
                return;
           }
           if($hh == "00" && $mm == "00")
           {
                $this->parent->data->set($field, $this->parent->data->reformatToSQLDate("$dd"));
                return;
           }
           
           if ($aa != "AM" && $aa != "PM") throw new FakoliException("Invalid meridiem");
           if ($aa == "PM" && $hh != "12") $hh += 12;
           if ($aa == "AM" && $hh == "12") $hh = "00";
           $this->parent->data->set($field, $this->parent->data->reformatToSQLDate("$dd $hh:$mm:00"));
      }

◆ renderField()

DateTimeFieldRenderer::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 91 of file datetime_field_renderer.inc.

      {
           $obj = $this->parent->data;
           $value = $obj->get($field);
           
           // JDG 10/1/2010 check for empty saved string
           $date = "";
           if($value AND $value != '0000-00-00 00:00:00')
                $date = DateTimeTypeRenderer::format($obj->reformatFromSQLDate($value), "m/d/Y");
           
           $this->_startField($field);
           echo "<input id='{$this->parent->id}_{$field}' type='text' name='$field' value='$date' size='12'>&nbsp;<img src='{$this->parent->componentPath}/calendar/calendar.gif' alt='Popup Calendar' align='absmiddle' border='0' onclick='{$field}_calendar.toggle(this)'>\n";
                
           // If no time component, show as blank, not 12:00 AM
           if ($value AND !preg_match("/00:00:00$/", $value))
           {
                $text = date("h/i/A", strtotime($value));
                list($hh, $mm, $aa) = explode("/", $text);
           }
           
           echo "<div id='{$this->parent->id}_{$field}_block' style='display: inline'>\n";
           echo "&nbsp;&nbsp;<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>";
           echo "</div>\n";
           
           $this->_endField($field);
      }

◆ renderReadOnly()

DateTimeFieldRenderer::renderReadOnly ( $field )

Definition at line 180 of file datetime_field_renderer.inc.

      {                        
           $this->_startField($field);
           
           echo $this->format($field);
           
           // AJG - if the field is read-only but the form is not, add a hidden field to
           // retain the field value upon submission.   
           if (!$this->parent->readOnlyForm)
           {
                $obj = $this->parent->data;
                $value = $obj->get($field);
                echo "<input type='hidden' name='$field' value='{$value}'/>";
           }
           
           $this->_endField($field);
      }

◆ renderScript()

DateTimeFieldRenderer::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 74 of file datetime_field_renderer.inc.

      {
           $script = "";
           
           if (!$this->_includedDateScript)
           {
                echo "<script src='{$this->parent->componentPath}/calendar/sonjara_calendar.js' type='text/javascript'></script>\n";
                echo "<link href='{$this->parent->componentPath}/calendar/sonjara_calendar.css' type='text/css' rel='stylesheet'>\n";
                $this->_includedDateScript = true;
           }
           
           $calendar = "{$field}_calendar";
           echo "<script type='text/javascript'>\n";
           echo "var $calendar = new Calendar('$calendar', '', '{$this->parent->id}_{$field}');\n";
           echo "</script>\n";
      }

◆ renderSearchField()

DateTimeFieldRenderer::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 154 of file datetime_field_renderer.inc.

      {
           if ($mode == "range")
           {
                $date_from = $this->parent->params->get($field, "from");
                $date_to = $this->parent->params->get($field, "to");
                echo "<tr>\n";
                $this->_printLabel($field);
                echo "<td>";
                echo "<input type='text' name='$field:from' value='$date_from' size='12'>&nbsp;<img src='{$this->parent->componentPath}/calendar/calendar.gif' alt='Popup Calendar' align='absmiddle' border='0' onclick='{$field}_calendar_from.toggle(this)'>";
                echo " to <input type='text' name='$field:to' value='$date_to' size='12'>&nbsp;<img src='{$this->parent->componentPath}/calendar/calendar.gif' alt='Popup Calendar' align='absmiddle' border='0' onclick='{$field}_calendar_to.toggle(this)'></td>\n";
                echo "</td>\n";
                echo "</tr>\n";     
           }
           else
           {
                $date = $this->parent->params->get($field, $mode);
                echo "<tr>\n";
                $this->_printLabel($field);
                echo "<td>";
                echo "<input type='text' name='$field:$mode' value='$date' size='12'>&nbsp;<img src='{$this->parent->componentPath}/calendar/calendar.gif' alt='Popup Calendar' align='absmiddle' border='0' onclick='{$field}_calendar_{$mode}.toggle(this)'></td>\n";
                echo "</td>\n";
                echo "</tr>\n";               
           }
      }

◆ renderSearchScript()

DateTimeFieldRenderer::renderSearchScript	(	$field,
		$mode
	)

FieldRenderers can override this method to provide any Javascript that the control requires when being used in a search form.

Parameters

string	$field	the field name
string	$mode	the search mode for the specific field ('equal', 'like', 'from', 'to', 'range')

Reimplemented from FieldRenderer.

Definition at line 124 of file datetime_field_renderer.inc.

      {
           $script = "";
           
           if (!$this->_includedDateScript)
           {
                echo "<script src='{$this->parent->componentPath}/calendar/sonjara_calendar.js' type='text/javascript'></script>\n";
                echo "<link href='{$this->parent->componentPath}/calendar/sonjara_calendar.css' type='text/css' rel='stylesheet'>\n";
                $this->_includedDateScript = true;
           }
           
           if ($mode == "range")
           {
                $calendar_from = "{$field}_calendar_from";
                $calendar_to = "{$field}_calendar_to";
                
                echo "<script type='text/javascript'>\n";
                echo "var $calendar_from = new Calendar('$calendar_from', '{$this->parent->id}', '$field:from');\n";
                echo "var $calendar_to = new Calendar('$calendar_to', '{$this->parent->id}', '$field:to');\n";
                echo "</script>\n";
           }
           else
           {
                $calendar = "{$field}_calendar_{$mode}";
                echo "<script type='text/javascript'>\n";
                echo "var $calendar = new Calendar('$calendar', '{$this->parent->id}', '$field:$mode');\n";
                echo "</script>\n";
           }
      }

Member Data Documentation

◆ $requireTime

DateTimeFieldRenderer::$requireTime = true

Definition at line 51 of file datetime_field_renderer.inc.

◆ $template

DateTimeFieldRenderer::$template = ""

Definition at line 52 of file datetime_field_renderer.inc.

◆ $validator

DateTimeFieldRenderer::$validator

Definition at line 50 of file datetime_field_renderer.inc.

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

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

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ addValidatorsToForm()

◆ DateTimeFieldRenderer()

◆ format()

◆ preProcess()

◆ renderField()

◆ renderReadOnly()

◆ renderScript()

◆ renderSearchField()

◆ renderSearchScript()

Member Data Documentation

◆ $requireTime

◆ $template

◆ $validator