mixed $collection_id (line 60)

The ID of the collection containing this path, or of this path if it is a collection

mixed $depth (line 45)

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 $raw_post (line 34)

The raw data sent along with the request

Constructor CalDAVRequest (line 70)

Create a new CalDAVRequest object.

• $options

DepthRegexTail (line 377)

Returns the tail of a Regex appropriate for this Depth, when appended to

FailIfLocked (line 456)

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.

• return: false (no lock) or opaquelocktoken (opened lock)

GetLockDetails (line 442)

Returns the DB object associated with a lock token, or false.

• string $lock_token: The opaquelocktoken which we are looking for

IsCollection (line 491)

Returns true if the URL referenced by this request points at a collection.

IsLocked (line 336)

Checks whether the resource is locked, returning any lock token, or false

FIXME: This logic does not catch all locking scenarios. For example an infinite depth request should check the permissions for all collections and resources within that. At present we only maintain permissions on a per-collection basis though.

• string $dav_name: The resource which we want to know the lock status for

setPermissions (line 285)

Permissions are controlled as follows:

1. if the path is '/', the request has read privileges
2. if the requester is an admin, the request has read/write priviliges
3. if there is a <user name> component which matches the logged on user then the request has read/write privileges
4. otherwise we query the defined relationships between users and use the minimum privileges returned from that analysis.

• int $user_no: The current user number

UnsupportedRequest (line 575)

Sometimes it's a perfectly formed request, but we just don't do that :-(

• array $unsupported: An array of the properties we don't support.

ValidateLockToken (line 414)

Checks to see whether the lock token given matches one of the ones handed in with the request.

• string $lock_token: The opaquelocktoken which we are looking for