## CalDAVPrincipal

Description

A class for things to do with a DAV Principal

Located in /inc/CalDAVPrincipal.php (line 25)

Variable Summary
Whether $by_email
The $dav_name
RFC3744: $group_membership
RFC3744: $group_member_set
CardDAV: $principal_address
caldav-cu-proxy-02: $read_proxy_for
caldav-cu-proxy-02: $read_proxy_group
draft-desruisseaux-caldav-sched-03: $schedule_inbox_url
draft-desruisseaux-caldav-sched-03: $schedule_outbox_url
The $url
The $username
caldav-cu-proxy-02: $write_proxy_for
caldav-cu-proxy-02: $write_proxy_group
RFC3744: $_is_group
Method Summary
boolean __construct ([mixed $parameters = null])
void addressbook_home_set ()
void AsCollection ()
void calendar_free_busy_set ()
void calendar_home_set ()
string dav_name ()
boolean Exists ()
void FetchProxyGroups ()
void GroupMemberSet ()
void GroupMembership ()
void InitialiseRecord (object $usr)
boolean IsGroup ()
void PrincipalProperty ( $tag, $prop, &$reply, &$denied)
void Privileges ()
void ProxyFor (string $type)
void ReadProxyGroup ()
string RenderAsXML (array $properties, &$reply, [boolean $props_only = false], reference $reply)
string username ()
void UsernameFromEMail (string $email)
void UsernameFromPath (string $path, [array $options = null])
void WriteProxyGroup ()
Variables
Whether $by_email (line 69)

- var: or not we are using an e-mail address based URL.

The $dav_name (line 119)

- var: dav_name for this principal - a partial path
- access: protected

RFC3744: $group_membership (line 84)

- var: The groups in which the principal is directly a member.
- access: protected

RFC3744: $group_member_set (line 79)

- var: The principals that are direct members of this group.
- access: protected

CardDAV: $principal_address (line 109)

- var: The URL to an addressbook entry for this principal
- access: protected

caldav-cu-proxy-02: $read_proxy_for (line 89)

- var: The principals which this one has read permissions on.
- access: protected

caldav-cu-proxy-02: $read_proxy_group (line 99)

- var: The principals which have read permissions on this one.
- access: protected

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

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

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

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

The $url (line 30)

- var: home URL of the principal

The $username (line 114)

- var: username for this principal
- access: protected

caldav-cu-proxy-02: $write_proxy_for (line 94)

- var: The principals which this one has read-write prmissions for.
- access: protected

caldav-cu-proxy-02: $write_proxy_group (line 104)

- var: The principals which have write permissions on this one.
- access: protected

RFC3744: $_is_group (line 74)

- var: The principals that are direct members of this group.
- access: protected

Methods
Constructor __construct (line 131)

Constructor

- return: Whether we actually read data from the DB to initialise the record.

boolean __construct ([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. If it is an object then it is expected to be a 'usr' record that was read elsewhere.

addressbook_home_set (line 463)

Get the addressbook_home_set, as lazily as possible

void addressbook_home_set ()
AsCollection (line 516)

Returns a representation of the principal as a collection

void AsCollection ()
calendar_free_busy_set (line 485)

Get the calendar_free_busy_set, as lazily as possible

void calendar_free_busy_set ()
calendar_home_set (line 441)

Get the calendar_home_set, as lazily as possible

void calendar_home_set ()
dav_name (line 429)

Return the partial path representing this principal

- return: The dav_name

string dav_name ()
Exists (line 402)

Does this principal exist?

- return: Whether or not it exists.

boolean Exists ()
FetchProxyGroups (line 259)

Split this out so we do it as infrequently as possible, given the cost.

void FetchProxyGroups ()
GroupMemberSet (line 349)

Accessor for the group member set - the members of this group

void GroupMemberSet ()
GroupMembership (line 340)

Accessor for the group membership - the groups this principal is a member of

void GroupMembership ()
InitialiseRecord (line 196)

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

void InitialiseRecord (object $usr)

- object $usr: The usr record from the DB.

IsGroup (line 411)

Is this a group principal?

- return: Whether this is a group principal

boolean IsGroup ()
PrincipalProperty (line 540)

Returns properties which are specific to this principal

void PrincipalProperty ( $tag, $prop, &$reply, &$denied)

- $tag
- $prop
- &$reply
- &$denied

Privileges (line 506)

Return the privileges bits for the current session user to this resource

void Privileges ()
ProxyFor (line 330)

Accessor for read or write proxy

void ProxyFor (string $type)

- string $type: read/write - which sort of proxy list is requested.

ReadProxyGroup (line 311)

Accessor for the read proxy group

void ReadProxyGroup ()
RenderAsXML (line 658)

Render XML for a single Principal (user) from the DB

- return: An XML fragment with the requested properties for this principal

string RenderAsXML (array $properties, &$reply, [boolean $props_only = false], reference $reply)

- array $properties: The requested properties for this principal
- reference $reply: A reference to the XMLDocument being used for the reply
- boolean $props_only: Default false. If true will only return the fragment with the properties, not a full response fragment.
- &$reply

username (line 420)

Return the username

- return: The username

string username ()
UsernameFromEMail (line 386)

Work out the username, based on the given e-mail

void UsernameFromEMail (string $email)

- string $email: The email address to be used.

UsernameFromPath (line 360)

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.

WriteProxyGroup (line 320)

Accessor for the write proxy group

void WriteProxyGroup ()

Documentation generated on Sun, 26 Sep 2010 00:46:06 +1200 by phpDocumentor 1.4.3