File/inc/caldav-PUT-functions.php

Description

CalDAV Server - handle PUT method

Includes
 include_once ("iCalendar.php") (line 18)

Check if the user wants to put just one VEVENT/VTODO or a whole calendar

if the collection = calendar = $request_container doesn't exist then create it return true if it's a whole calendar

Functions
controlRequestContainer (line 56)

Work out the location we are doing the PUT to, and check that we have the rights to do the needful.

void controlRequestContainer (string $username, int $user_no, string $path, boolean $caldav_context)
  • string $username: The name of the destination user
  • int $user_no: The user making the change
  • string $path: The DAV path the resource is bing PUT to
  • boolean $caldav_context: Whether we are responding via CalDAV or interactively
create_scheduling_requests (line 133)

Create scheduling requests in the schedule inbox for the

void create_scheduling_requests ( $resource, iCalComponent $component)
  • iCalComponent $component: The VEVENT/VTODO/... resource we are scheduling
  • $resource
import_collection (line 157)

This function will import a whole calendar

void import_collection (string $ics_content, int $user_no, string $path, boolean $caldav_context)
  • string $ics_content: the ics file to import
  • int $user_no: the user wich will receive this ics file
  • string $path: the $path where it will be store such as /user_foo/home/
  • boolean $caldav_context:

    Whether we are responding via CalDAV or interactively

    Any VEVENTs with the same UID will be concatenated together

public_events_only (line 105)

Check if this collection should force all events to be PUBLIC.

  • return: Return true if public events only are allowed.
boolean public_events_only (string $user_no, string $dav_name)
  • string $user_no: the user that owns the collection
  • string $dav_name: the collection to check
putCalendarResource (line 337)

Put the resource from this request

  • return: Either 'INSERT' or 'UPDATE': the type of action that the PUT resulted in
string putCalendarResource ( &$request, int $author, boolean $caldav_context, object $request)
  • object $request: A reference to the request object
  • int $author: The user_no who wants to put this resource on the server
  • boolean $caldav_context: Whether we are responding via CalDAV or interactively
  • &$request
rollback_on_error (line 33)

This function launches an error

void rollback_on_error (boolean $caldav_context, int $user_no, string $path, [string $message = ''], [int $error_no = 500])
  • boolean $caldav_context: Whether we are responding via CalDAV or interactively
  • int $user_no: the user wich will receive this ics file
  • string $path: the $path where the PUT failed to store such as /user_foo/home/
  • string $message: An optional error message to return to the client
  • int $error_no: An optional value for the HTTP error code

Documentation generated on Tue, 18 Nov 2008 18:33:29 +1300 by phpDocumentor 1.3.2