Class PhpiCalLib_Properties_DateOrDateTimeProperty

Description
Description | Descendents | Vars | Methods (details)

Many properties specify a value of type date-time / date. This base class can be used for those.

Located in /dateordatetimeproperties.php (line 31) 

PhpiCalLib_ContentLine
   |
   --PhpiCalLib_Properties_UnencodedProperty
      |
      --PhpiCalLib_Properties_DateOrDateTimeProperty
Direct descendents
Description | Descendents | Vars | Methods (details)
Class Description
PhpiCalLib_Properties_DtEndProperty The DTEND property.
PhpiCalLib_Properties_DueProperty The DUE property.
PhpiCalLib_Properties_DtStartProperty The DTSTART property.
PhpiCalLib_Properties_RecurrenceIdProperty The RECURRENCE-ID property.
PhpiCalLib_Properties_ExDateProperty The EXDATE property.
Method Summary
Description | Descendents | Vars | Methods (details)
PhpiCalLib_DateType_DateTime GetDateTimeValue ()
PhpiCalLib_DateType_Date GetDateValue ()
PhpiCalLib_DateType_Time GetTimeValue ()
void SetDateFromTimeStamp (number $Time)
void SetDateTimeFromTimeStamp (number $Time, bool $Utc)
void SetDateTimeValue (PhpiCalLib_DateType_DateTime $DateTime)
void SetDateValue (PhpiCalLib_DateType_Date $Date)
void SetEncodedValue ( $Text)
integer ToTimeStamp ()
Variables
Description | Descendents | Vars (details) | Methods (details)

Inherited Variables

Inherited from PhpiCalLib_ContentLine

PhpiCalLib_ContentLine::$aParameters
 PhpiCalLib_ContentLine::$aPermittedParameters
 PhpiCalLib_ContentLine::$EncodedValue
 PhpiCalLib_ContentLine::$IanaTokenRegex
 PhpiCalLib_ContentLine::$Name
 PhpiCalLib_ContentLine::$NameSplitRegex
 PhpiCalLib_ContentLine::$Type
Methods
Description | Descendents | Vars Methods (details)
GetDateTimeValue (line 80)

Access the date-time of the value. This will return null if the value is a date not a date-time

  • return: or null
  • access: public
PhpiCalLib_DateType_DateTime GetDateTimeValue ()
GetDateValue (line 55)

Access the Date of the value.

  • access: public
PhpiCalLib_DateType_Date GetDateValue ()
GetTimeValue (line 68)

Access the Time of the value. This will return null if the value is a date not a date-time

  • return: or null
  • access: public
PhpiCalLib_DateType_Time GetTimeValue ()
SetDateFromTimeStamp (line 134)

Set to a date-time property as represented by the given timestamp

  • access: public
void SetDateFromTimeStamp (number $Time)
  • number $Time: Unix timestamp
SetDateTimeFromTimeStamp (line 108)

Set to a date-time property as represented by the given timestamp

  • access: public
void SetDateTimeFromTimeStamp (number $Time, bool $Utc)
  • number $Time: Unix timestamp
  • bool $Utc: true to store in utc, false to store in "floating time", TZ specified by the TZID parameter
SetDateTimeValue (line 120)

Set the value as a DateTime

  • access: public
void SetDateTimeValue (PhpiCalLib_DateType_DateTime $DateTime)
  • PhpiCalLib_DateType_DateTime $DateTime
SetDateValue (line 145)

Set the value as a Date

  • access: public
void SetDateValue (PhpiCalLib_DateType_Date $Date)
  • PhpiCalLib_DateType_Date $Date
SetEncodedValue (line 161)

Overridden to do extra parsing to extract the $TextValue

  • access: public
void SetEncodedValue ( $Text)
  • $Text
Redefinition of:
PhpiCalLib_ContentLine::SetEncodedValue()
Sets the property value by specifying the encoded value
ToTimeStamp (line 94)

Return a timestamp WRT to UTC.

If the value is a Date, then it will be set to midnight.

  • return: Number of seconds since 1970 UTC
  • access: public
integer ToTimeStamp ()

Inherited Methods

Inherited From PhpiCalLib_Properties_UnencodedProperty

PhpiCalLib_Properties_UnencodedProperty::GetValue()
PhpiCalLib_Properties_UnencodedProperty::SetValue()

Inherited From PhpiCalLib_ContentLine

PhpiCalLib_ContentLine::__construct()
PhpiCalLib_ContentLine::AddParameter()
PhpiCalLib_ContentLine::AddParameterPermitted()
PhpiCalLib_ContentLine::Copy()
PhpiCalLib_ContentLine::Create()
PhpiCalLib_ContentLine::CreateContentLine()
PhpiCalLib_ContentLine::GetEncodedValue()
PhpiCalLib_ContentLine::GetName()
PhpiCalLib_ContentLine::GetParameter()
PhpiCalLib_ContentLine::GetParameters()
PhpiCalLib_ContentLine::GetType()
PhpiCalLib_ContentLine::RemoveParameter()
PhpiCalLib_ContentLine::RemoveParameterPermitted()
PhpiCalLib_ContentLine::SetEncodedValue()
PhpiCalLib_ContentLine::SetName()
PhpiCalLib_ContentLine::SetParameter()
PhpiCalLib_ContentLine::SetParameterPermitted()
PhpiCalLib_ContentLine::SetParameters()
PhpiCalLib_ContentLine::SetType()
PhpiCalLib_ContentLine::ToContentLines()
PhpiCalLib_ContentLine::ToPropertyName()
PhpiCalLib_ContentLine::ToPropertyType()
PhpiCalLib_ContentLine::ToString()

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