Class CalDAVPrincipal

Description

A class for things to do with a DAV Principal

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


	
			
Variable Summary
 Whether $by_email
 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)
 string RenderAsXML (array $properties,  &$reply, [boolean $props_only = false], reference $reply)
 void RenderPrivileges ( $privilege_names, [ $container = "privilege"])
 void UsernameFromEMail (string $email)
 void UsernameFromPath (string $path, [array $options = null])
Variables
Whether $by_email (line 53)
  • var: or not we are using an e-mail address based URL.
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.
RFC3744: $group_membership (line 63)
  • var: The groups in which the principal is directly a member.
RFC3744: $group_member_set (line 58)
  • var: The principals that are direct members of this group.
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)
  • var: home URL of the principal
Methods
Constructor CalDAVPrincipal (line 75)

Constructor

  • return: Whether we actually read data from the DB to initialise the record.
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. If it is an object then it is expected to be a 'usr' record that was read elsewhere.
InitialiseRecord (line 126)

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

void InitialiseRecord (object $usr)
  • object $usr: The usr record from the DB.
RenderAsXML (line 257)

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
RenderPrivileges (line 239)

Returns the array of privilege names converted into XMLElements

void RenderPrivileges ( $privilege_names, [ $container = "privilege"])
  • $privilege_names
  • $container
UsernameFromEMail (line 225)

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

void UsernameFromEMail (string $email)
  • string $email: The email address to be used.
UsernameFromPath (line 185)

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.

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