Docs For Class CalDAVPrincipal

Description

A class for things to do with a DAV Principal

Variable Summary

Whether $by_email

RFC4791: $calendar_home_set

draft-desruisseaux-caldav-sched-03: $schedule_inbox_url

draft-desruisseaux-caldav-sched-03: $schedule_outbox_url

The $url

Method Summary

boolean CalDAVPrincipal ([mixed $parameters = null])

void InitialiseRecord (object $usr)

void UsernameFromPath (string $path, [array $options = null])

Variables

Whether $by_email (line 53)

RFC4791: $calendar_home_set (line 36)

var: Identifies the URL(s) of any WebDAV collections that contain calendar collections owned by the associated principal resource.

draft-desruisseaux-caldav-sched-03: $schedule_inbox_url (line 42)

var: Identify the URL of the scheduling Inbox collection owned by the associated principal resource.

draft-desruisseaux-caldav-sched-03: $schedule_outbox_url (line 48)

var: Identify the URL of the scheduling Outbox collection owned by the associated principal resource.

The $url (line 30)

Methods

Constructor CalDAVPrincipal (line 63)

Constructor

boolean CalDAVPrincipal ([mixed $parameters = null])

mixed $parameters: If null, an empty Principal is created. If it is an integer then that ID is read (if possible). If it is an array then the Principal matching the supplied elements is read.

InitialiseRecord (line 103)

Initialise the Principal object from a $usr record from the DB.

void InitialiseRecord (object $usr)

UsernameFromPath (line 140)

Work out the username, based on elements of the path.

void UsernameFromPath (string $path, [array $options = null])

string $path: The path to be used.
array $options: The request options, controlling whether e-mail paths are allowed.