Docs For Class vCalendar

Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370

## vCalendar

Description
Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370

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)
void GetUID ()
void SetUID (string $newUid)
boolean StartFilter ( $filters, array $filter)
void UpdateAttendeeStatus (string $email, vProperty $statusProperty)
void UpdateOrganizerStatus (vProperty $statusProperty)
Variables
Strict Standards: Only variables should be passed by reference in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370

#### Inherited Variables

Inherited from vComponent

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

Methods
Strict Standards: Only variables should be passed by reference in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
Constructor __construct (line 51)

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 87)

Add a timezone component to this vCalendar.

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

- vComponent $vtz
- $in_components

Confidential (line 339)

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 141)

Get the attendees of this VEVENT/VTODO

void GetAttendees ()
GetItip (line 359)

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

void GetItip ( $method, $attendee_value)

- $method
- $attendee_value

GetOlsonName (line 234)

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 114)

Get the organizer of this VEVENT/VTODO

- return: The Organizer property.

vProperty GetOrganizer ()
GetScheduleAgent (line 132)

Get the schedule-agent from the organizer

- return: The schedule-agent parameter

vProperty GetScheduleAgent ()
GetTimeZone (line 104)

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.

GetUID (line 397)

Get the UID from the primary component.

void GetUID ()
SetUID (line 408)

Set the UID on the primary component.

void SetUID (string $newUid)

- string $newUid: newUid

StartFilter (line 216)

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 163)

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 190)

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()

Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370

Documentation generated on Wed, 04 Jul 2012 07:06:16 +0000 by phpDocumentor 1.4.3