Class vCalendar

Created by JetBrains PhpStorm. User: milan Date: 7/4/13 Time: 12:59 PM To change this template use File | Settings | File Templates.

vObject

vComponent

vCalendar

Package: awl\vCalendar
Copyright: Morphoss Ltd http://www.morphoss.com/
License: GNU LGPL v3 or later
Author: Andrew McMillan andrew@mcmillan.net.nz
Located at vCalendar.php

Methods summary
`public`	# `__construct( mixed $content = null )` 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. 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' ) ); Parameters `$content` Can be a string to be parsed, or an array of key value pairs. Overrides `vComponent::__construct()`
`public`	# `AddTimeZone( vComponent $vtz, $in_components = false )` Add a timezone component to this vCalendar. Add a timezone component to this vCalendar.
`public vComponent`	# `GetTimeZone( string $tzid )` Get a timezone component for a specific TZID in this calendar. Get a timezone component for a specific TZID in this calendar. Parameters `$tzid` The TZID for the timezone to be retrieved. Returns `vComponent` The timezone as a vComponent.
`public vProperty`	# `GetOrganizer( )` Get the organizer of this VEVENT/VTODO Get the organizer of this VEVENT/VTODO Returns `vProperty` The Organizer property.
`public vProperty`	# `GetScheduleAgent( )` Get the schedule-agent from the organizer Get the schedule-agent from the organizer Returns `vProperty` The schedule-agent parameter
`public`	# `GetAttendees( )` Get the attendees of this VEVENT/VTODO Get the attendees of this VEVENT/VTODO
`public`	# `UpdateAttendeeStatus( string $email, vProperty $statusProperty )` Update the attendees of this VEVENT/VTODO Update the attendees of this VEVENT/VTODO Parameters `$email` The e-mail address of the attendee to be updated. `$statusProperty` A replacement property.
`public`	# `UpdateOrganizerStatus( vProperty $statusProperty )` Update the ORGANIZER of this VEVENT/VTODO Update the ORGANIZER of this VEVENT/VTODO Parameters `$statusProperty` A replacement property.
`public boolean`	# `StartFilter( array $filters )` 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)) 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)) Parameters `$filters` $filter An array of XMLElement defining the filter Returns boolean Whether or not this vCalendar passes the test
`public string`	# `GetOlsonName( vComponent $vtz )` Work out what Olson timezone this VTIMEZONE really is. Perhaps we should put this into a vTimezone class. Work out what Olson timezone this VTIMEZONE really is. Perhaps we should put this into a vTimezone class. Parameters `$vtz` The VTIMEZONE component. Returns string The Olson name for the timezone.
`public`	# `Confidential( )` 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'. 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'.
`public`	# `GetItip( $method, $attendee_value )` Clone this component (and subcomponents) into a minimal iTIP version of it. Clone this component (and subcomponents) into a minimal iTIP version of it.
`public`	# `GetUID( )` Get the UID from the primary component. Get the UID from the primary component.
`public`	# `SetUID( string $newUid )` Set the UID on the primary component. Set the UID on the primary component. Parameters `$newUid` newUid

Methods inherited from vComponent
AddComponent(), AddProperty(), ClearComponents(), ClearProperties(), CollectParameterValues(), ComponentCount(), GetComponents(), GetPValue(), GetProperties(), GetPropertiesByPath(), GetProperty(), GetType(), MaskComponents(), MaskProperties(), Render(), RenderWithoutWrap(), RenderWithoutWrapFromIterator(), RenderWithoutWrapFromObjects(), SetComponents(), SetProperties(), SetType(), TestFilter(), UnwrapComponent(), WrapComponent(), clearPropertyAt(), close(), explode(), getComponentAt(), getIterator(), getPropertyAt(), initFromIterator(), initFromText(), isValid(), parseFrom(), propertiesCount(), rewind()

Methods inherited from vObject
`getMaster(), invalidate(), setMaster()`

Constants inherited from vComponent
`KEYBEGIN, KEYBEGINLENGTH, KEYEND, KEYENDLENGTH, VEOL`

Properties inherited from vComponent
`$PREPARSED`

Properties inherited from vObject
`$lineHeap, $master, $valid`

Packages

Classes

Class vCalendar

Parameters

Overrides

Parameters

Returns

Returns

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters