DateFieldRenderer Class Reference

Field renderer for date data fields. More...

Inheritance diagram for DateFieldRenderer:

Collaboration diagram for DateFieldRenderer:

Public Member Functions
	DateFieldRenderer (&$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)
	renderDateRangeReadOnly ($field, $date_from, $date_to)
	format ($value)
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...
	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...
	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
	$onChange = ""
	optional javascript callback for 'change' event on date text field More...
	$onInput = ""
	optional javascript callback for 'input' event on date text field More...
	$template = ""
	template for date display in readonly mode - default reaonly format is short style 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

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

Member Function Documentation

addValidatorsToForm()

DateFieldRenderer::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 60 of file date_field_renderer.inc.

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

DateFieldRenderer()

DateFieldRenderer::DateFieldRenderer

(

&

$parent

)

Definition at line 55 of file date_field_renderer.inc.

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

format()

DateFieldRenderer::format

(

$value

)

Definition at line 195 of file date_field_renderer.inc.

     {
          return DateTypeRenderer::format($value, $this->template);
     }

renderDateRangeReadOnly()

DateFieldRenderer::renderDateRangeReadOnly	(		$field,
			$date_from,
			$date_to
	)

Definition at line 171 of file date_field_renderer.inc.

     {
          $label = $this->parent->layout->getLabel($field, $this);
          
          if($date_from && $date_to)
          {
               $toLabel = (preg_match("/Between/i", $label)) ? "and" : "to";
          }
          else if($date_from && !$date_to)
          {
               $this->label = preg_replace("/Between/i", "From", $label);
          }
          else // date to and no date_from
          {
               $this->label = preg_replace("/(Between)|(From)/i", "Up To", $label);       
          }
          echo "<tr>\n";
          $this->_printLabel($field);
          echo "<td";
          if ($this->parent->valueCSS) echo " class='{$this->parent->valueCSS}'";
          echo ">".$this->format($date_from). "&nbsp;<label for='date_to'>$toLabel</label>&nbsp;" . $this->format($date_to) ."</td>\n";
          echo "</tr>\n";          
     }

renderField()

DateFieldRenderer::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 90 of file date_field_renderer.inc.

     {
          $obj = $this->parent->data;
          if ($obj instanceof CompositeDataItem)
          {
               $obj = $obj->findSubObject($field);
          }
          $date = $obj->format("{{$field}:m/d/Y}");
          
          $onchange = ($this->onChange) ? "onchange='$this->onChange(this)'" : "";
          $oninput  = ($this->onInput) ? "oninput='$this->onInput(this)'" : "";
          
          $this->_startField($field);
          echo "<input id='{$this->parent->id}_{$field}' type='text' name='$field' value='$date' $onchange $oninput style='width: auto' class='date' size='12'>&nbsp;<img src='{$this->parent->componentPath}/calendar/calendar.gif' alt='Popup Calendar' align='absmiddle' border='0' onclick='{$this->parent->id}_{$field}_calendar.toggle(this)'>\n";
          $this->_endField($field);
     }

renderReadOnly()

DateFieldRenderer::renderReadOnly

(

$field

)

Definition at line 162 of file date_field_renderer.inc.

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

renderScript()

DateFieldRenderer::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 73 of file date_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 = "{$this->parent->id}_{$field}_calendar";
          echo "<script type='text/javascript'>\n";
          echo "var $calendar = new Calendar('$calendar', '', '{$this->parent->id}_{$field}');\n";
          echo "</script>\n";
     }

renderSearchField()

DateFieldRenderer::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 137 of file date_field_renderer.inc.

     {
          $this->_startField($field);
          
          if ($mode == "range")
          {
               $label = $this->parent->layout->getLabel($field, $this);
               $toLabel = (preg_match("/Between/i", $label)) ? "and" : "to";
               
               $date_from = $this->parent->params->get($field, "from");
               $date_to = $this->parent->params->get($field, "to");
               echo "<input type='text' name='$field:from' value='$date_from' class='date' 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 "&nbsp;<label for='date_to'>$toLabel</label>&nbsp;";
               echo "<input type='text' name='$field:to' value='$date_to' class='date' size='12'>&nbsp;<img src='{$this->parent->componentPath}/calendar/calendar.gif' alt='Popup Calendar' align='absmiddle' border='0' onclick='{$field}_calendar_to.toggle(this)'>\n";
          }
          else
          {
               $date = $this->parent->params->get($field, $mode);
 
               echo "<input type='text' name='$field:$mode' value='$date' class='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)'>\n";
          }
          
          $this->_endField($field);
     }

renderSearchScript()

DateFieldRenderer::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 107 of file date_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

$onChange

DateFieldRenderer::$onChange = ""

optional javascript callback for 'change' event on date text field

Definition at line 51 of file date_field_renderer.inc.

$onInput

DateFieldRenderer::$onInput = ""

optional javascript callback for 'input' event on date text field

Definition at line 52 of file date_field_renderer.inc.

$template

DateFieldRenderer::$template = ""

template for date display in readonly mode - default reaonly format is short style

Definition at line 53 of file date_field_renderer.inc.

$validator

DateFieldRenderer::$validator

Definition at line 50 of file date_field_renderer.inc.

---

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

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