Class DAVResource

Description

A class for things to do with a DAV Resource

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


	
			
Direct descendents
Class Description
 class WritableCollection A class for things to do with a DAV Resource
Variable Summary
Method Summary
 DAVResource __construct ([mixed $parameters = null])
 void bound_from ()
 void BuildACE ( &$xmldoc,  $privs,  $principal)
 void BuildPrivileges ([ $privilege_names = null], [ &$xmldoc = null])
 void BuildSupportedReports ( &$reply)
 XMLTreeFragment BuildTicketinfo ( &$reply, &XMLDocument $reply)
 void collection_id ()
 void ContainerExists ()
 void ContainerType ()
 void dav_name ()
 void Exists ()
 void FetchCollection ()
 void FetchPrincipal ()
 void FetchPrivileges ()
 void FetchResource ()
 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 IsExternal ()
 void IsLocked ([ $depth = 0])
 void IsPrincipal ()
 void IsPublic ()
 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 63)
  • var: canonical name which this resource exists at
  • access: protected
The $contenttype (line 58)
  • var: type of the content
  • access: protected
The $dav_name (line 28)
  • var: partial URL of the resource within our namespace, which this resource is being retrieved as
  • access: protected
Boolean: $exists (line 33)
  • var: does the resource actually exist yet?
  • access: protected
The $parent (line 48)
  • var: parent of the resource, which will always be a collection
  • access: protected
The $resource (line 43)
  • var: actual resource content, if it exists and is not a collection
  • access: protected
The $resourcetypes (line 53)
  • var: types of the resource, possibly multiple
  • access: protected
The $unique_tag (line 38)
  • var: unique etag associated with the current version of the resource
  • access: protected
Methods
Constructor __construct (line 146)

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

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

void bound_from ()
BuildACE (line 1284)

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

void BuildACE ( &$xmldoc,  $privs,  $principal)
  • &$xmldoc
  • $privs
  • $principal
BuildPrivileges (line 762)

Returns the array of privilege names converted into XMLElements

void BuildPrivileges ([ $privilege_names = null], [ &$xmldoc = null])
  • $privilege_names
  • &$xmldoc
BuildSupportedMethods (line 851)

Returns the array of supported methods converted into XMLElements

void BuildSupportedMethods ()
BuildSupportedReports (line 903)

Returns the array of supported reports converted into XMLElements

void BuildSupportedReports ( &$reply)
  • &$reply
BuildTicketinfo (line 964)

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

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

void collection_id ()
ContainerExists (line 1106)

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

void ContainerExists ()
ContainerType (line 1250)

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

void ContainerType ()
DAV_AllProperties (line 1413)

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

void DAV_AllProperties ()
dav_name (line 1129)

Returns the dav_name of the resource in our internal namespace

void dav_name ()
Exists (line 1088)

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

void Exists ()
FetchCollection (line 470)

Find the collection associated with this resource.

  • access: protected
void FetchCollection ()
FetchDeadProperties (line 609)

Fetch any dead properties for this URL

  • access: protected
void FetchDeadProperties ()
FetchParentContainer (line 704)

Fetch the parent to this resource.

void FetchParentContainer ()
FetchPrincipal (line 557)

Find the principal associated with this resource.

  • access: protected
void FetchPrincipal ()
FetchPrivileges (line 627)

Build permissions for this URL

  • access: protected
void FetchPrivileges ()
FetchResource (line 580)

Retrieve the actual resource.

  • access: protected
void FetchResource ()
FetchSupportedMethods (line 774)

Returns the array of supported methods

void FetchSupportedMethods ()
FetchSupportedReports (line 865)

Returns the array of supported reports

void FetchSupportedReports ()
FetchTickets (line 919)

Fetches an array of the access_ticket records applying to this path

void FetchTickets ()
FromPath (line 301)

Initialise from a path

void FromPath (object $inpath)
  • object $inpath: The path to populate the resource data from
FromRow (line 187)

Initialise from a database row

void FromRow (object $row)
  • object $row: The row from the DB.
GetACL (line 1305)

Return ACL settings

void GetACL ( &$xmldoc)
  • &$xmldoc
GetParentContainer (line 685)

Get a DAVResource which is the parent to this resource.

void GetParentContainer ()
GetProperty (line 1337)

Return general server-related properties, in plain form

void GetProperty ( $name)
  • $name
GetPropStat (line 1724)

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

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

Checks whether this resource is an addressbook

void IsAddressbook ()
IsBinding (line 1072)

Checks whether this resource is a bind to another resource

void IsBinding ()
IsCalendar (line 1044)

Checks whether this resource is a calendar

void IsCalendar ()
IsCollection (line 1028)

Checks whether this resource is a collection

void IsCollection ()
IsExternal (line 1080)

Checks whether this resource is a bind to an external resource

void IsExternal ()
IsLocked (line 996)

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

Checks whether this resource is a principal

void IsPrincipal ()
IsPublic (line 1242)

Checks whether the target collection is publicly_readable

void IsPublic ()
IsSchedulingCollection (line 1053)

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

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

Returns the dav_name of the resource in our internal namespace

void parent_path ()
principal_url (line 1175)

Returns the principal-URL for this resource

void principal_url ()
Privileges (line 713)

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

void Privileges ()
RenderAsXML (line 1782)

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

Returns the database row for this resource

void resource ()
ResourceProperty (line 1432)

Return general server-related properties for this URL

void ResourceProperty ( $tag,  $prop,  &$reply,  &$denied)
  • $tag
  • $prop
  • &$reply
  • &$denied
resource_id (line 1228)

Returns the definitive resource_id for this resource - usually a dav_id

void resource_id ()
set_bind_location (line 1147)

Sets the dav_name of the resource we are bound as

void set_bind_location ( $new_dav_name)
  • $new_dav_name
unique_tag (line 1211)

Returns the unique_tag (ETag or getctag) for this resource

void unique_tag ()
url (line 1118)

Returns the URL of our resource

void url ()
user_no (line 1184)

Returns the internal user_no for the principal for this resource

void user_no ()

Documentation generated on Mon, 24 Oct 2011 20:09:27 +1300 by phpDocumentor 1.4.3