Class PhpiCalLib_DataTypes_Time

Description
Description | Vars | Methods (details)

The time data type.

Located in /datatypes.php (line 801) 

PhpiCalLib_DataType
   |
   --PhpiCalLib_DataTypes_Time
Method Summary
Description | Vars | Methods (details)
PhpiCalLib_DataTypes_Time __construct ()
void FromTimeStamp (integer $TimeStamp, bool $Utc)
integer GetHours ()
integer GetMinutes ()
integer GetSeconds ()
bool GetUtc ()
void Parse (string $EncodedString)
void SetHours (number $Number)
void SetMinutes (number $Number)
void SetSeconds (number $Number)
void SetUtc (bool $value)
string ToString ()
integer ToTimeStamp ()
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from PhpiCalLib_DataType

PhpiCalLib_DataType::$DataType
 PhpiCalLib_DataType::$IanaTokenRegex
 PhpiCalLib_DataType::$TypeMap
Methods
Description | Vars Methods (details)
Constructor __construct (line 814)

Constructor

  • access: public
PhpiCalLib_DataTypes_Time __construct ()
FromTimeStamp (line 902)

Extract the date from the given timestamp

  • access: public
void FromTimeStamp (integer $TimeStamp, bool $Utc)
  • integer $TimeStamp: Unix epoch WRT to UTC
  • bool $Utc: true to extract the date WRT to utc, false to extract the "local time"
GetHours (line 874)

Access the number of hours

  • access: public
integer GetHours ()
GetMinutes (line 854)

Access the number of minutes

  • access: public
integer GetMinutes ()
GetSeconds (line 834)

Access the number of seconds

  • access: public
integer GetSeconds ()
GetUtc (line 892)

Determine if the time is UTC or floating/local

  • access: public
bool GetUtc ()
Parse (line 926)

Extract the date-time value from the encoded string

  • access: public
void Parse (string $EncodedString)
  • string $EncodedString
SetHours (line 863)

Set the time-hour component of the time

  • access: public
void SetHours (number $Number)
  • number $Number
SetMinutes (line 843)

Set the time-minute component of the time

  • access: public
void SetMinutes (number $Number)
  • number $Number
SetSeconds (line 823)

Set the time-second component of the time

  • access: public
void SetSeconds (number $Number)
  • number $Number
SetUtc (line 883)

Set the time-utc component of the time

  • access: public
void SetUtc (bool $value)
  • bool $value: True for Utc, else false
ToString (line 948)

Convert to string

  • access: public
string ToString ()
ToTimeStamp (line 916)

Return the seconds from midnight on the same day

  • return: Seconds since January 1 1970 00:00:00 GMT
  • access: public
integer ToTimeStamp ()

Inherited Methods

Inherited From PhpiCalLib_DataType

PhpiCalLib_DataType::FromDataType()
PhpiCalLib_DataType::ToDataType()

Documentation generated on Tue, 01 Apr 2008 00:20:11 +0100 by phpDocumentor 1.4.0