Docs for page schedule-functions.php

## /inc/schedule-functions.php

Description

Functions for handling CalDAV Scheduling.

- author: Andrew McMillan <andrew@morphoss.com>
- copyright: Morphoss Ltd - http://www.morphoss.com/
- license: GNU GPL v2 or later version

Includes
require_once ('RRule-v2.php') (line 14)
require_once ('WritableCollection.php') (line 13)
require_once ('vCalendar.php') (line 12)

Functions for handling CalDAV Scheduling.

- author: Andrew McMillan <andrew@morphoss.com>
- copyright: Morphoss Ltd - http://www.morphoss.com/
- license: GNU GPL v2 or later version

Functions
deliverItipCancel (line 312)

Delivers the iTIP CANCEL message to an ATTENDEE's Scheduling Inbox Collection.

This is pretty simple at present, but could be extended in the future to do the sending of e-mail to a remote attendee.

void deliverItipCancel ( $iTIP, $attendee, WritableCollection $attendee_inbox)

- vCalendar $iTIP
- vProperty $attendee
- WritableCollection $attendee_inbox

doItipAttendeeReply (line 67)

Do the scheduling adjustments for a REPLY when an ATTENDEE updates their status.

void doItipAttendeeReply ( $resource, $partstat, vCalendar $vcal, string $organizer)

- vCalendar $vcal: The resource that the ATTENDEE is writing to their calendar
- string $organizer: The property which is the event ORGANIZER.
- vCalendar $resource
- $partstat

doItipOrganizerCancel (line 207)

Handles sending the iTIP CANCEL messages to each ATTENDEE by the ORGANIZER.

void doItipOrganizerCancel ( $vcal)

- vCalendar $vcal: What's being cancelled.

do_scheduling_for_delete (line 24)

Entry point for scheduling on DELETE, for which there are thee outcomes:

- We don't do scheduling (disabled, no organizer, ...)
- We are an ATTENDEE declining the meeting.

- We are the ORGANIZER canceling the meeting.

void do_scheduling_for_delete (DAVResource $deleted_resource)

- DAVResource $deleted_resource: The resource which has already been deleted

GetItip (line 178)
void GetItip ( $vcal, $method, $attendee_value)

- VCalendar $vcal
- $method
- $attendee_value

processItipCancel (line 265)

Does the actual processing of the iTIP CANCEL message on behalf of an ATTENDEE, which generally means writing it into the ATTENDEE's default calendar.

void processItipCancel ( $vcal, $attendee, WritableCollection $attendee_calendar, Principal $attendee_principal)

- vCalendar $vcal: The message.
- vProperty $attendee
- WritableCollection $attendee_calendar
- Principal $attendee_principal

Documentation generated on Sun, 08 Jul 2012 12:53:51 +0000 by phpDocumentor 1.4.3