CalDAVRequestA class for collecting things to do with this request.
Located in /inc/CalDAVRequest.php (line 28)
void
DoResponse
(int $status, [string $message = ""], [ $content_type = "text/plain; charset=\"utf-8\""])
mixed
$collection_id
(line 68)
The ID of the collection containing this path, or of this path if it is a collection
mixed
$collection_path
(line 73)
The path corresponding to the collection_id
mixed
$collection_type
(line 79)
The type of collection being requested:
calendar, schedule-inbox, schedule-outbox
mixed
$current_user_principal_xml
(line 58)
The 'current_user_principal_xml' the DAV:current-user-principal answer. An XMLElement object with an <href> or <unauthenticated> fragment.
mixed
$depth
(line 46)
The depth parameter from the request headers, coerced into a valid integer: 0, 1 or DEPTH_INFINITY which is defined above. The default is set per various RFCs.
mixed
$exists
(line 85)
The type of collection being requested:
calendar, schedule-inbox, schedule-outbox
mixed
$method
(line 40)
The HTTP request method: PROPFIND, LOCK, REPORT, OPTIONS, etc...
mixed
$options
(line 30)
CalDAVPrincipal
$principal
(line 52)
The 'principal' (user/resource/...) which this request seeks to access
mixed
$privileges
(line 90)
The decimal privileges allowed by this user to the identified resource.
mixed
$raw_post
(line 35)
The raw data sent along with the request
mixed
$supported_privileges
(line 95)
A static structure of supported privileges.
mixed
$ticket
(line 100)
A DAVTicket object, if there is a ?ticket=id or Ticket: id with this request
mixed
$user_agent
(line 63)
The user agent making the request.
Constructor __construct (line 105)
Create a new CalDAVRequest object.
AllowedTo (line 1001)
Are we allowed to do the requested activity
+------------+------------------------------------------------------+ | METHOD | PRIVILEGES | +------------+------------------------------------------------------+ | MKCALENDAR | DAV:bind | | REPORT | DAV:read or CALDAV:read-free-busy (on all referenced | | | resources) | +------------+------------------------------------------------------+
BuildSupportedPrivileges (line 963)
Returns the array of supported privileges converted into XMLElements
CoerceContentType (line 860)
Coerces the Content-type of the request into something valid/appropriate
CollectionId (line 955)
Returns the ID of the collection of, or containing this request
dav_name (line 726)
Returns the dav_name of the resource in our internal namespace
DepthRegexTail (line 744)
Returns the tail of a Regex appropriate for this Depth, when appended to
DoResponse (line 1178)
Utility function we call when we have a simple status-based response to return to the client. Possibly
FailIfLocked (line 825)
This will either (a) return false if no locks apply, or (b) return the lock_token which the request successfully included to open the lock, or: (c) respond directly to the client with the failure.
GetDepthName (line 735)
Returns the name for this depth: 0, 1, infinity
GetLockDetails (line 811)
Returns the DB object associated with a lock token, or false.
GetLockRow (line 755)
Returns the locked row, either from the cache or from the database
HavePrivilegeTo (line 1074)
Is the user has the privileges to do what is requested.
IsAddressBook (line 916)
Returns true if the URL referenced by this request points at an addressbook collection.
IsCalendar (line 907)
Returns true if the URL referenced by this request points at a calendar collection.
IsCollection (line 896)
Returns true if the URL referenced by this request points at a collection.
IsInfiniteDepth (line 947)
Returns true if the request asked for infinite depth
IsLocked (line 678)
Checks whether the resource is locked, returning any lock token, or false
IsPrincipal (line 925)
Returns true if the URL referenced by this request points at a principal.
IsProxyRequest (line 936)
Returns true if the URL referenced by this request is within a proxy URL
IsPublic (line 715)
Checks whether the collection is public
MalformedRequest (line 1151)
Send a simple error informing the client that was a malformed request
NeedPrivilege (line 1110)
Send a need-privileges error response. This function will only return if the $href is not supplied and the current user has the specified permission for the request path.
PreconditionFailed (line 1135)
Send an error response for a failed precondition.
Privileges (line 1066)
Return the privileges bits for the current session user to this resource
setPermissions (line 610)
Permissions are controlled as follows:
UnsupportedRequest (line 1087)
Sometimes it's a perfectly formed request, but we just don't do that :-(
UserFromPath (line 562)
Work out the user whose calendar we are accessing, based on elements of the path.
ValidateLockToken (line 780)
Checks to see whether the lock token given matches one of the ones handed in with the request.
XMLResponse (line 1163)
Send an XML Response. This function will never return.
Documentation generated on Tue, 28 Dec 2010 02:16:03 +1300 by phpDocumentor 1.4.3