CalDAVRequestA class for collecting things to do with this request.
Located in /inc/CalDAVRequest.php (line 29)
void
DoResponse
(int $status, [string $message = ""], [ $content_type = "text/plain; charset=\"utf-8\""])
void
PreconditionFailed
(int $status, string $precondition, [string $explanation = ''], [ $xmlns = 'DAV:'])
mixed
$collection_id
(line 69)
The ID of the collection containing this path, or of this path if it is a collection
mixed
$collection_path
(line 74)
The path corresponding to the collection_id
mixed
$collection_type
(line 80)
The type of collection being requested:
calendar, schedule-inbox, schedule-outbox
mixed
$current_user_principal_xml
(line 59)
The 'current_user_principal_xml' the DAV:current-user-principal answer. An XMLElement object with an <href> or <unauthenticated> fragment.
mixed
$depth
(line 47)
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
$destination
(line 91)
The value of any 'Destionation:' header, if present.
mixed
$exists
(line 86)
The type of collection being requested:
calendar, schedule-inbox, schedule-outbox
mixed
$method
(line 41)
The HTTP request method: PROPFIND, LOCK, REPORT, OPTIONS, etc...
mixed
$options
(line 31)
DAVPrincipal
$principal
(line 53)
The 'principal' (user/resource/...) which this request seeks to access
mixed
$privileges
(line 96)
The decimal privileges allowed by this user to the identified resource.
mixed
$raw_post
(line 36)
The raw data sent along with the request
mixed
$supported_privileges
(line 101)
A static structure of supported privileges.
mixed
$ticket
(line 106)
A DAVTicket object, if there is a ?ticket=id or Ticket: id with this request
mixed
$user_agent
(line 64)
The user agent making the request.
Constructor __construct (line 111)
Create a new CalDAVRequest object.
AllowedTo (line 1002)
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 964)
Returns the array of supported privileges converted into XMLElements
CoerceContentType (line 856)
Coerces the Content-type of the request into something valid/appropriate
CollectionId (line 956)
Returns the ID of the collection of, or containing this request
dav_name (line 722)
Returns the dav_name of the resource in our internal namespace
DepthRegexTail (line 740)
Returns the tail of a Regex appropriate for this Depth, when appended to
DoResponse (line 1179)
Utility function we call when we have a simple status-based response to return to the client. Possibly
FailIfLocked (line 821)
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 731)
Returns the name for this depth: 0, 1, infinity
GetLockDetails (line 807)
Returns the DB object associated with a lock token, or false.
GetLockRow (line 751)
Returns the locked row, either from the cache or from the database
HavePrivilegeTo (line 1075)
Is the user has the privileges to do what is requested.
IsAddressBook (line 917)
Returns true if the URL referenced by this request points at an addressbook collection.
IsCalendar (line 908)
Returns true if the URL referenced by this request points at a calendar collection.
IsCollection (line 897)
Returns true if the URL referenced by this request points at a collection.
IsInfiniteDepth (line 948)
Returns true if the request asked for infinite depth
IsLocked (line 643)
Checks whether the resource is locked, returning any lock token, or false
IsPrincipal (line 926)
Returns true if the URL referenced by this request points at a principal.
IsProxyRequest (line 937)
Returns true if the URL referenced by this request is within a proxy URL
IsPublic (line 680)
Checks whether the collection is public
MalformedRequest (line 1152)
Send a simple error informing the client that was a malformed request
NeedPrivilege (line 1111)
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 1136)
Send an error response for a failed precondition.
Privileges (line 1067)
Return the privileges bits for the current session user to this resource
setPermissions (line 575)
Permissions are controlled as follows:
UnsupportedRequest (line 1088)
Sometimes it's a perfectly formed request, but we just don't do that :-(
ValidateLockToken (line 776)
Checks to see whether the lock token given matches one of the ones handed in with the request.
XMLResponse (line 1164)
Send an XML Response. This function will never return.
Documentation generated on Fri, 13 Jan 2012 23:44:53 +1300 by phpDocumentor 1.4.3