Class: DateField

Source Location: /_includes/lib_forms.php

Class Overview

Field
   |
   --DateField

Describes a field (or rather group of fields) that allows the user to select a specific date by selecting year, month and day.

Author(s):

Andreas Launila

Child classes:

TimeField: Describes a field (or rather a group of fields) that allows the user to select a certain timestamp (year, month, day, hour, minute and second).

Inherited Variables

Class: Field

Field::$attributes
Field::$hasUserValue
Field::$id
Field::$name
Field::$required
Field::$value

Inherited Methods

Class: Field

Field::__construct(): Constructor for Field.
Field::clear(): Clears the field, making it so that it appears to never have received a value.
Field::formatAddition(): Formats any additional data that should be appended to the field. Any '%id' entities in the formatted string are replaced with the field's id. Any '%name' entities in the formatted string are replaced with the field's name.
Field::getAsHtml(): Returns the (X)HTML representation of the field. This function should be concidered as an abstract function, any subclasses should override this.
Field::getAttributes(): Gets the (X)HTML information containing all base information.
Field::getError()
Field::getId(): Gets the field's id.
Field::getName(): Gets the name of the field.
Field::getValue(): Gets the value of the field.
Field::hasUserValue(): Checks if the field has a non empty value that has been supplied by a user.
Field::hasValue(): Checks if the field has a non empty value.
Field::isValid()
Field::setAttribute(): Sets one of the firleds attributes. If the attribute does not exist then it is created. The attributes 'id', 'name' and 'value' can not be modified throught this function.
Field::setId(): Sets the field's id.
Field::setValue(): Sets the value of the field.

Class Details

[line 650]
Describes a field (or rather group of fields) that allows the user to select a specific date by selecting year, month and day.

Tags:

author:

Andreas Launila

[ Top ]

Class Variables

$day =

[line 665]

The date selection field.

Tags:

access:

protected

Type:

TextField

[ Top ]

$initialValue =

[line 685]

The initial value (unix timestamp) that should be used for the field.

$var integer

Tags:

access:

private

Type:

mixed

[ Top ]

$legend =

[line 680]

The value that should be displayed as legend for the fieldset.

Tags:

access:

protected

Type:

string

[ Top ]

$month =

[line 660]

The month selection field.

Tags:

access:

protected

Type:

Select

[ Top ]

$timeMax =

[line 675]

The highest unix timestamp that the user should allow to select.

Tags:

access:

protected

Type:

integer

[ Top ]

$timeMin =

[line 670]

The lowest unix timestamp that the user should allow to select.

Tags:

access:

protected

Type:

integer

[ Top ]

$year =

[line 655]

The year selection field.

Tags:

access:

protected

Type:

Select

[ Top ]

Class Methods

constructor __construct [line 700]

DateField __construct(
string
$name, string
$displayName, [integer
$timeMin = 0], [integer
$timeMax = 2000000000], [integer
$initialValue = 0])

Constructor for DateField.

Parameters:

string	$name	The name identifier of the date field.
string	$displayName	The name that should be displayed to the user.
integer	$timeMin	The lowest unix timestamp that the date field should allow the user to select.
integer	$timeMax	The highest unix timestamp that the date field should allow the user to select.
integer	$initialValue	The unix timestamp that should be displayed initially.

[ Top ]

method formatAddition [line 837]

void formatAddition(
mixed
$addition)

No additions are allowed.

Tags:

access:	public
see:	Field.formatAddition()

Overrides Field::formatAddition() (Formats any additional data that should be appended to the field. Any '%id' entities in the formatted string are replaced with the field's id. Any '%name' entities in the formatted string are replaced with the field's name.)

[ Top ]

method getAsHTML [line 802]

void getAsHTML(
)

Tags:

access:	public
see:	Field.getAsHtml()

Overridden in child classes as:

TimeField::getAsHTML()

[ Top ]

method getValue [line 771]

void getValue(
)

Tags:

access:	public
see:	Field.getValue()

Overridden in child classes as:

TimeField::getValue()

Overrides Field::getValue() (Gets the value of the field.)

[ Top ]

method hasUserValue [line 828]

void hasUserValue(
)

Tags:

access:	public
see:	Field.hasUserValue()

Overridden in child classes as:

TimeField::hasUserValue()

Overrides Field::hasUserValue() (Checks if the field has a non empty value that has been supplied by a user.)

[ Top ]

method hasValue [line 821]

void hasValue(
)

Tags:

access:	public
see:	Field.hasValue()

Overrides Field::hasValue() (Checks if the field has a non empty value.)

[ Top ]

method setValue [line 793]

void setValue(
mixed
$newValue)

Tags:

access:	public
see:	Field.setValue(mixed)

Overridden in child classes as:

TimeField::setValue()

Overrides Field::setValue() (Sets the value of the field.)

[ Top ]

Documentation generated on Sun, 16 Apr 2006 21:03:27 +0200 by phpDocumentor 1.3.0RC4