Docs For Class DateField

Description

textfield form widget designed to contain dates

Located in /inc/formslib/datefield.php (line 28)

Field
   |
   --DateField

Variable Summary

SimpleDate $date

boolean $editableOutput

Method Summary

DateField DateField (string $name, [string $longname = ""], [string $description = ""])

void displayInTable ([ $cols = 3])

string getdisplay ()

void hidden ()

boolean isValid ()

string selectable ()

void setDate ( $date, SimpleDate $time)

boolean update (array $data)

Variables

SimpleDate $date (line 30)

var: date value

boolean $editableOutput = 1 (line 32)

var: date can be changed

Inherited Variables

Inherited from Field

Field::$attr
Field::$changed
Field::$DEBUG
Field::$defaultValue
Field::$description
Field::$duplicateName
Field::$editable
Field::$errorclass
Field::$hidden
Field::$isValid
Field::$isValidTest
Field::$longname
Field::$name
Field::$namebase
Field::$notifyIdChange
Field::$oob_errorMessage
Field::$oob_status
Field::$ovalue
Field::$required
Field::$requiredTwoStage
Field::$sqlHidden
Field::$suppressValidation
Field::$useNullValues
Field::$value
Field::$valueCleaner

Methods

Constructor DateField (line 41)

Create a new datefield object

DateField DateField (string $name, [string $longname = ""], [string $description = ""])

string $name: the name of the field (db name, and html field name
string $longname: long name to be used in the label of the field in display
string $description: used in the html title or longdesc for the field

displayInTable (line 47)

void displayInTable ([ $cols = 3])

$cols

Redefinition of:

Field::displayInTable(): render this form widget in an html table

getdisplay (line 66)

Generate the complete html representation of the field

return: html presentation

string getdisplay ()

hidden (line 97)

void hidden ()

Redefinition of:

Field::hidden(): html representation of this field as a "hidden" form widget

isValid (line 132)

isValid test (extend Field::isValid), looking at whether the string parsed OK

return: data is valid

boolean isValid ()

Redefinition of:

Field::isValid(): Check the validity of the current data value.

selectable (line 88)

Generate the html representation of the field in a textfield

return: html presentation

string selectable ()

Redefinition of:

Field::selectable(): return an html representation of the widget

setDate (line 108)

Set the date (and value)

void setDate ( $date, SimpleDate $time)

SimpleDate $time
$date

update (line 121)

overload the parent's update method so that local calculations can be performed

return: the value was updated

boolean update (array $data)

array $data: html_name => value pairs

Redefinition of:

Field::update(): update the value of the object with the user-supplied data in $data

Inherited Methods

Inherited From Field

Field::Field()
Field::display()
Field::displayInTable()
Field::getValue()
Field::hidden()
Field::isValid()
Field::log()
Field::selectable()
Field::selectedValue()
Field::set()
Field::setattr()
Field::setEditable()
Field::setNamebase()
Field::sqlSetStr()
Field::text_dump()
Field::update()
Field::__clone()