DateOfBirthFieldRenderer Class Reference

Field renderer for date of birth data fields. More...

Inheritance diagram for DateOfBirthFieldRenderer:

Collaboration diagram for DateOfBirthFieldRenderer:

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...
	setMinimumAge ($min, $message="")
	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)
	format ($value)
	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...
	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
	$template = ""
	$minimumAge = 0
	$minimumAgeMessage = ""
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 of birth data fields.

Renders with date format validation and separate dropdowns for month, day and year.

Definition at line 44 of file date_of_birth_field_renderer.inc.

Member Function Documentation

addValidatorsToForm()

DateOfBirthFieldRenderer::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 55 of file date_of_birth_field_renderer.inc.

     {
          $label = isset($this->label) ? $this->label : $this->parent->prettifyFieldName($field);
 
          if($required)
          {
               $this->parent->validator->add(new RequiredValidator("{$field}_mm", "$label Month"));
               $this->parent->validator->add(new RequiredValidator("{$field}_dd", "$label Day"));
               $this->parent->validator->add(new RequiredValidator("{$field}_yy", "$label Year"));
          }
 
          if ($this->minimumAge)
          {
               $this->parent->validator->add(new MinimumAgeValidator($field, $label, $this->minimumAge, $this->minimumAgeMessage));
          }
     }

DateFieldRenderer()

DateOfBirthFieldRenderer::DateFieldRenderer

(

&

$parent

)

Definition at line 50 of file date_of_birth_field_renderer.inc.

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

format()

DateOfBirthFieldRenderer::format

(

$value

)

Definition at line 147 of file date_of_birth_field_renderer.inc.

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

preProcess()

DateOfBirthFieldRenderer::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 152 of file date_of_birth_field_renderer.inc.

     {
          trace("Preprocessing data of birth", 3);
     
          $mm = checkNumeric($_POST["{$field}_mm"]);
          $dd = checkNumeric($_POST["{$field}_dd"]);
          $yy = checkNumeric($_POST["{$field}_yy"]);
 
          if ($mm < 10) $mm = "0{$mm}";
          if ($dd < 10) $dd = "0{$dd}";
          
          $dob = "$yy-$mm-$dd";
          
          trace("** Preprocessing date of birth: $dob", 3);
          
          $this->parent->data->set($field, $dob);
     }

renderField()

DateOfBirthFieldRenderer::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 83 of file date_of_birth_field_renderer.inc.

     {
          $obj = $this->parent->data;
          if ($obj instanceof CompositeDataItem)
          {
               $obj = $obj->findSubObject($field);
          }
          
          $month = intval($obj->format("{{$field}:n}"));
          $day = intval($obj->format("{{$field}:j}"));
          $year = intval($obj->format("{{$field}:Y}"));
          
          trace("** Month: $month, Day: $day, Year: $year, Field: {$obj->$field}", 3);
          
          $this->_startField($field);
          $default = !$month ? " selected" : "";
          
          echo "<select id='{$this->parent->id}_{$field}_mm' type='text' name='{$field}_mm'><option value='' disabled {$default}>Month</option>";
          
          for($i = 1; $i <= 12; ++$i)
          {
               $mm = new DateTime("{$i}/1/1971");
               $monthName = $mm->format("M");
               option($i, $monthName, $month);
          }    
          
          $default = !$day ? " selected" : "";
          echo "</select> / <select id='{$this->parent->id}_{$field}_dd' type='text' name='{$field}_dd'><option value='' disabled {$default}>Day</option>";
          
          for($i = 1; $i < 32; ++$i)
          {
               option($i, $i, $day);
          }
          
          $default = !$year ? " selected" : "";
          echo "</select> / <select id='{$this->parent->id}_{$field}_yy' type='text' name='{$field}_yy'><option value='' disabled {$default}>Year</option>";
          
          for($i = date('Y'); $i >= 1900; --$i)
          {
               option($i, $i, $year);
          }
          
          echo "</select>";
          
          $this->_endField($field);
     }

renderReadOnly()

DateOfBirthFieldRenderer::renderReadOnly

(

$field

)

Definition at line 138 of file date_of_birth_field_renderer.inc.

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

renderScript()

DateOfBirthFieldRenderer::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 79 of file date_of_birth_field_renderer.inc.

     {
     }

renderSearchField()

DateOfBirthFieldRenderer::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 134 of file date_of_birth_field_renderer.inc.

     {
     }

renderSearchScript()

DateOfBirthFieldRenderer::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 130 of file date_of_birth_field_renderer.inc.

     {
     }

setMinimumAge()

DateOfBirthFieldRenderer::setMinimumAge	(		$min,
			$message = ""
	)

Definition at line 72 of file date_of_birth_field_renderer.inc.

     {
          $this->minimumAge = $min;
          $this->minimumAgeMessage = $message ? $message : "You must be at least {$min} years of age";
          return $this;
     }

Member Data Documentation

$minimumAge

DateOfBirthFieldRenderer::$minimumAge = 0

Definition at line 47 of file date_of_birth_field_renderer.inc.

$minimumAgeMessage

DateOfBirthFieldRenderer::$minimumAgeMessage = ""

Definition at line 48 of file date_of_birth_field_renderer.inc.

$template

DateOfBirthFieldRenderer::$template = ""

Definition at line 46 of file date_of_birth_field_renderer.inc.

---

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

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