PrincipalA class for things to do with a Principal
Located in /inc/Principal.php (line 19)
| Class | Description |
|---|---|
DAVPrincipal
|
A class for things to do with a DAV Principal |
boolean
$by_email
(line 92)
Whether this was retrieved using an e-mail address
mixed
$collections
(line 101)
mixed
$collection_id
(line 67)
mixed
$created
(line 55)
mixed
$date_format_type
(line 60)
mixed
$dav_name
(line 53)
mixed
$dead_properties
(line 102)
mixed
$default_calendar
(line 103)
mixed
$default_privileges
(line 64)
mixed
$displayname
(line 63)
mixed
$email
(line 52)
mixed
$email_ok
(line 59)
boolean
$exists
(line 76)
Whether this Principal actually exists in the database yet.
mixed
$fullname
(line 58)
mixed
$is_addressbook
(line 68)
mixed
$is_calendar
(line 66)
mixed
$is_principal
(line 65)
mixed
$locale
(line 61)
mixed
$modified
(line 56)
The
$original_request_url
(line 86)
mixed
$password
(line 57)
mixed
$principal_id
(line 51)
mixed
$privileges
(line 70)
mixed
$resourcetypes
(line 69)
mixed
$type_id
(line 62)
The
$url
(line 81)
mixed
$username
(line 49)
Columns from the database
mixed
$user_active
(line 54)
mixed
$user_no
(line 50)
static cacheDelete (line 588)
static cacheFlush (line 577)
static updateableFields (line 30)
Constructor __construct (line 122)
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)
byEmail (line 284)
Create (line 566)
dav_name (line 376)
Return the partial path representing this principal
default_calendar (line 424)
Return the default calendar for this principal
email (line 367)
Return the email
Exists (line 279)
FetchCollections (line 407)
Fetch the list of collections for this principal
FetchDeadProperties (line 390)
Ensure the principal's dead properties are loaded
internal_url (line 490)
principal_id (line 358)
Return the principal_id
setUsername (line 338)
Set the username - but only if the record does not yet exist!
unCache (line 495)
Update (line 570)
url (line 464)
Return the URL for this principal
username (line 329)
Return the username
user_no (line 349)
Return the user_no
__get (line 246)
This will allow protected properties to be referenced for retrieval, but not referenced for update.
__isset (line 256)
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 Mon, 24 Oct 2011 20:09:29 +1300 by phpDocumentor 1.4.3