Docs For Class vCalendar

## vCalendar

Description

A Class for representing components within an vComponent

Located in /vCalendar.php (line 23)

    vComponent
       |
       --vCalendar

Method Summary
vCalendar __construct ([mixed $content = null])
void AddTimeZone (vComponent $vtz, [ $in_components = false])
void Confidential ()
void GetAttendees ()
void GetItip ( $method, $attendee_value)
string GetOlsonName (vComponent $vtz)
vProperty GetOrganizer ()
vProperty GetScheduleAgent ()
vComponent GetTimeZone (string $tzid)
boolean StartFilter ( $filters, array $filter)
void UpdateAttendeeStatus (string $email, vProperty $statusProperty)
void UpdateOrganizerStatus (vProperty $statusProperty)
Variables

#### Inherited Variables

Inherited from vComponent

> vComponent::$components
> vComponent::$properties
> vComponent::$rendered
> vComponent::$type

Methods
Constructor __construct (line 49)

Constructor. If a string is passed it will be parsed as if it was an iCalendar object, otherwise a new vCalendar will be initialised with basic content. If an array of key value pairs is provided they will also be used as top-level properties.

Typically this will be used to set a METHOD property on the VCALENDAR as something like: $shinyCalendar = new vCalendar( array('METHOD' => 'REQUEST' ) );

vCalendar __construct ([mixed $content = null])

- mixed $content: Can be a string to be parsed, or an array of key value pairs.

Redefinition of:

vComponent::__construct()
  A basic constructor

AddTimeZone (line 81)

Add a timezone component to this vCalendar.

void AddTimeZone (vComponent $vtz, [ $in_components = false])

- vComponent $vtz
- $in_components

Confidential (line 331)

Morph this component (and subcomponents) into a confidential version of it. A confidential event will be scrubbed of any identifying characteristics other than time/date, repeat, uid and a summary which is just a translated 'Busy'.

void Confidential ()
GetAttendees (line 134)

Get the attendees of this VEVENT/VTODO

void GetAttendees ()
GetItip (line 351)

Clone this component (and subcomponents) into a minimal iTIP version of it.

void GetItip ( $method, $attendee_value)

- $method
- $attendee_value

GetOlsonName (line 227)

Work out what Olson timezone this VTIMEZONE really is. Perhaps we should put this into a vTimezone class.

- return: The Olson name for the timezone.

string GetOlsonName (vComponent $vtz)

- vComponent $vtz: The VTIMEZONE component.

GetOrganizer (line 107)

Get the organizer of this VEVENT/VTODO

- return: The Organizer property.

vProperty GetOrganizer ()
GetScheduleAgent (line 125)

Get the schedule-agent from the organizer

- return: The schedule-agent parameter

vProperty GetScheduleAgent ()
GetTimeZone (line 97)

Get a timezone component for a specific TZID in this calendar.

- return: The timezone as a vComponent.

vComponent GetTimeZone (string $tzid)

- string $tzid: The TZID for the timezone to be retrieved.

StartFilter (line 209)

Test a PROP-FILTER or COMP-FILTER and return a true/false COMP-FILTER (is-defined | is-not-defined | (time-range?, prop-filter*, comp-filter*)) PROP-FILTER (is-defined | is-not-defined | ((time-range | text-match)?, param-filter*))

- return: Whether or not this vCalendar passes the test

boolean StartFilter ( $filters, array $filter)

- array $filter: An array of XMLElement defining the filter
- $filters

UpdateAttendeeStatus (line 156)

Update the attendees of this VEVENT/VTODO

void UpdateAttendeeStatus (string $email, vProperty $statusProperty)

- string $email: The e-mail address of the attendee to be updated.
- vProperty $statusProperty: A replacement property.

UpdateOrganizerStatus (line 183)

Update the ORGANIZER of this VEVENT/VTODO

void UpdateOrganizerStatus (vProperty $statusProperty)

- vProperty $statusProperty: A replacement property.

#### Inherited Methods

Inherited From vComponent

> vComponent::__construct()
> vComponent::AddComponent()
> vComponent::AddProperty()
> vComponent::ClearComponents()
> vComponent::ClearProperties()
> vComponent::CollectParameterValues()
> vComponent::ComponentCount()
> vComponent::GetComponents()
> vComponent::GetProperties()
> vComponent::GetPropertiesByPath()
> vComponent::GetProperty()
> vComponent::GetPValue()
> vComponent::GetType()
> vComponent::MaskComponents()
> vComponent::MaskProperties()
> vComponent::ParseFrom()
> vComponent::Render()
> vComponent::SetComponents()
> vComponent::SetProperties()
> vComponent::SetType()
> vComponent::TestFilter()
> vComponent::UnwrapComponent()
> vComponent::WrapComponent()
> vComponent::__toString()

Documentation generated on Fri, 13 Jan 2012 23:40:18 +1300 by phpDocumentor 1.4.3