## DAVResource

Description

A class for things to do with a DAV Resource

Located in /inc/DAVResource.php (line 21)

Variable Summary
The $bound_from
The $contenttype
The $dav_name
Boolean: $exists
The $parent
The $resource
The $resourcetypes
The $unique_tag
Method Summary
DAVResource __construct ([mixed $parameters = null])
void bound_from ()
void BuildACE ( &$xmldoc, $privs, $principal)
void BuildPrivileges ([ $privilege_names = null], [ &$xmldoc = null])
void BuildSupportedMethods ()
void BuildSupportedReports ( &$reply)
XMLTreeFragment BuildTicketinfo ( &$reply, &XMLDocument $reply)
void ContainerExists ()
void ContainerType ()
void DAV_AllProperties ()
void dav_name ()
void Exists ()
void FetchCollection ()
void FetchDeadProperties ()
void FetchParentContainer ()
void FetchPrincipal ()
void FetchPrivileges ()
void FetchResource ()
void FetchSupportedMethods ()
void FetchSupportedReports ()
void FetchTickets ()
void FromPath (object $inpath)
void FromRow (object $row)
void GetACL ( &$xmldoc)
void GetProperty ( $name)
string GetPropStat (array $properties, &$reply, [ $props_only = false])
boolean HavePrivilegeTo ($do_what $do_what, [$any $any = null])
void IsAddressbook ()
void IsBinding ()
void IsCalendar ()
void IsCollection ()
void IsLocked ([ $depth = 0])
void IsPrincipal ()
void IsPublic ()
void IsSchedulingCollection ([string $type = 'any'])
void NeedPrivilege (string $privilege, [ $any = null])
void parent_path ()
void principal_url ()
void Privileges ()
string RenderAsXML (array $properties, &$reply, [ $bound_parent_path = null], reference $reply)
void resource ()
void ResourceProperty ( $tag, $prop, &$reply, &$denied)
void resource_id ()
void set_bind_location ( $new_dav_name)
void unique_tag ()
Variables
The $bound_from (line 61)

- var: canonical name which this resource exists at
- access: protected

The $contenttype (line 56)

- var: type of the content
- access: protected

The $dav_name (line 26)

- var: partial URL of the resource within our namespace, which this resource is being retrieved as
- access: protected

Boolean: $exists (line 31)

- var: does the resource actually exist yet?
- access: protected

The $parent (line 46)

- var: parent of the resource, which will always be a collection
- access: protected

The $resource (line 41)

- var: actual resource content, if it exists and is not a collection
- access: protected

The $resourcetypes (line 51)

- var: types of the resource, possibly multiple
- access: protected

The $unique_tag (line 36)

- var: unique etag associated with the current version of the resource
- access: protected

Methods
Constructor __construct (line 139)

Constructor

DAVResource __construct ([mixed $parameters = null])

- mixed $parameters: If null, an empty Resourced is created. If it is an object then it is expected to be a record that was read elsewhere.

bound_from (line 1029)

Returns the dav_name of the resource we are bound to, within our internal namespace

void bound_from ()
BuildACE (line 1157)

BuildACE - construct an XMLElement subtree for a DAV::ace

void BuildACE ( &$xmldoc, $privs, $principal)

- &$xmldoc
- $privs
- $principal

BuildPrivileges (line 676)

Returns the array of privilege names converted into XMLElements

void BuildPrivileges ([ $privilege_names = null], [ &$xmldoc = null])

- $privilege_names
- &$xmldoc

BuildSupportedMethods (line 761)

Returns the array of supported methods converted into XMLElements

void BuildSupportedMethods ()
BuildSupportedReports (line 813)

Returns the array of supported reports converted into XMLElements

void BuildSupportedReports ( &$reply)

- &$reply

BuildTicketinfo (line 874)

Returns the array of tickets converted into XMLElements

If the current user does not have DAV::read-acl privilege on this resource they will only get to see the tickets where they are the owner, or which they supplied along with the request.

- return: A fragment of an XMLDocument to go in the reply

XMLTreeFragment BuildTicketinfo ( &$reply, &XMLDocument $reply)

- &XMLDocument $reply: A reference to the XMLDocument used to construct the reply
- &$reply

ContainerExists (line 1008)

Checks whether the container for this resource actually exists, in the virtual sense, within the hierarchy

void ContainerExists ()
ContainerType (line 1123)

Return the type of whatever contains this resource, or would if it existed.

void ContainerType ()
DAV_AllProperties (line 1263)

Return an array which is an expansion of the DAV::allprop

void DAV_AllProperties ()
dav_name (line 1020)

Returns the dav_name of the resource in our internal namespace

void dav_name ()
Exists (line 990)

Checks whether this resource actually exists, in the virtual sense, within the hierarchy

void Exists ()
FetchCollection (line 301)

Find the collection associated with this resource.

void FetchCollection ()
FetchDeadProperties (line 538)

Fetch any dead properties for this URL

void FetchDeadProperties ()
FetchParentContainer (line 554)

Fetch the parent to this resource.

void FetchParentContainer ()
FetchPrincipal (line 485)

Find the principal associated with this resource.

void FetchPrincipal ()
FetchPrivileges (line 573)

Build permissions for this URL

void FetchPrivileges ()
FetchResource (line 509)

Retrieve the actual resource.

void FetchResource ()
FetchSupportedMethods (line 688)

Returns the array of supported methods

void FetchSupportedMethods ()
FetchSupportedReports (line 775)

Returns the array of supported reports

void FetchSupportedReports ()
FetchTickets (line 829)

Fetches an array of the access_ticket records applying to this path

void FetchTickets ()
FromPath (line 281)

Initialise from a path

void FromPath (object $inpath)

- object $inpath: The path to populate the resource data from

FromRow (line 179)

Initialise from a database row

void FromRow (object $row)

- object $row: The row from the DB.

GetACL (line 1178)

Return ACL settings

void GetACL ( &$xmldoc)

- &$xmldoc

GetProperty (line 1209)

Return general server-related properties, in plain form

void GetProperty ( $name)

- $name

GetPropStat (line 1555)

Construct XML propstat fragment for this resource

- return: An XML fragment with the requested properties for this resource

string GetPropStat (array $properties, &$reply, [ $props_only = false])

- array $properties: of string $properties The requested properties for this resource
- &$reply
- $props_only

HavePrivilegeTo (line 643)

Is the user has the privileges to do what is requested.

- return: Whether they do have one of those privileges against this resource.

boolean HavePrivilegeTo ($do_what $do_what, [$any $any = null])

- $do_what $do_what: mixed The request privilege name, or array of privilege names, to be checked.
- $any $any: boolean Whether we accept any of the privileges. The default is true, unless the requested privilege is 'all', when it is false.

IsAddressbook (line 974)

Checks whether this resource is an addressbook

void IsAddressbook ()
IsBinding (line 982)

Checks whether this resource is a bind to another resource

void IsBinding ()
IsCalendar (line 954)

Checks whether this resource is a calendar

void IsCalendar ()
IsCollection (line 938)

Checks whether this resource is a collection

void IsCollection ()
IsLocked (line 906)

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

- todo: 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.

void IsLocked ([ $depth = 0])

- $depth

IsPrincipal (line 946)

Checks whether this resource is a principal

void IsPrincipal ()
IsPublic (line 1115)

Checks whether the target collection is publicly_readable

void IsPublic ()
IsSchedulingCollection (line 963)

Checks whether this resource is a calendar

void IsSchedulingCollection ([string $type = 'any'])

- string $type: The type of scheduling collection, 'read', 'write' or 'any'

NeedPrivilege (line 663)

Check if we have the needed privilege or send an error response.

void NeedPrivilege (string $privilege, [ $any = null])

- string $privilege: The name of the needed privilege.
- $any

parent_path (line 1050)

Returns the dav_name of the resource in our internal namespace

void parent_path ()
principal_url (line 1066)

Returns the principal-URL for this resource

void principal_url ()
Privileges (line 631)

Return the privileges bits for the current session user to this resource

void Privileges ()
RenderAsXML (line 1613)

Render XML for this resource

- return: An XML fragment with the requested properties for this principal

string RenderAsXML (array $properties, &$reply, [ $bound_parent_path = null], reference $reply)

- array $properties: The requested properties for this principal
- reference $reply: A reference to the XMLDocument being used for the reply
- &$reply
- $bound_parent_path

resource (line 1078)

Returns the database row for this resource

void resource ()
ResourceProperty (line 1282)

Return general server-related properties for this URL

void ResourceProperty ( $tag, $prop, &$reply, &$denied)

- $tag
- $prop
- &$reply
- &$denied

resource_id (line 1101)

Returns the definitive resource_id for this resource - usually a dav_id

void resource_id ()
set_bind_location (line 1038)

Sets the dav_name of the resource we are bound as

void set_bind_location ( $new_dav_name)

- $new_dav_name

unique_tag (line 1087)

Returns the unique_tag (ETag or getctag) for this resource

void unique_tag ()

Documentation generated on Sun, 26 Sep 2010 00:46:07 +1200 by phpDocumentor 1.4.3