Adds a Date Range Filter with start and end dates and Next and Previous buttons to a FilterForm. More...

Inheritance diagram for FilterFieldRenderer\DateRangeFilterRenderer:

Collaboration diagram for FilterFieldRenderer\DateRangeFilterRenderer:

Public Member Functions
	__construct ($parent, $field, $endDateField="", $stepMode="month", $fiscal_year_start=1, $startParam=null, $endParam=null)

	calculateDateRange ()

	setStepModeMonth ()

	setStepModeYear ($startMonth=1)

	getConstraint ()

	setHandler ($handler)

	renderSearchScript ($field)

	renderSearchField ($field)
	If the user hides the startParm field, then don't display the calendar picker and input fields for dates. More...

	writeDateHiddenFields ()

	writeFilter ()

	writeButtons ()

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

	addValidatorsToForm ($field, $required=false)
	This method is called by the AutoForm to add any default input validators that are required by the FieldRenderer. 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...

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

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

Static Public Member Functions
static	convertMonthStringToNumber ($month)

Public Attributes
	$startParam = "startDate"

	$endParam = "endDate"

	$stepMode

	$fiscal_year_start = 1

	$startDate

	$endDate

	$field

	$endDateField

	$stepLabel

	$dateRangeLabel = "Reporting Period"

	$subTitle

	$handler

	$cssClass = "date_range"

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

Adds a Date Range Filter with start and end dates and Next and Previous buttons to a FilterForm.

Usage: first create the instance of FilterForm, including in the DataItem object filter any other fields that you want to filter on (e.g., status drop down)

 $filterForm = new FilterForm($obj);

Then add the date range renderer to the form:

$dateRangeRenderer = new DateRangeFilterRenderer($filterForm, "start_date_field", "end_date_field", "month");

Parameters

-	filterForm - instand of class FilterForm
-	start_date_field - the field in the DataItem obj sent to the FilterForm that is the date to be queried on (e.g., order_date)
-	end_date_field - the field in the DataItem obj sent to the FilterForm that is the end date to be queried on. If the query involves just one field, send the same field name for both. Example where field names are different: program_start_date and program_end_date
-	stepMode - the increment for the Next and Previous buttons. Default is "month", can be "year" or "fiscal_year"
-	fiscal_year_start - the numeric starting month of the fiscal_year, if the step mode is fiscal_year. May be stored in Settings - varies among web sites so is not queried directly here.

Retrieve the date range constraint through FilterForm instance $constraint = $filterForm->getConstraint();

To show only the Prev/Next buttons and not the start/end date input fields, hide the startDate field

$filterForm->hide("startDate");

Author: : Andy Green

Definition at line 898 of file filter_form.inc.

Constructor & Destructor Documentation

◆ __construct()

FilterFieldRenderer\DateRangeFilterRenderer::__construct	(	$parent,
		$field,
		$endDateField = `""`,
		$stepMode = `"month"`,
		$fiscal_year_start = `1`,
		$startParam = `null`,
		$endParam = `null`
	)

Definition at line 920 of file filter_form.inc.

      {
           $this->stepMode = $stepMode;
           $this->field = $field;
  
           $this->endDateField = (!$endDateField) ? $field : $endDateField;
           $this->fiscal_year_start = $fiscal_year_start;
           
           if ($startParam) $this->startParam = $startParam;
           if ($endParam) $this->endParam = $endParam;
           
           $this->calculateDateRange();
           
           $this->label = "";
           if ($parent->data->hasField($field))
           {
                $parent->override($field, $label, $this);
           }
           else
           {
                $parent->add($this, $field);
           }         
           $this->FieldRenderer($parent);
           
           // Needs to have a value so that it is included in the constraint
           $parent->setParam($this->startParam, "to", $this->to);
           // override default search constraint generation
           $parent->setHandler($this->startParam, array($this, getConstraint));
      }

Member Function Documentation

◆ calculateDateRange()

FilterFieldRenderer\DateRangeFilterRenderer::calculateDateRange ( )

Definition at line 950 of file filter_form.inc.

      {
           $this->startDate = $_REQUEST[$this->startParam];
           $this->endDate   = $_REQUEST[$this->endParam];
           
           if ($this->startDate || $this->endDate)
           {
                $validator = new DateValidator($this->startParam, "From");
                $validator->required = false;
                $this->msg = $validator->validate();
                
                if ($this->msg) 
                {
                     $startDate = null;
                }
                
                $validator = new DateValidator($this->endParam, "To");
                $validator->required = false;
                
                $this->msg = $validator->validate();
           
                if ($this->msg)
                {
                     $endDate = null;
                }
           
                if ($this->startDate) $this->startDate = new DateTime($this->startDate);
                if ($this->endDate) $this->endDate = new DateTime($this->endDate);
                
                if ($this->startDate && $this->endDate) 
                {
                     $this->subTitle = $this->startDate->format("jS F Y")." to ".$this->endDate->format("jS F Y");
                }
           
                // JDG 2/12 - remove "inclusive of last day"
      
                // JDG 11/2011 - Need to set this for stepping with Prev Next
                $this->month = $this->startDate->format("m");
                $this->year = $this->startDate->format("Y");
           }
      
           $this->month = checkNumeric($_REQUEST['month']);
           $this->year = checkNumeric($_REQUEST['year']);
  
           if (!$this->year) $this->year = date("Y");
  
           // JDG 11/2011 - need to set step mode whether we have a 
           // custom start/end date or not
           if ($this->stepMode == "year")
           {
                // calendar year stepping mode
                $this->setStepModeYear();
           }
           /*
            * If today's month for this year is less than
            * the fiscal year month, then show last year's
            * data
            */
           elseif($this->stepMode == "fiscal_year")
           {
                if(!checkNumeric($_REQUEST['year']) && $this->fiscal_year_start > date("n"))
                     $this->year--;
                $this->setStepModeYear($this->fiscal_year_start);
           }
           else
           {
                // Monthly stepping mode
                $this->setStepModeMonth();
           }
  
           $this->from = $this->startDate->format("Y-m-d");
           $this->to = $this->endDate->format("Y-m-d");
           $this->calculated = true;
      }

◆ convertMonthStringToNumber()

static FilterFieldRenderer\DateRangeFilterRenderer::convertMonthStringToNumber ( $month )

static

Definition at line 1029 of file filter_form.inc.

      {
           for($i=1;$i<=12;$i++)
           {
                if(date("F", mktime(0, 0, 0, $i, 1, 0)) == $month)
                {
                     $month_number = $i;
                     break;
                }
           }
           return $month_number;
      }

◆ getConstraint()

FilterFieldRenderer\DateRangeFilterRenderer::getConstraint ( )

Definition at line 1107 of file filter_form.inc.

      {
           if(is_array($this->handler) && method_exists($this->handler[0], $this->handler[1]))
           {
                return call_user_func($this->handler, $this);
           }
           
           //AJG: Cope with date rounding
           $to = $this->to . " 23:59:59.999";
           
           if($this->field == $this->endDateField)
           {
                $name = $this->field;
                $constraint = "$name BETWEEN '{$this->from}' AND '{$to}'";
           }
           else
           {
                $constraint = "{$this->endDateField} <= '{$to}' AND {$this->field} >= '{$this->from}' ";
           }
      
           return $constraint;
      }

◆ renderSearchField()

FilterFieldRenderer\DateRangeFilterRenderer::renderSearchField ( $field )

If the user hides the startParm field, then don't display the calendar picker and input fields for dates.

If we don't display the input fields for start and end dates, then write them as hidden fields so the values are in $_GET.

Definition at line 1161 of file filter_form.inc.

      {
  
           $this->_startField($field);
           
           if (!array_key_exists($this->startParam, $this->parent->hidden)) 
           {
                $this->writeFilter();
           }
           else
           {
                $this->writeDateHiddenFields();
           }
           
           $this->writeButtons();
           
           $this->_endField($field);
      }

◆ renderSearchScript()

FilterFieldRenderer\DateRangeFilterRenderer::renderSearchScript ( $field )

Definition at line 1135 of file filter_form.inc.

      {
           if (array_key_exists($field, $this->parent->hidden)) return "";
           
           $script .= <<<ENDSCRIPT
  
 <script src='/fakoli/calendar/sonjara_calendar.js' type='text/javascript'></script>
 <link href='/fakoli/calendar/sonjara_calendar.css' type='text/css' rel='stylesheet'></link>
 <script type="text/javascript">
 var startDateCalendar = new Calendar('startDateCalendar', '{$this->parent->id}', '{$this->startParam}');
 var endDateCalendar = new Calendar('endDateCalendar', '{$this->parent->id}', '{$this->endParam}');
 </script>
  
 ENDSCRIPT;
           
           echo $script;
      }

◆ setHandler()

FilterFieldRenderer\DateRangeFilterRenderer::setHandler ( $handler )

Definition at line 1130 of file filter_form.inc.

      {
           $this->handler = $handler;
      }

◆ setStepModeMonth()

FilterFieldRenderer\DateRangeFilterRenderer::setStepModeMonth ( )

Definition at line 1042 of file filter_form.inc.

      {
           if (!$this->month)
           {
                $this->year = date("Y");
                $this->month = date("m");
           }
                     
           $this->prevMonth = $this->month - 1;
           $this->prevYear = $this->year;
           if ($this->prevMonth == 0)
           {
                $this->prevYear--;
                $this->prevMonth = 12;
           }
                     
           $this->nextMonth = $this->month + 1;
           $this->nextYear = $this->year;
           if ($this->nextMonth > 12)
           {
                $this->nextMonth = 1;
                $this->nextYear++;
           }
                     
           if(!$this->startDate)
                $this->startDate = new DateTime("{$this->year}-{$this->month}-01T00:00:00");
                
           if(!$this->endDate)
           {
                $this->endDate = clone $this->startDate;
                $this->endDate->modify("+1 months");
                // JDG 2/12 - show last day of month 
                $this->endDate->modify("-1 days");
           }
  
           if(!$this->subTitle)
           {
                $this->subTitle = $this->startDate->format("F Y");     
           }
      }

◆ setStepModeYear()

FilterFieldRenderer\DateRangeFilterRenderer::setStepModeYear ( $startMonth = 1 )

Definition at line 1083 of file filter_form.inc.

      {
           $this->month = $startMonth;
                     
           $this->prevMonth = $startMonth;
           $this->prevYear = $this->year - 1;
                     
           $this->nextMonth = $startMonth;
           $this->nextYear = $this->year + 1;
           $this->subTitle=  $this->year;
           
           if(!$this->startDate)
           {
                $this->startDate = new DateTime("{$this->year}-{$this->month}-01T00:00:00");
           }    
           
           if(!$this->endDate)
           {
                $this->endDate = clone $this->startDate;
                $this->endDate->modify("+1 years");
                $this->endDate->modify("-1 days");
           }         
      }

◆ writeButtons()

FilterFieldRenderer\DateRangeFilterRenderer::writeButtons ( )

Definition at line 1215 of file filter_form.inc.

      {
           if ($this->stepMode == "none") return;
           
           if (!$this->calculated) $this->calculateDateRange();
           
           $queryString = "?".$_SERVER["QUERY_STRING"];
           
           $queryString = preg_replace("/identifier=\\w+\\&?/", "", $queryString);
           $queryString = preg_replace("/year=\\d+\\&?/", "", $queryString);
           $queryString = preg_replace("/month=\\d+\\&?/", "", $queryString);
           $queryString = preg_replace("/startDate=\\d+\\&?/", "", $queryString);
           $queryString = preg_replace("/endDate=\\d+\\&?/", "", $queryString);
           
           $prevLink = appendToQueryString($queryString, "year=$this->prevYear&month=$this->prevMonth");
           $nextLink = appendToQueryString($queryString, "year=$this->nextYear&month=$this->nextMonth");
           
           $stepLabel = ($this->stepLabel) ? $this->stepLabel : prettify($this->stepMode);
 ?>
 <div class="<?php echo $this->cssClass ?>">
 <div style="float: right; z-index:2; padding-bottom: 10px;">
 <input type="button" class="button" value="  Next <?echo $stepLabel ?> &raquo;  " onclick="go('<?echo $nextLink?>');">
 </div>
 <input type="button" class="button" value="  &laquo; Previous <?echo $stepLabel ?>   " onclick="go('<?echo $prevLink?>');">
 </div>
 <?
      }

◆ writeDateHiddenFields()

FilterFieldRenderer\DateRangeFilterRenderer::writeDateHiddenFields ( )

Definition at line 1180 of file filter_form.inc.

      {
           if(!$_REQUEST["month"] || !$_REQUEST["year"])
           {
           ?>
           <input type="hidden" name="<?php echo $this->startParam ?>" value="<?echo $this->startDate->format("m/d/Y")?>">
           <input type="hidden" name="<?php echo $this->endParam ?>" value="<?echo $this->endDate->format("m/d/Y")?>">
           <?php
           }
           else
           {
           ?>
           <input type="hidden" name="year" value="<? echo $this->year ?>">
           <input type="hidden" name="month" value="<? echo $this->month ?>">
           <?php     
           }
      }

◆ writeFilter()

FilterFieldRenderer\DateRangeFilterRenderer::writeFilter ( )

Definition at line 1198 of file filter_form.inc.

      {
           if (!$this->calculated) $this->calculateDateRange();
           $endDate = clone $this->endDate;
  
 ?>
 <div style="clear: both; float: left; padding-bottom: 4px">
  <label><?php echo $this->dateRangeLabel ?> From: </label>
  <input type="text" size="10" name="<?php echo $this->startParam ?>" value="<?echo $this->startDate->format("m/d/Y")?>">&nbsp;
  <img src='/fakoli/calendar/calendar.gif' alt='Popup Calendar' style='vertical-align: middle; border:0' onclick='startDateCalendar.toggle(this)'/>
  <label> To: </label><input type="text" size="10" name="<?php echo $this->endParam ?>" value="<?echo $endDate->format("m/d/Y")?>">&nbsp;
  <img src='/fakoli/calendar/calendar.gif' alt='Popup Calendar' style='vertical-align: middle; border:0' onclick='endDateCalendar.toggle(this)'/>
  &nbsp;<input type="submit" class="button" value=" Update View "/>
  </div>
 <?
      }

Member Data Documentation

◆ $cssClass

FilterFieldRenderer\DateRangeFilterRenderer::$cssClass = "date_range"

Definition at line 918 of file filter_form.inc.

◆ $dateRangeLabel

FilterFieldRenderer\DateRangeFilterRenderer::$dateRangeLabel = "Reporting Period"

Definition at line 914 of file filter_form.inc.

◆ $endDate

FilterFieldRenderer\DateRangeFilterRenderer::$endDate

Definition at line 906 of file filter_form.inc.

◆ $endDateField

FilterFieldRenderer\DateRangeFilterRenderer::$endDateField

Definition at line 911 of file filter_form.inc.

◆ $endParam

FilterFieldRenderer\DateRangeFilterRenderer::$endParam = "endDate"

Definition at line 901 of file filter_form.inc.

◆ $field

FilterFieldRenderer\DateRangeFilterRenderer::$field

Definition at line 910 of file filter_form.inc.

◆ $fiscal_year_start

FilterFieldRenderer\DateRangeFilterRenderer::$fiscal_year_start = 1

Definition at line 903 of file filter_form.inc.

◆ $handler

FilterFieldRenderer\DateRangeFilterRenderer::$handler

Definition at line 917 of file filter_form.inc.

◆ $startDate

FilterFieldRenderer\DateRangeFilterRenderer::$startDate

Definition at line 905 of file filter_form.inc.

◆ $startParam

FilterFieldRenderer\DateRangeFilterRenderer::$startParam = "startDate"

Definition at line 900 of file filter_form.inc.

◆ $stepLabel

FilterFieldRenderer\DateRangeFilterRenderer::$stepLabel

Definition at line 913 of file filter_form.inc.

◆ $stepMode

FilterFieldRenderer\DateRangeFilterRenderer::$stepMode

Definition at line 902 of file filter_form.inc.

◆ $subTitle

FilterFieldRenderer\DateRangeFilterRenderer::$subTitle

Definition at line 915 of file filter_form.inc.

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

C:/code/cms.sonjara.com/framework/filter_form.inc

Public Member Functions

Static Public Member Functions

Public Attributes