Class PhpiCalLib_iCalendar

Description
Description | Vars | Methods (details)

The top level class of PhpiCalLib, representing the contents of an iCalendar file

  • version: 1.0

Located in /icalendar.php (line 35) 

PhpiCalLib_Component
   |
   --PhpiCalLib_iCalendar
Method Summary
Description | Vars | Methods (details)
PhpiCalLib_iCalendar __construct ()
void AddComponent (PhpiCalLib_Component $Component)
PhpiCalLib_Component CreateComponent (string $Name)
void FromFile (string $FileName)
void FromString ( $iCalObjectString, string $Text)
array GetComponents ([integer $Type = null], [string $Name = null])
void ParseiCalBody (array(contentline) $aContentLines)
void ToFile (string $FileName)
A ToString ()
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from PhpiCalLib_Component

PhpiCalLib_Component::$aContentLines
 PhpiCalLib_Component::$aPermittedProperties
 PhpiCalLib_Component::$Name
 PhpiCalLib_Component::$Type
Methods
Description | Vars Methods (details)
Constructor __construct (line 101)

Consturctor

  • access: public
PhpiCalLib_iCalendar __construct ()
Redefinition of:
PhpiCalLib_Component::__construct()
Constructor
AddComponent (line 402)

Add a component to the collection in this calendar

  • access: public
void AddComponent (PhpiCalLib_Component $Component)
CreateComponent (line 164)

Overridden to create the right kind of component

  • return: derived class
  • access: protected
PhpiCalLib_Component CreateComponent (string $Name)
  • string $Name: The name of the component
Redefinition of:
PhpiCalLib_Component::CreateComponent()
Create a new Component object
FromFile (line 118)

Parse an iCalendar file from a file on disk

  • access: public
void FromFile (string $FileName)
  • string $FileName
FromString (line 131)

Parse an iCalendar file from a string

  • access: public
void FromString ( $iCalObjectString, string $Text)
  • string $Text
  • $iCalObjectString
GetComponents (line 419)

Access all the components of the given type

  • return: A collection of PHPICALLIB_COMPONENT objects
  • access: public
array GetComponents ([integer $Type = null], [string $Name = null])
  • integer $Type: One of the PHPICALLIB_COMPONENT_* types, or null to return all components.
  • string $Name: The name of the component to match, or null to match just by type
ParseiCalBody (line 199)

Parse an iCalendar object from a set of contentlines that represent an icalbody

  • access: public
void ParseiCalBody (array(contentline) $aContentLines)
  • array(contentline) $aContentLines: An array of content lines that represent the iCalendar
ToFile (line 334)

Parse an iCalendar file from a file on disk

  • access: public
void ToFile (string $FileName)
  • string $FileName
ToString (line 348)

Dump the object to a string

  • return: string representation in the default code page
  • access: public
A ToString ()
Redefinition of:
PhpiCalLib_Component::ToString()
Dump the parameter to an array of unfolded content lines

Inherited Methods

Inherited From PhpiCalLib_Component

PhpiCalLib_Component::__construct()
PhpiCalLib_Component::AddProperty()
PhpiCalLib_Component::AddPropertyPermitted()
PhpiCalLib_Component::Create()
PhpiCalLib_Component::CreateComponent()
PhpiCalLib_Component::GetName()
PhpiCalLib_Component::GetProperties()
PhpiCalLib_Component::GetProperty()
PhpiCalLib_Component::GetType()
PhpiCalLib_Component::RemoveProperty()
PhpiCalLib_Component::RemovePropertyPermitted()
PhpiCalLib_Component::SetName()
PhpiCalLib_Component::SetProperties()
PhpiCalLib_Component::SetProperty()
PhpiCalLib_Component::SetPropertyPermitted()
PhpiCalLib_Component::SetType()
PhpiCalLib_Component::ToComponentType()
PhpiCalLib_Component::ToString()

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