## DAVResource

Description

A class for things to do with a DAV Resource

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

Direct descendents

Class | Description
--- | ---
WritableCollection | A class for things to do with a DAV Resource

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 collection_id ()
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 GetParentContainer ()
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 IsExternal ()
void IsInSchedulingCollection ([string $type = 'any'])
void IsLocked ([ $depth = 0])
void IsPrincipal ()
void IsPublic ()
void IsPublicOnly ()
void IsSchedulingCollection ([string $type = 'any'])
void NeedPrivilege (string $privilege, [boolean $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 ()
void url ()
void user_no ()
Variables
The $bound_from (line 64)

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

The $contenttype (line 59)

- var: type of the content
- access: protected

The $dav_name (line 29)

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

Boolean: $exists (line 34)

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

The $parent (line 49)

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

The $resource (line 44)

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

The $resourcetypes (line 54)

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

The $unique_tag (line 39)

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

Methods
Constructor __construct (line 147)

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 1161)

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

void bound_from ()
BuildACE (line 1315)

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

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

- &$xmldoc
- $privs
- $principal

BuildPrivileges (line 773)

Returns the array of privilege names converted into XMLElements

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

- $privilege_names
- &$xmldoc

BuildSupportedMethods (line 862)

Returns the array of supported methods converted into XMLElements

void BuildSupportedMethods ()
BuildSupportedReports (line 914)

Returns the array of supported reports converted into XMLElements

void BuildSupportedReports ( &$reply)

- &$reply

BuildTicketinfo (line 975)

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

collection_id (line 1216)

Returns the internal collection_id for this collection, or the collection containing this resource

void collection_id ()
ContainerExists (line 1129)

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

void ContainerExists ()
ContainerType (line 1281)

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

void ContainerType ()
DAV_AllProperties (line 1449)

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

void DAV_AllProperties ()
dav_name (line 1152)

Returns the dav_name of the resource in our internal namespace

void dav_name ()
Exists (line 1111)

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

void Exists ()
FetchCollection (line 481)

Find the collection associated with this resource.

- access: protected

void FetchCollection ()
FetchDeadProperties (line 620)

Fetch any dead properties for this URL

- access: protected

void FetchDeadProperties ()
FetchParentContainer (line 715)

Fetch the parent to this resource. This is deprecated - use GetParentContainer() instead.

void FetchParentContainer ()
FetchPrincipal (line 568)

Find the principal associated with this resource.

- access: protected

void FetchPrincipal ()
FetchPrivileges (line 638)

Build permissions for this URL

- access: protected

void FetchPrivileges ()
FetchResource (line 591)

Retrieve the actual resource.

- access: protected

void FetchResource ()
FetchSupportedMethods (line 785)

Returns the array of supported methods

void FetchSupportedMethods ()
FetchSupportedReports (line 876)

Returns the array of supported reports

void FetchSupportedReports ()
FetchTickets (line 930)

Fetches an array of the access_ticket records applying to this path

void FetchTickets ()
FromPath (line 313)

Initialise from a path

void FromPath (object $inpath)

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

FromRow (line 188)

Initialise from a database row

void FromRow (object $row)

- object $row: The row from the DB.

GetACL (line 1336)

Return ACL settings

void GetACL ( &$xmldoc)

- &$xmldoc

GetParentContainer (line 696)

Get a DAVResource which is the parent to this resource.

void GetParentContainer ()
GetProperty (line 1368)

Return general server-related properties, in plain form

void GetProperty ( $name)

- $name

GetPropStat (line 1765)

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 736)

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 1087)

Checks whether this resource is an addressbook

void IsAddressbook ()
IsBinding (line 1095)

Checks whether this resource is a bind to another resource

void IsBinding ()
IsCalendar (line 1055)

Checks whether this resource is a calendar

void IsCalendar ()
IsCollection (line 1039)

Checks whether this resource is a collection

void IsCollection ()
IsExternal (line 1103)

Checks whether this resource is a bind to an external resource

void IsExternal ()
IsInSchedulingCollection (line 1076)

Checks whether this resource is IN a scheduling inbox/outbox collection

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

- string $type: The type of scheduling collection, 'inbox', 'outbox' or 'any'

IsLocked (line 1007)

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 1047)

Checks whether this resource is a principal

void IsPrincipal ()
IsPublic (line 1265)

Checks whether the target collection is publicly_readable

void IsPublic ()
IsPublicOnly (line 1273)

Checks whether the target collection is for public events only

void IsPublicOnly ()
IsSchedulingCollection (line 1064)

Checks whether this resource is a scheduling inbox/outbox collection

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

- string $type: The type of scheduling collection, 'inbox', 'outbox' or 'any'

NeedPrivilege (line 758)

Check if we have the needed privilege or send an error response. If the user does not have the privileges then the call will not return, and an XML error document will be output.

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

- string $privilege: The name of the needed privilege.
- boolean $any: Whether we accept any of the privileges. The default is true, unless the requested privilege is 'all', when it is false.

parent_path (line 1182)

Returns the dav_name of the resource in our internal namespace

void parent_path ()
principal_url (line 1198)

Returns the principal-URL for this resource

void principal_url ()
Privileges (line 724)

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

void Privileges ()
RenderAsXML (line 1823)

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 1225)

Returns the database row for this resource

void resource ()
ResourceProperty (line 1468)

Return general server-related properties for this URL

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

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

resource_id (line 1251)

Returns the definitive resource_id for this resource - usually a dav_id

void resource_id ()
set_bind_location (line 1170)

Sets the dav_name of the resource we are bound as

void set_bind_location ( $new_dav_name)

- $new_dav_name

unique_tag (line 1234)

Returns the unique_tag (ETag or getctag) for this resource

void unique_tag ()
url (line 1141)

Returns the URL of our resource

void url ()
user_no (line 1207)

Returns the internal user_no for the principal for this resource

void user_no ()

Documentation generated on Fri, 13 Jan 2012 23:44:54 +1300 by phpDocumentor 1.4.3