Class: TimeField

Source Location: /_includes/lib_forms.php

Class Overview

Field
   |
   --DateField
      |
      --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).

Author(s):

Andreas Launila

Variables

Methods

Inherited Variables

Class: DateField

DateField::$day
DateField::$initialValue
DateField::$legend
DateField::$month
DateField::$timeMax
DateField::$timeMin
DateField::$year

Class: Field

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

Inherited Methods

Class: DateField

DateField::__construct(): Constructor for DateField.
DateField::formatAddition(): No additions are allowed.
DateField::getAsHTML()
DateField::getValue()
DateField::hasUserValue()
DateField::hasValue()
DateField::setValue()

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 848]
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).

Tags:

author:

Andreas Launila

[ Top ]

Class Variables

$hour =

[line 853]

The hour selection field.

Tags:

access:

private

Type:

TextField

[ Top ]

$minute =

[line 858]

The minute selection field.

Tags:

access:

private

Type:

TextField

[ Top ]

$second =

[line 863]

The second selection field.

Tags:

access:

private

Type:

TextField

[ Top ]

Class Methods

constructor __construct [line 877]

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

Constructor for TimeField.

Tags:

access:

public

Overrides DateField::__construct() (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 getAsHTML [line 947]

void getAsHTML(
)

Tags:

access:	public
see:	Field.getAsHtml()

Overrides DateField::getAsHTML() (parent method not documented)

[ Top ]

method getValue [line 912]

void getValue(
)

Tags:

access:	public
see:	Field.getValue()

Overrides DateField::getValue() (parent method not documented)

[ Top ]

method hasUserValue [line 904]

void hasUserValue(
)

Tags:

access:	public
see:	Field.hasUserValue()

Overrides DateField::hasUserValue() (parent method not documented)

[ Top ]

method setValue [line 937]

void setValue(
mixed
$newValue)

Tags:

access:	public
see:	Field.setValue()

Overrides DateField::setValue() (parent method not documented)

[ Top ]

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