Docs For Class DateRange

Description

DateRange display/data reflection class

A class to handle a simple date range from a form and reflect all other entered data

version: $Id$
license: GNU Public License
copyright: Copyright Stuart Prescott
author: Stuart Prescott

Located in /inc/bb/daterange.php (line 59)

nonDBRow
   |
   --DateRange

Variable Summary

boolean $includeSubmitButton

boolean $reflectData

Method Summary

DateRange DateRange ( $name, $longname, $description)

void display ([ $PD = NULL])

void getStart ()

void getStop ()

array setDefaults (integer $which, integer $range, [integer $basetime = 0])

array _calcRange (integer $which, integer $range, integer $basetime)

Variables

boolean $includeSubmitButton = 1 (line 63)

var: include a submit button in the output

boolean $reflectData = 1 (line 61)

var: include data in hidden fields if not shown

Inherited Variables

Inherited from nonDBRow

nonDBRow::$changed
nonDBRow::$DEBUG
nonDBRow::$description
nonDBRow::$dumpheader
nonDBRow::$editable
nonDBRow::$errorMessage
nonDBRow::$extrarows
nonDBRow::$fatal_sql
nonDBRow::$fields
nonDBRow::$headings
nonDBRow::$isValid
nonDBRow::$longname
nonDBRow::$name
nonDBRow::$namebase
nonDBRow::$newObject
nonDBRow::$suppressValidation

Methods

Constructor DateRange (line 65)

DateRange DateRange ( $name, $longname, $description)

$name
$longname
$description

display (line 208)

void display ([ $PD = NULL])

$PD

Redefinition of:

nonDBRow::display(): Display the object

getStart (line 222)

void getStart ()

getStop (line 226)

void getStop ()

setDefaults (line 182)

what default values should be in the boxes

this is calculated from the 'DR_*' data that we have above

return: (html javascript, forwards-backwards button html)

array setDefaults (integer $which, integer $range, integer $basetime)

integer $which: DR_NEXT, DR_CURRENT, DR_PREVIOUS
integer $range: DR_DAY, DR_WEEK, etc...
integer $basetime: what date is "current" date

_calcRange (line 88)

Calculate a sensible range

this is calculated from the 'DR_*' data that we have above

return: (SimpleDate startdate, SimpleDate stopdate)

array _calcRange (integer $which, integer $range, integer $basetime)

integer $which: DR_NEXT, DR_CURRENT, DR_PREVIOUS
integer $range: DR_DAY, DR_WEEK, etc...
integer $basetime: what date is "current" date

Inherited Methods

Inherited From nonDBRow

nonDBRow::nonDBRow()
nonDBRow::addElement()
nonDBRow::addElements()
nonDBRow::checkValid()
nonDBRow::display()
nonDBRow::displayInTable()
nonDBRow::log()
nonDBRow::text_dump()
nonDBRow::update()