A class for things to do with a Principal
Located in /inc/Principal.php (line 19)
Class | Description |
---|---|
![]() |
A class for things to do with a DAV Principal |
Whether this was retrieved using an e-mail address
Whether this Principal actually exists in the database yet.
Columns from the database
Construct a new Principal object. The principal record will be retrieved from the database, or (if not found) initialised to a new record. You can test for whether the Principal exists by calling the Exists() method on the returned object.
Depending on the supplied $type, the following behaviour will occur: path: Will attempt to extract a username or email from the supplied path, and then do what those do. dav_name: Expects the dav_name of a <em>principal</em>, exactly, like: /principal/ and will use that as for username. user_no: Expects an integer which is the usr.user_no (deprecated) principal_id: Expects an integer which is the principal.principal_id email: Will try and retrieve a unique principal by using the email address. Will fail (subsequent call to Exists() will be false) if there is not a unique match. username: Will retrieve based on strtolower($value) = lower(usr.username)
Return the partial path representing this principal
Return the default calendar for this principal
Return the email
Fetch the list of collections for this principal
Ensure the principal's dead properties are loaded
Return the principal_id
Set the username - but only if the record does not yet exist!
Return the URL for this principal
Return the username
Return the user_no
This will allow protected properties to be referenced for retrieval, but not referenced for update.
This will allow protected properties to be examined for whether they are set without making them writable. PHP 5.1 or later only.
Documentation generated on Fri, 13 Jan 2012 23:44:56 +1300 by phpDocumentor 1.4.3