DAViCal
|
Static Public Member Functions | |
static | BuildDeadPropertyXML ($property_name, $raw_string) |
Protected Member Functions | |
FetchCollection () | |
FetchPrincipal () | |
FetchResource () | |
FetchDeadProperties () | |
FetchPrivileges () | |
Protected Attributes | |
$dav_name | |
$exists | |
$unique_tag | |
$resource | |
$parent | |
$resourcetypes | |
$contenttype | |
$bound_from | |
Private Member Functions | |
ReadCollectionFromDatabase () | |
Definition at line 24 of file DAVResource.php.
DAVResource::__construct | ( | $parameters = null , |
|
DAVResource | $prefetched_collection = null |
||
) |
Constructor
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. |
object | $prefetched_collection | If provided, the internal collection field of the resource is populated with the given data, so it does not need to be queried again later |
Definition at line 176 of file DAVResource.php.
DAVResource::bound_from | ( | ) |
Returns the dav_name of the resource we are bound to, within our internal namespace
Definition at line 1287 of file DAVResource.php.
DAVResource::BuildACE | ( | & | $xmldoc, |
$privs, | |||
$principal | |||
) |
BuildACE - construct an XMLElement subtree for a DAV::ace
Definition at line 1471 of file DAVResource.php.
|
static |
FIXME: does this function return a string or an array, or either? It used to be string only, but b4fd9e2e changed successfully parsed values to array. However values not in angle brackets are passed through, and those seem to be the majority in my database?!
Definition at line 713 of file DAVResource.php.
DAVResource::BuildPrivileges | ( | $privilege_names = null , |
|
& | $xmldoc = null |
||
) |
Returns the array of privilege names converted into XMLElements
Definition at line 883 of file DAVResource.php.
DAVResource::BuildSupportedMethods | ( | ) |
Returns the array of supported methods converted into XMLElements
Definition at line 972 of file DAVResource.php.
DAVResource::BuildSupportedReports | ( | & | $reply | ) |
Returns the array of supported reports converted into XMLElements
Definition at line 1025 of file DAVResource.php.
DAVResource::BuildTicketinfo | ( | & | $reply | ) |
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.
&XMLDocument | $reply A reference to the XMLDocument used to construct the reply |
Definition at line 1086 of file DAVResource.php.
DAVResource::collection_id | ( | ) |
Returns the internal collection_id for this collection, or the collection containing this resource
Definition at line 1342 of file DAVResource.php.
DAVResource::ContainerExists | ( | ) |
Checks whether the container for this resource actually exists, in the virtual sense, within the hierarchy
Definition at line 1252 of file DAVResource.php.
DAVResource::ContainerType | ( | ) |
Return the type of whatever contains this resource, or would if it existed.
Definition at line 1437 of file DAVResource.php.
DAVResource::DAV_AllProperties | ( | ) |
Return an array which is an expansion of the DAV::allprop
Definition at line 1602 of file DAVResource.php.
DAVResource::dav_name | ( | ) |
Returns the dav_name of the resource in our internal namespace
Definition at line 1277 of file DAVResource.php.
DAVResource::Exists | ( | ) |
Checks whether this resource actually exists, in the virtual sense, within the hierarchy
Definition at line 1234 of file DAVResource.php.
|
protected |
Find the collection associated with this resource.
RFC4918, 8.3: Identifiers for collections SHOULD end in '/'
So we look for a collection which matches one of the following URLs:
Definition at line 551 of file DAVResource.php.
|
protected |
Fetch any dead properties for this URL
Definition at line 693 of file DAVResource.php.
DAVResource::FetchParentContainer | ( | ) |
Fetch the parent to this resource. This is deprecated - use GetParentContainer() instead.
Definition at line 825 of file DAVResource.php.
|
protected |
Find the principal associated with this resource.
Definition at line 643 of file DAVResource.php.
|
protected |
Build permissions for this URL
Definition at line 747 of file DAVResource.php.
|
protected |
Retrieve the actual resource.
Definition at line 666 of file DAVResource.php.
DAVResource::FetchSupportedMethods | ( | ) |
Returns the array of supported methods
Definition at line 895 of file DAVResource.php.
DAVResource::FetchSupportedReports | ( | ) |
Returns the array of supported reports
Definition at line 986 of file DAVResource.php.
DAVResource::FetchTickets | ( | ) |
Fetches an array of the access_ticket records applying to this path
Definition at line 1041 of file DAVResource.php.
DAVResource::FromPath | ( | $inpath | ) |
Initialise from a path
object | $inpath | The path to populate the resource data from |
Definition at line 359 of file DAVResource.php.
DAVResource::FromRow | ( | $row | ) |
Initialise from a database row
object | $row | The row from the DB. |
Definition at line 223 of file DAVResource.php.
DAVResource::GetACL | ( | & | $xmldoc | ) |
Return ACL settings
Definition at line 1492 of file DAVResource.php.
DAVResource::GetParentContainer | ( | ) |
Get a DAVResource which is the parent to this resource.
Definition at line 805 of file DAVResource.php.
DAVResource::GetProperty | ( | $name | ) |
Return general server-related properties, in plain form
Definition at line 1522 of file DAVResource.php.
DAVResource::GetPropStat | ( | $properties, | |
& | $reply, | ||
$props_only = false |
|||
) |
Construct XML propstat fragment for this resource
array | of string $properties The requested properties for this resource |
Definition at line 1964 of file DAVResource.php.
DAVResource::HavePrivilegeTo | ( | $do_what, | |
$any = null |
|||
) |
Does the user have the privileges to do what is requested.
$do_what | mixed The request privilege name, or array of privilege names, to be checked. |
$any | boolean Whether we accept any of the privileges. The default is true, unless the requested privilege is 'all', when it is false. |
Definition at line 846 of file DAVResource.php.
DAVResource::IsAddressbook | ( | ) |
Checks whether this resource is an addressbook
Definition at line 1210 of file DAVResource.php.
DAVResource::IsBinding | ( | ) |
Checks whether this resource is a bind to another resource
Definition at line 1218 of file DAVResource.php.
DAVResource::IsCalendar | ( | ) |
Checks whether this resource is a calendar
Definition at line 1166 of file DAVResource.php.
DAVResource::IsCollection | ( | ) |
Checks whether this resource is a collection
Definition at line 1150 of file DAVResource.php.
DAVResource::IsExternal | ( | ) |
Checks whether this resource is a bind to an external resource
Definition at line 1226 of file DAVResource.php.
DAVResource::IsInSchedulingCollection | ( | $type = 'any' | ) |
Checks whether this resource is IN a scheduling inbox/outbox collection
string | $type | The type of scheduling collection, 'inbox', 'outbox' or 'any' |
Definition at line 1199 of file DAVResource.php.
DAVResource::IsLocked | ( | $depth = 0 | ) |
Checks whether the resource is locked, returning any lock token, or false
Find the locks that might apply and load them into an array
Definition at line 1118 of file DAVResource.php.
DAVResource::IsPrincipal | ( | ) |
Checks whether this resource is a principal
Definition at line 1158 of file DAVResource.php.
DAVResource::IsProxyCollection | ( | $type = 'any' | ) |
Checks whether this resource is a proxy collection
string | $type | The type of proxy collection, 'read', 'write' or 'any' |
Definition at line 1175 of file DAVResource.php.
DAVResource::IsPublic | ( | ) |
Checks whether the target collection is publicly_readable
Definition at line 1421 of file DAVResource.php.
DAVResource::IsPublicOnly | ( | ) |
Checks whether the target collection is for public events only
Definition at line 1429 of file DAVResource.php.
DAVResource::IsSchedulingCollection | ( | $type = 'any' | ) |
Checks whether this resource is a scheduling inbox/outbox collection
string | $type | The type of scheduling collection, 'inbox', 'outbox' or 'any' |
Definition at line 1187 of file DAVResource.php.
DAVResource::NeedPrivilege | ( | $privilege, | |
$any = null |
|||
) |
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.
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. |
Definition at line 868 of file DAVResource.php.
DAVResource::parent_path | ( | ) |
Returns the dav_name of the resource in our internal namespace
Definition at line 1308 of file DAVResource.php.
DAVResource::principal_url | ( | ) |
Returns the principal-URL for this resource
Definition at line 1324 of file DAVResource.php.
DAVResource::Privileges | ( | ) |
Return the privileges bits for the current session user to this resource
Definition at line 834 of file DAVResource.php.
|
private |
Definition at line 376 of file DAVResource.php.
DAVResource::RenderAsXML | ( | $properties, | |
& | $reply, | ||
$bound_parent_path = null |
|||
) |
Render XML for this resource
array | $properties | The requested properties for this principal |
reference | $reply | A reference to the XMLDocument being used for the reply |
Definition at line 2022 of file DAVResource.php.
array An array of the component types we support on this DAVResource::resource | ( | ) |
Returns the database row for this resource
Definition at line 1360 of file DAVResource.php.
DAVResource::resource_id | ( | ) |
Returns the definitive resource_id for this resource - usually a dav_id
Definition at line 1386 of file DAVResource.php.
DAVResource::ResourceProperty | ( | $tag, | |
$prop, | |||
& | $reply, | ||
& | $denied | ||
) |
Return general server-related properties for this URL
getlastmodified is HTTP Date format: i.e. the Last-Modified header in response to a GET
creationdate is ISO8601 format
indicating the style for future expansion
Definition at line 1621 of file DAVResource.php.
DAVResource::set_bind_location | ( | $new_dav_name | ) |
Sets the dav_name of the resource we are bound as
Definition at line 1296 of file DAVResource.php.
DAVResource::sync_token | ( | $cachedOK = true | ) |
Returns the current sync_token for this collection, or the containing collection
Definition at line 1400 of file DAVResource.php.
DAVResource::timezone_name | ( | ) |
Returns the name of the timezone for this collection, or the collection containing this resource
Definition at line 1351 of file DAVResource.php.
DAVResource::unique_tag | ( | ) |
Returns the unique_tag (ETag or getctag) for this resource
Definition at line 1369 of file DAVResource.php.
DAVResource::url | ( | ) |
DAVResource::user_no | ( | ) |
Returns the internal user_no for the principal for this resource
Definition at line 1333 of file DAVResource.php.
|
private |
Definition at line 165 of file DAVResource.php.
|
private |
Definition at line 109 of file DAVResource.php.
|
private |
Definition at line 99 of file DAVResource.php.
|
private |
Definition at line 94 of file DAVResource.php.
|
private |
Definition at line 84 of file DAVResource.php.
|
private |
Definition at line 104 of file DAVResource.php.
|
private |
Definition at line 89 of file DAVResource.php.
|
private |
Definition at line 114 of file DAVResource.php.
|
private |
Definition at line 154 of file DAVResource.php.
|
protected |
Definition at line 64 of file DAVResource.php.
|
private |
Definition at line 69 of file DAVResource.php.
|
private |
Definition at line 146 of file DAVResource.php.
|
protected |
Definition at line 59 of file DAVResource.php.
|
private |
Definition at line 147 of file DAVResource.php.
|
protected |
Definition at line 29 of file DAVResource.php.
|
private |
Definition at line 134 of file DAVResource.php.
|
private |
Definition at line 148 of file DAVResource.php.
|
protected |
Definition at line 34 of file DAVResource.php.
|
private |
Definition at line 149 of file DAVResource.php.
|
protected |
Definition at line 49 of file DAVResource.php.
|
private |
Definition at line 155 of file DAVResource.php.
|
private |
Definition at line 150 of file DAVResource.php.
|
private |
Definition at line 74 of file DAVResource.php.
|
private |
Definition at line 151 of file DAVResource.php.
|
private |
Definition at line 79 of file DAVResource.php.
|
private |
Definition at line 119 of file DAVResource.php.
|
protected |
Definition at line 44 of file DAVResource.php.
|
private |
Definition at line 152 of file DAVResource.php.
|
protected |
Definition at line 54 of file DAVResource.php.
|
private |
Definition at line 139 of file DAVResource.php.
|
private |
Definition at line 124 of file DAVResource.php.
|
private |
Definition at line 129 of file DAVResource.php.
|
private |
Definition at line 156 of file DAVResource.php.
|
private |
Definition at line 144 of file DAVResource.php.
|
protected |
Definition at line 39 of file DAVResource.php.
|
private |
Definition at line 153 of file DAVResource.php.