nik/davical
1
0
Fork 0
mirror of https://gitlab.com/davical-project/davical.git synced 2026-01-27 00:33:34 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
davical/docs/api/davical/Resource/DAVResource.html
Andrew McMillan f644238be2 Release 0.9.8.2
2010-02-23 23:28:21 +13:00

1376 lines
48 KiB
HTML
Raw Blame History

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class DAVResource</title>
<link rel="stylesheet" href="../../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="class-name"><img src="../../media/images/Class_logo.png"
alt=" Class"
title=" Class"
style="vertical-align: middle"> DAVResource</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">A class for things to do with a DAV Resource</p>
<p class="notes">
Located in <a class="field" href="_inc---DAVResource.php.html">/inc/DAVResource.php</a> (line <span class="field">20</span>)
</p>
<pre></pre>
</div>
</div>
<a name="sec-var-summary"></a>
<div class="info-box">
<div class="info-box-title">Variable Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">The</span>
<a href="#$contenttype" title="details" class="var-name">$contenttype</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">The</span>
<a href="#$dav_name" title="details" class="var-name">$dav_name</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">Boolean:</span>
<a href="#$exists" title="details" class="var-name">$exists</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">The</span>
<a href="#$resource" title="details" class="var-name">$resource</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">The</span>
<a href="#$resourcetypes" title="details" class="var-name">$resourcetypes</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">The</span>
<a href="#$unique_tag" title="details" class="var-name">$unique_tag</a>
</div>
</div>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<img src="../../media/images/Constructor.png" alt=" "/>
<span class="method-result">DAVResource</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$parameters</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#BuildACE" title="details" class="method-name">BuildACE</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$xmldoc</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$privs</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$principal</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#BuildPrivileges" title="details" class="method-name">BuildPrivileges</a>
([<span class="var-type"></span>&nbsp;<span class="var-name">$privilege_names</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">&$xmldoc</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#BuildSupportedMethods" title="details" class="method-name">BuildSupportedMethods</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#BuildSupportedReports" title="details" class="method-name">BuildSupportedReports</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$reply</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#ContainerType" title="details" class="method-name">ContainerType</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#DAV_AllProperties" title="details" class="method-name">DAV_AllProperties</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#dav_name" title="details" class="method-name">dav_name</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#Exists" title="details" class="method-name">Exists</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#FetchCollection" title="details" class="method-name">FetchCollection</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#FetchDeadProperties" title="details" class="method-name">FetchDeadProperties</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#FetchPrincipal" title="details" class="method-name">FetchPrincipal</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#FetchPrivileges" title="details" class="method-name">FetchPrivileges</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#FetchResource" title="details" class="method-name">FetchResource</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#FetchSupportedMethods" title="details" class="method-name">FetchSupportedMethods</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#FetchSupportedReports" title="details" class="method-name">FetchSupportedReports</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#FromPath" title="details" class="method-name">FromPath</a>
(<span class="var-type">object</span>&nbsp;<span class="var-name">$inpath</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#FromRow" title="details" class="method-name">FromRow</a>
(<span class="var-type">object</span>&nbsp;<span class="var-name">$row</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#GetACL" title="details" class="method-name">GetACL</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$xmldoc</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#GetProperty" title="details" class="method-name">GetProperty</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">string</span>
<a href="#GetPropStat" title="details" class="method-name">GetPropStat</a>
(<span class="var-type">array</span>&nbsp;<span class="var-name">$properties</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$reply</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$props_only</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#HavePrivilegeTo" title="details" class="method-name">HavePrivilegeTo</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$do_what</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#IsAddressbook" title="details" class="method-name">IsAddressbook</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#IsCalendar" title="details" class="method-name">IsCalendar</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#IsCollection" title="details" class="method-name">IsCollection</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#IsLocked" title="details" class="method-name">IsLocked</a>
([<span class="var-type"></span>&nbsp;<span class="var-name">$depth</span> = <span class="var-default">0</span>])
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#IsPrincipal" title="details" class="method-name">IsPrincipal</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#IsPublic" title="details" class="method-name">IsPublic</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#IsSchedulingCollection" title="details" class="method-name">IsSchedulingCollection</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">'any'</span>])
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#NeedPrivilege" title="details" class="method-name">NeedPrivilege</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$privilege</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#principal_url" title="details" class="method-name">principal_url</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#Privileges" title="details" class="method-name">Privileges</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">string</span>
<a href="#RenderAsXML" title="details" class="method-name">RenderAsXML</a>
(<span class="var-type">array</span>&nbsp;<span class="var-name">$properties</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$reply</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$props_only</span> = <span class="var-default">false</span>], <span class="var-type">reference</span>&nbsp;<span class="var-name">$reply</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#ResourceProperty" title="details" class="method-name">ResourceProperty</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$tag</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$prop</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$reply</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$denied</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#unique_tag" title="details" class="method-name">unique_tag</a>
()
</div>
</div>
</div>
</div>
<a name="sec-vars"></a>
<div class="info-box">
<div class="info-box-title">Variables</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<a name="var$contenttype" id="$contenttype"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<img src="../../media/images/Variable.png" />
<span class="var-title">
<span class="var-type">The</span>
<span class="var-name">$contenttype</span>
(line <span class="line-number">50</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">var:</span> type of the content</li>
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$dav_name" id="$dav_name"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<img src="../../media/images/Variable.png" />
<span class="var-title">
<span class="var-type">The</span>
<span class="var-name">$dav_name</span>
(line <span class="line-number">25</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">var:</span> partial URL of the resource within our namespace</li>
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$exists" id="$exists"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<img src="../../media/images/Variable.png" />
<span class="var-title">
<span class="var-type">Boolean:</span>
<span class="var-name">$exists</span>
(line <span class="line-number">30</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">var:</span> does the resource actually exist yet?</li>
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$resource" id="$resource"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<img src="../../media/images/Variable.png" />
<span class="var-title">
<span class="var-type">The</span>
<span class="var-name">$resource</span>
(line <span class="line-number">40</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">var:</span> actual resource content, if it exists and is not a collection</li>
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$resourcetypes" id="$resourcetypes"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<img src="../../media/images/Variable.png" />
<span class="var-title">
<span class="var-type">The</span>
<span class="var-name">$resourcetypes</span>
(line <span class="line-number">45</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">var:</span> types of the resource, possibly multiple</li>
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$unique_tag" id="$unique_tag"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<img src="../../media/images/Variable.png" />
<span class="var-title">
<span class="var-type">The</span>
<span class="var-name">$unique_tag</span>
(line <span class="line-number">35</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">var:</span> unique etag associated with the current version of the resource</li>
<li><span class="field">access:</span> protected</li>
</ul>
</div>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Constructor.png" />
<span class="method-title">Constructor __construct</span> (line <span class="line-number">118</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
<div class="method-signature">
<span class="method-result">DAVResource</span>
<span class="method-name">
__construct
</span>
([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$parameters</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">mixed</span>
<span class="var-name">$parameters</span><span class="var-description">: If null, an empty Resourced is created. If it is an object then it is expected to be a record that was read elsewhere.</span> </li>
</ul>
</div>
<a name="methodBuildACE" id="BuildACE"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">BuildACE</span> (line <span class="line-number">857</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">BuildACE - construct an XMLElement subtree for a DAV::ace</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
BuildACE
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$xmldoc</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$privs</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$principal</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">&$xmldoc</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$privs</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$principal</span> </li>
</ul>
</div>
<a name="methodBuildPrivileges" id="BuildPrivileges"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">BuildPrivileges</span> (line <span class="line-number">530</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the array of privilege names converted into XMLElements</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
BuildPrivileges
</span>
([<span class="var-type"></span>&nbsp;<span class="var-name">$privilege_names</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">&$xmldoc</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$privilege_names</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">&$xmldoc</span> </li>
</ul>
</div>
<a name="methodBuildSupportedMethods" id="BuildSupportedMethods"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">BuildSupportedMethods</span> (line <span class="line-number">623</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the array of supported methods converted into XMLElements</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
BuildSupportedMethods
</span>
()
</div>
</div>
<a name="methodBuildSupportedReports" id="BuildSupportedReports"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">BuildSupportedReports</span> (line <span class="line-number">666</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the array of supported reports converted into XMLElements</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
BuildSupportedReports
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$reply</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">&$reply</span> </li>
</ul>
</div>
<a name="methodContainerType" id="ContainerType"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">ContainerType</span> (line <span class="line-number">823</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the type of whatever contains this resource, or would if it existed.</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
ContainerType
</span>
()
</div>
</div>
<a name="methodDAV_AllProperties" id="DAV_AllProperties"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">DAV_AllProperties</span> (line <span class="line-number">954</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return an array which is an expansion of the DAV::allprop</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
DAV_AllProperties
</span>
()
</div>
</div>
<a name="methoddav_name" id="dav_name"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">dav_name</span> (line <span class="line-number">780</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the dav_name of the resource in our internal namespace</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
dav_name
</span>
()
</div>
</div>
<a name="methodExists" id="Exists"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">Exists</span> (line <span class="line-number">762</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks whether this resource actually exists, in the virtual sense, within the hierarchy</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
Exists
</span>
()
</div>
</div>
<a name="methodFetchCollection" id="FetchCollection"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">FetchCollection</span> (line <span class="line-number">257</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Find the collection associated with this resource.</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
FetchCollection
</span>
()
</div>
</div>
<a name="methodFetchDeadProperties" id="FetchDeadProperties"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">FetchDeadProperties</span> (line <span class="line-number">437</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Fetch any dead properties for this URL</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
FetchDeadProperties
</span>
()
</div>
</div>
<a name="methodFetchPrincipal" id="FetchPrincipal"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">FetchPrincipal</span> (line <span class="line-number">388</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Find the principal associated with this resource.</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
FetchPrincipal
</span>
()
</div>
</div>
<a name="methodFetchPrivileges" id="FetchPrivileges"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">FetchPrivileges</span> (line <span class="line-number">453</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Build permissions for this URL</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
FetchPrivileges
</span>
()
</div>
</div>
<a name="methodFetchResource" id="FetchResource"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">FetchResource</span> (line <span class="line-number">405</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Retrieve the actual resource.</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
FetchResource
</span>
()
</div>
</div>
<a name="methodFetchSupportedMethods" id="FetchSupportedMethods"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">FetchSupportedMethods</span> (line <span class="line-number">553</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the array of supported methods</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
FetchSupportedMethods
</span>
()
</div>
</div>
<a name="methodFetchSupportedReports" id="FetchSupportedReports"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">FetchSupportedReports</span> (line <span class="line-number">637</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the array of supported reports</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
FetchSupportedReports
</span>
()
</div>
</div>
<a name="methodFromPath" id="FromPath"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">FromPath</span> (line <span class="line-number">237</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Initialise from a path</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
FromPath
</span>
(<span class="var-type">object</span>&nbsp;<span class="var-name">$inpath</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">object</span>
<span class="var-name">$inpath</span><span class="var-description">: The path to populate the resource data from</span> </li>
</ul>
</div>
<a name="methodFromRow" id="FromRow"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">FromRow</span> (line <span class="line-number">155</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Initialise from a database row</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
FromRow
</span>
(<span class="var-type">object</span>&nbsp;<span class="var-name">$row</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">object</span>
<span class="var-name">$row</span><span class="var-description">: The row from the DB.</span> </li>
</ul>
</div>
<a name="methodGetACL" id="GetACL"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">GetACL</span> (line <span class="line-number">878</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return ACL settings</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
GetACL
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$xmldoc</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">&$xmldoc</span> </li>
</ul>
</div>
<a name="methodGetProperty" id="GetProperty"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">GetProperty</span> (line <span class="line-number">909</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return general server-related properties, in plain form</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
GetProperty
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$name</span> </li>
</ul>
</div>
<a name="methodGetPropStat" id="GetPropStat"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">GetPropStat</span> (line <span class="line-number">1192</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Construct XML propstat fragment for this resource</p>
<ul class="tags">
<li><span class="field">return:</span> An XML fragment with the requested properties for this resource</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
GetPropStat
</span>
(<span class="var-type">array</span>&nbsp;<span class="var-name">$properties</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$reply</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$props_only</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">array</span>
<span class="var-name">$properties</span><span class="var-description">: of string $properties The requested properties for this resource</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">&$reply</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$props_only</span> </li>
</ul>
</div>
<a name="methodHavePrivilegeTo" id="HavePrivilegeTo"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">HavePrivilegeTo</span> (line <span class="line-number">504</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Is the user has the privileges to do what is requested.</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
HavePrivilegeTo
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$do_what</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$do_what</span> </li>
</ul>
</div>
<a name="methodIsAddressbook" id="IsAddressbook"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">IsAddressbook</span> (line <span class="line-number">754</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks whether this resource is an addressbook</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
IsAddressbook
</span>
()
</div>
</div>
<a name="methodIsCalendar" id="IsCalendar"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">IsCalendar</span> (line <span class="line-number">734</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks whether this resource is a calendar</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
IsCalendar
</span>
()
</div>
</div>
<a name="methodIsCollection" id="IsCollection"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">IsCollection</span> (line <span class="line-number">718</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks whether this resource is a collection</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
IsCollection
</span>
()
</div>
</div>
<a name="methodIsLocked" id="IsLocked"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">IsLocked</span> (line <span class="line-number">686</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks whether the resource is locked, returning any lock token, or false</p>
<ul class="tags">
<li><span class="field">todo:</span> 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.</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
IsLocked
</span>
([<span class="var-type"></span>&nbsp;<span class="var-name">$depth</span> = <span class="var-default">0</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$depth</span> </li>
</ul>
</div>
<a name="methodIsPrincipal" id="IsPrincipal"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">IsPrincipal</span> (line <span class="line-number">726</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks whether this resource is a principal</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
IsPrincipal
</span>
()
</div>
</div>
<a name="methodIsPublic" id="IsPublic"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">IsPublic</span> (line <span class="line-number">815</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks whether the target collection is publicly_readable</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
IsPublic
</span>
()
</div>
</div>
<a name="methodIsSchedulingCollection" id="IsSchedulingCollection"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">IsSchedulingCollection</span> (line <span class="line-number">743</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks whether this resource is a calendar</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
IsSchedulingCollection
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">'any'</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$type</span><span class="var-description">: The type of scheduling collection, 'read', 'write' or 'any'</span> </li>
</ul>
</div>
<a name="methodNeedPrivilege" id="NeedPrivilege"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">NeedPrivilege</span> (line <span class="line-number">517</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Check if we have the needed privilege or send an error response.</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
NeedPrivilege
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$privilege</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$privilege</span><span class="var-description">: The name of the needed privilege.</span> </li>
</ul>
</div>
<a name="methodprincipal_url" id="principal_url"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">principal_url</span> (line <span class="line-number">789</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the principal-URL for this resource</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
principal_url
</span>
()
</div>
</div>
<a name="methodPrivileges" id="Privileges"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">Privileges</span> (line <span class="line-number">495</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the privileges bits for the current session user to this resource</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
Privileges
</span>
()
</div>
</div>
<a name="methodRenderAsXML" id="RenderAsXML"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">RenderAsXML</span> (line <span class="line-number">1251</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Render XML for this resource</p>
<ul class="tags">
<li><span class="field">return:</span> An XML fragment with the requested properties for this principal</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
RenderAsXML
</span>
(<span class="var-type">array</span>&nbsp;<span class="var-name">$properties</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$reply</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$props_only</span> = <span class="var-default">false</span>], <span class="var-type">reference</span>&nbsp;<span class="var-name">$reply</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">array</span>
<span class="var-name">$properties</span><span class="var-description">: The requested properties for this principal</span> </li>
<li>
<span class="var-type">reference</span>
<span class="var-name">$reply</span><span class="var-description">: A reference to the XMLDocument being used for the reply</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$props_only</span><span class="var-description">: Default false. If true will only return the fragment with the properties, not a full response fragment.</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">&$reply</span> </li>
</ul>
</div>
<a name="methodResourceProperty" id="ResourceProperty"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">ResourceProperty</span> (line <span class="line-number">971</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return general server-related properties for this URL</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
ResourceProperty
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$tag</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$prop</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$reply</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$denied</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$tag</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$prop</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">&$reply</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">&$denied</span> </li>
</ul>
</div>
<a name="methodunique_tag" id="unique_tag"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">unique_tag</span> (line <span class="line-number">801</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the principal-URL for this resource</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
unique_tag
</span>
()
</div>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Tue, 23 Feb 2010 23:26:36 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
</p>
</div></body>
</html>
Reference in New Issue View Git Blame Copy Permalink