Andrew's Web Libraries (AWL)
Loading...
Searching...
No Matches
vCalendar Class Reference
Inheritance diagram for vCalendar:
Collaboration diagram for vCalendar:

Public Member Functions

 __construct ($content=null)
 
 AddTimeZone (vComponent $vtz, $in_components=false)
 
 GetTimeZone ( $tzid)
 
 GetOrganizer ()
 
 GetScheduleAgent ()
 
 GetAttendees ()
 
 UpdateAttendeeStatus ( $email, vProperty $statusProperty)
 
 UpdateOrganizerStatus (vProperty $statusProperty)
 
 StartFilter ( $filters)
 
 GetOlsonName (vComponent $vtz)
 
 Confidential ()
 
 GetItip ($method, $attendee_value)
 
 GetUID ()
 
 SetUID ( $newUid)
 
- Public Member Functions inherited from vComponent
 __construct ($propstring=null, &$refData=null)
 
 initFromIterator (&$iterator, $begin=-1)
 
 getIterator ()
 
 initFromText (&$plainText)
 
 rewind ()
 
 explode ()
 
 close ()
 
 parseFrom (&$iterator)
 
 ComponentCount ()
 
 propertiesCount ()
 
 getComponentAt ($position)
 
 getPropertyAt ($position)
 
 clearPropertyAt ($position)
 
 GetType ()
 
 SetType ( $type)
 
 CollectParameterValues ( $parameter_name)
 
 GetProperty ( $type)
 
 GetPValue ( $type)
 
 GetProperties ( $type=null)
 
 GetPropertiesByPath ( $path)
 
 ClearProperties ( $type=null)
 
 SetProperties ( $new_properties, $type=null)
 
 AddProperty ( $new_property, $value=null, $parameters=null)
 
 GetComponents ( $type=null, $normal_match=true)
 
 ClearComponents ( $type=null)
 
 SetComponents ( $new_component, $type=null)
 
 AddComponent ( $new_component)
 
 MaskComponents ( $keep, $recursive=true)
 
 MaskProperties ( $keep, $component_list=null)
 
 WrapComponent ( $content)
 
 UnwrapComponent (&$content)
 
 Render ($restricted_properties=null, $force_rendering=false)
 
 isValid ()
 
 TestFilter ( $filters)
 
- Public Member Functions inherited from vObject
 __construct (&$master=null)
 
 setMaster ($master)
 
 getMaster ()
 

Private Attributes

 $contained_type
 
 $primary_component
 
 $timezones
 
 $organizer
 
 $attendees
 
 $schedule_agent
 
 $rendered
 

Additional Inherited Members

- Public Attributes inherited from vComponent
const KEYBEGIN = 'BEGIN:'
 
const KEYBEGINLENGTH = 6
 
const KEYEND = "END:"
 
const KEYENDLENGTH = 4
 
const VEOL = "\r\n"
 
- Static Public Attributes inherited from vComponent
static $PREPARSED = false
 
- Protected Member Functions inherited from vComponent
 RenderWithoutWrap ($restricted_properties=null, $force_rendering=false)
 
 RenderWithoutWrapFromObjects ()
 
 RenderWithoutWrapFromIterator ($unrolledComponents)
 
- Protected Member Functions inherited from vObject
 invalidate ()
 
- Protected Attributes inherited from vObject
 $lineHeap
 
 $valid = true
 
 $master
 

Detailed Description

Definition at line 23 of file vCalendar.php.

Constructor & Destructor Documentation

◆ __construct()

vCalendar::__construct (   $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.

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

Parameters
mixed$contentCan be a string to be parsed, or an array of key value pairs.

Definition at line 52 of file vCalendar.php.

Member Function Documentation

◆ AddTimeZone()

vCalendar::AddTimeZone ( vComponent  $vtz,
  $in_components = false 
)

Add a timezone component to this vCalendar.

Definition at line 94 of file vCalendar.php.

◆ Confidential()

vCalendar::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'.

Definition at line 343 of file vCalendar.php.

◆ GetAttendees()

vCalendar::GetAttendees ( )

Get the attendees of this VEVENT/VTODO

Definition at line 148 of file vCalendar.php.

◆ GetItip()

vCalendar::GetItip (   $method,
  $attendee_value 
)

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

Definition at line 363 of file vCalendar.php.

◆ GetOlsonName()

vCalendar::GetOlsonName ( vComponent  $vtz)

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

Parameters
vComponent$vtzThe VTIMEZONE component.
Returns
string The Olson name for the timezone.

List of Microsoft CDO Timezone IDs from here: http://msdn.microsoft.com/en-us/library/aa563018%28loband%29.aspx

Definition at line 238 of file vCalendar.php.

◆ GetOrganizer()

vCalendar::GetOrganizer ( )

Get the organizer of this VEVENT/VTODO

Returns
vProperty The Organizer property.

Definition at line 121 of file vCalendar.php.

◆ GetScheduleAgent()

vCalendar::GetScheduleAgent ( )

Get the schedule-agent from the organizer

Returns
vProperty The schedule-agent parameter

Definition at line 139 of file vCalendar.php.

◆ GetTimeZone()

vCalendar::GetTimeZone (   $tzid)

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

Parameters
string$tzidThe TZID for the timezone to be retrieved.
Returns
vComponent The timezone as a vComponent.

Definition at line 111 of file vCalendar.php.

◆ GetUID()

vCalendar::GetUID ( )

Get the UID from the primary component.

Definition at line 398 of file vCalendar.php.

◆ SetUID()

vCalendar::SetUID (   $newUid)

Set the UID on the primary component.

Parameters
stringnewUid

Definition at line 409 of file vCalendar.php.

◆ StartFilter()

vCalendar::StartFilter (   $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*))

Parameters
array$filterAn array of XMLElement defining the filter
Returns
boolean Whether or not this vCalendar passes the test

Definition at line 220 of file vCalendar.php.

◆ UpdateAttendeeStatus()

vCalendar::UpdateAttendeeStatus (   $email,
vProperty  $statusProperty 
)

Update the attendees of this VEVENT/VTODO

Parameters
string$emailThe e-mail address of the attendee to be updated.
vProperty$statusPropertyA replacement property.

Definition at line 171 of file vCalendar.php.

◆ UpdateOrganizerStatus()

vCalendar::UpdateOrganizerStatus ( vProperty  $statusProperty)

Update the ORGANIZER of this VEVENT/VTODO

Parameters
vProperty$statusPropertyA replacement property.

Definition at line 198 of file vCalendar.php.

Member Data Documentation

◆ $attendees

array vCalendar::$attendees
private

Definition at line 38 of file vCalendar.php.

◆ $contained_type

string vCalendar::$contained_type
private

These variables are mostly used to improve efficiency by caching values as they are retrieved to speed any subsequent access.

Definition at line 34 of file vCalendar.php.

◆ $organizer

string vCalendar::$organizer
private

Definition at line 37 of file vCalendar.php.

◆ $primary_component

vComponent vCalendar::$primary_component
private

Definition at line 35 of file vCalendar.php.

◆ $rendered

vCalendar::$rendered
private

Definition at line 40 of file vCalendar.php.

◆ $schedule_agent

vCalendar::$schedule_agent
private

Definition at line 39 of file vCalendar.php.

◆ $timezones

array vCalendar::$timezones
private

Definition at line 36 of file vCalendar.php.


The documentation for this class was generated from the following file: