mirror of
https://gitlab.com/davical-project/davical.git
synced 2026-01-28 00:43:37 +00:00
2053 lines
108 KiB
HTML
2053 lines
108 KiB
HTML
<?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></title>
|
|
<link rel="stylesheet" href="media/stylesheet.css" />
|
|
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
|
</head>
|
|
<body>
|
|
|
|
<a name="top"></a>
|
|
<h2>Full index</h2>
|
|
<h3>Package indexes</h3>
|
|
<ul>
|
|
<li><a href="elementindex_davical.html">davical</a></li>
|
|
<li><a href="elementindex_awl.html">awl</a></li>
|
|
</ul>
|
|
<br />
|
|
<div class="index-letter-menu">
|
|
<a class="index-letter" href="elementindex.html#a">a</a>
|
|
<a class="index-letter" href="elementindex.html#b">b</a>
|
|
<a class="index-letter" href="elementindex.html#c">c</a>
|
|
<a class="index-letter" href="elementindex.html#d">d</a>
|
|
<a class="index-letter" href="elementindex.html#e">e</a>
|
|
<a class="index-letter" href="elementindex.html#f">f</a>
|
|
<a class="index-letter" href="elementindex.html#g">g</a>
|
|
<a class="index-letter" href="elementindex.html#h">h</a>
|
|
<a class="index-letter" href="elementindex.html#i">i</a>
|
|
<a class="index-letter" href="elementindex.html#l">l</a>
|
|
<a class="index-letter" href="elementindex.html#m">m</a>
|
|
<a class="index-letter" href="elementindex.html#o">o</a>
|
|
<a class="index-letter" href="elementindex.html#p">p</a>
|
|
<a class="index-letter" href="elementindex.html#r">r</a>
|
|
<a class="index-letter" href="elementindex.html#s">s</a>
|
|
<a class="index-letter" href="elementindex.html#t">t</a>
|
|
<a class="index-letter" href="elementindex.html#u">u</a>
|
|
<a class="index-letter" href="elementindex.html#v">v</a>
|
|
<a class="index-letter" href="elementindex.html#w">w</a>
|
|
<a class="index-letter" href="elementindex.html#x">x</a>
|
|
<a class="index-letter" href="elementindex.html#_">_</a>
|
|
</div>
|
|
|
|
<a name="a"></a>
|
|
<div class="index-letter-section">
|
|
<div style="float: left" class="index-letter-title">a</div>
|
|
<div style="float: right"><a href="#top">top</a></div>
|
|
<div style="clear: both"></div>
|
|
</div>
|
|
<dl>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">AddDays</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/iCalDate.html#methodAddDays">iCalDate::AddDays()</a> in RRule.php</div>
|
|
<div class="index-item-description">Add some integer number of days to a date</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">AddDuration</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/iCalDate.html#methodAddDuration">iCalDate::AddDuration()</a> in RRule.php</div>
|
|
<div class="index-item-description">Add duration</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">AddMonths</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/iCalDate.html#methodAddMonths">iCalDate::AddMonths()</a> in RRule.php</div>
|
|
<div class="index-item-description">Add some number of months to a date</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">add_arbitrary_properties</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/propfind/_inc---caldav-PROPFIND.php.html#functionadd_arbitrary_properties">add_arbitrary_properties()</a> in caldav-PROPFIND.php</div>
|
|
<div class="index-item-description">Adds any arbitrary properties that were requested by the PROPFIND into the response.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">add_general_properties</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/propfind/_inc---caldav-PROPFIND.php.html#functionadd_general_properties">add_general_properties()</a> in caldav-PROPFIND.php</div>
|
|
<div class="index-item-description">Handles any properties related to the DAV::PRINCIPAL in the request</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">add_principal_properties</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/propfind/_inc---caldav-PROPFIND.php.html#functionadd_principal_properties">add_principal_properties()</a> in caldav-PROPFIND.php</div>
|
|
<div class="index-item-description">Handles any properties related to the DAV::PRINCIPAL in the request</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">AllowedTo</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RSCDSUser/RSCDSUser.html#methodAllowedTo">RSCDSUser::AllowedTo()</a> in RSCDSUser.php</div>
|
|
<div class="index-item-description">Extend parent definition of what the current user is allowed to do</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">AllowedTo</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/HTTPAuthSession/HTTPAuthSession.html#methodAllowedTo">HTTPAuthSession::AllowedTo()</a> in HTTPAuthSession.php</div>
|
|
<div class="index-item-description">Checks whether a user is allowed to do something.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">AllowedTo</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/CalDAVRequest.html#methodAllowedTo">CalDAVRequest::AllowedTo()</a> in CalDAVRequest.php</div>
|
|
<div class="index-item-description">Are we allowed to do the requested activity</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">ApplyBySetPos</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/iCalDate.html#methodApplyBySetPos">iCalDate::ApplyBySetPos()</a> in RRule.php</div>
|
|
<div class="index-item-description">Given set position descriptions like '1', '3', '11', '-3' or '-1' and a set, return the subset matching the list of set positions.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">apply_filter</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_inc---caldav-REPORT-calquery.php.html#functionapply_filter">apply_filter()</a> in caldav-REPORT-calquery.php</div>
|
|
<div class="index-item-description">While we can construct our SQL to apply some filters in the query, other filters need to be checked against the retrieved record. This is for handling those ones.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">AssignSessionDetails</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RSCDSSession/RSCDSSession.html#methodAssignSessionDetails">RSCDSSession::AssignSessionDetails()</a> in RSCDSSession.php</div>
|
|
<div class="index-item-description">Internal function used to assign the session details to a user's new session.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">AssignSessionDetails</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/HTTPAuthSession/HTTPAuthSession.html#methodAssignSessionDetails">HTTPAuthSession::AssignSessionDetails()</a> in HTTPAuthSession.php</div>
|
|
<div class="index-item-description">Internal function used to assign the session details to a user's new session.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">AuthExternalAWL</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/authentication/_inc---auth-functions.php.html#functionAuthExternalAWL">AuthExternalAWL()</a> in auth-functions.php</div>
|
|
<div class="index-item-description">Authenticate against a different PostgreSQL database which contains a usr table in the AWL format.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">AuthFailedResponse</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/HTTPAuthSession/HTTPAuthSession.html#methodAuthFailedResponse">HTTPAuthSession::AuthFailedResponse()</a> in HTTPAuthSession.php</div>
|
|
<div class="index-item-description">Authorisation failed, so we send some headers to say so.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">always.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_inc---always.php.html">always.php</a> in always.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">auth-functions.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/authentication/_inc---auth-functions.php.html">auth-functions.php</a> in auth-functions.php</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="b"></a>
|
|
<div class="index-letter-section">
|
|
<div style="float: left" class="index-letter-title">b</div>
|
|
<div style="float: right"><a href="#top">top</a></div>
|
|
<div style="clear: both"></div>
|
|
</div>
|
|
<dl>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$base_url</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/CalDAVClient.html#var$base_url">CalDAVClient::$base_url</a> in caldav-client.php</div>
|
|
<div class="index-item-description">Server, username, password, calendar, $entry</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$body</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/CalDAVClient.html#var$body">CalDAVClient::$body</a> in caldav-client.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$by_email</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Principal/CalDAVPrincipal.html#var$by_email">CalDAVPrincipal::$by_email</a> in CalDAVPrincipal.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">BasicAuthSession</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/HTTPAuthSession/HTTPAuthSession.html#methodBasicAuthSession">HTTPAuthSession::BasicAuthSession()</a> in HTTPAuthSession.php</div>
|
|
<div class="index-item-description">Handle Basic HTTP Authentication (not secure unless https)</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">BuildSqlFilter</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_inc---caldav-REPORT-calquery.php.html#functionBuildSqlFilter">BuildSqlFilter()</a> in caldav-REPORT-calquery.php</div>
|
|
<div class="index-item-description">Build an SQL 'WHERE' clause which implements (parts of) the filter. The elements of the filter which are implemented in the SQL will be removed.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">build_propstat_response</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/propfind/_inc---caldav-PROPFIND.php.html#functionbuild_propstat_response">build_propstat_response()</a> in caldav-PROPFIND.php</div>
|
|
<div class="index-item-description">Build the <propstat><prop></prop><status></status></propstat> part of the response</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="c"></a>
|
|
<div class="index-letter-section">
|
|
<div style="float: left" class="index-letter-title">c</div>
|
|
<div style="float: right"><a href="#top">top</a></div>
|
|
<div style="clear: both"></div>
|
|
</div>
|
|
<dl>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$calendar</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/CalDAVClient.html#var$calendar">CalDAVClient::$calendar</a> in caldav-client.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$calendar_home_set</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Principal/CalDAVPrincipal.html#var$calendar_home_set">CalDAVPrincipal::$calendar_home_set</a> in CalDAVPrincipal.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$collection_id</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/CalDAVRequest.html#var$collection_id">CalDAVRequest::$collection_id</a> in CalDAVRequest.php</div>
|
|
<div class="index-item-description">The ID of the collection containing this path, or of this path if it is a collection</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$collection_path</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/CalDAVRequest.html#var$collection_path">CalDAVRequest::$collection_path</a> in CalDAVRequest.php</div>
|
|
<div class="index-item-description">The path corresponding to the collection_id</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$collection_type</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/CalDAVRequest.html#var$collection_type">CalDAVRequest::$collection_type</a> in CalDAVRequest.php</div>
|
|
<div class="index-item-description">The type of collection being requested:</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$curl</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/CalDAVClient.html#var$curl">CalDAVClient::$curl</a> in caldav-client.php</div>
|
|
<div class="index-item-description">Our cURL connection</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$current_user_principal_xml</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/CalDAVRequest.html#var$current_user_principal_xml">CalDAVRequest::$current_user_principal_xml</a> in CalDAVRequest.php</div>
|
|
<div class="index-item-description">The 'current_user_principal_xml' the DAV:current-user-principal answer. An XMLElement object with an <href> or <unauthenticated> fragment.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Constructor.png" alt="Method" title="Method" />
|
|
<span class="method-title">CalDAVClient</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/CalDAVClient.html#methodCalDAVClient">CalDAVClient::CalDAVClient()</a> in caldav-client.php</div>
|
|
<div class="index-item-description">Constructor, initialises the class</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Class.png" alt="Class" title="Class" />
|
|
CalDAVClient
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/CalDAVClient.html">CalDAVClient</a> in caldav-client.php</div>
|
|
<div class="index-item-description">A class for accessing DAViCal via CalDAV, as a client</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Class.png" alt="Class" title="Class" />
|
|
CalDAVPrincipal
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Principal/CalDAVPrincipal.html">CalDAVPrincipal</a> in CalDAVPrincipal.php</div>
|
|
<div class="index-item-description">A class for things to do with a DAV Principal</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Constructor.png" alt="Method" title="Method" />
|
|
<span class="method-title">CalDAVPrincipal</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Principal/CalDAVPrincipal.html#methodCalDAVPrincipal">CalDAVPrincipal::CalDAVPrincipal()</a> in CalDAVPrincipal.php</div>
|
|
<div class="index-item-description">Constructor</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Class.png" alt="Class" title="Class" />
|
|
CalDAVRequest
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/CalDAVRequest.html">CalDAVRequest</a> in CalDAVRequest.php</div>
|
|
<div class="index-item-description">A class for collecting things to do with this request.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Constructor.png" alt="Method" title="Method" />
|
|
<span class="method-title">CalDAVRequest</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/CalDAVRequest.html#methodCalDAVRequest">CalDAVRequest::CalDAVRequest()</a> in CalDAVRequest.php</div>
|
|
<div class="index-item-description">Create a new CalDAVRequest object.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">calendar_to_xml</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/caldav/_inc---caldav-REPORT.php.html#functioncalendar_to_xml">calendar_to_xml()</a> in caldav-REPORT.php</div>
|
|
<div class="index-item-description">Return XML for a single calendar (or todo) entry from the DB</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">CheckPassword</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/HTTPAuthSession/HTTPAuthSession.html#methodCheckPassword">HTTPAuthSession::CheckPassword()</a> in HTTPAuthSession.php</div>
|
|
<div class="index-item-description">CheckPassword does all of the password checking and returns a user record object, or false if it all ends in tears.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">check_string</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_inc---check_UTF8.php.html#functioncheck_string">check_string()</a> in check_UTF8.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">collection_to_xml</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/propfind/_inc---caldav-PROPFIND.php.html#functioncollection_to_xml">collection_to_xml()</a> in caldav-PROPFIND.php</div>
|
|
<div class="index-item-description">Returns an XML sub-tree for a single collection record from the DB</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">ConstructURL</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_inc---always.php.html#functionConstructURL">ConstructURL()</a> in always.php</div>
|
|
<div class="index-item-description">Construct a URL from the supplied dav_name</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">controlRequestContainer</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/caldav/_inc---caldav-PUT-functions.php.html#functioncontrolRequestContainer">controlRequestContainer()</a> in caldav-PUT-functions.php</div>
|
|
<div class="index-item-description">Work out the location we are doing the PUT to, and check that we have the rights to do the needful.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">CreateDefaultRelationships</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/authentication/_inc---auth-functions.php.html#functionCreateDefaultRelationships">CreateDefaultRelationships()</a> in auth-functions.php</div>
|
|
<div class="index-item-description">Create default relationships</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">CreateHomeCalendar</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/authentication/_inc---auth-functions.php.html#functionCreateHomeCalendar">CreateHomeCalendar()</a> in auth-functions.php</div>
|
|
<div class="index-item-description">Create a default home calendar for the user.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">create_scheduling_requests</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/caldav/_inc---caldav-PUT-functions.php.html#functioncreate_scheduling_requests">create_scheduling_requests()</a> in caldav-PUT-functions.php</div>
|
|
<div class="index-item-description">Create scheduling requests in the schedule inbox for the</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">caldav.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/caldav/_htdocs---caldav.php.html">caldav.php</a> in caldav.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">collection.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_htdocs---collection.php.html">collection.php</a> in collection.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">caldav-client.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/_inc---caldav-client.php.html">caldav-client.php</a> in caldav-client.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">caldav-DELETE.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/caldav/_inc---caldav-DELETE.php.html">caldav-DELETE.php</a> in caldav-DELETE.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">caldav-GET.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/caldav/_inc---caldav-GET.php.html">caldav-GET.php</a> in caldav-GET.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">caldav-LOCK.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_inc---caldav-LOCK.php.html">caldav-LOCK.php</a> in caldav-LOCK.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">caldav-MKCALENDAR.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/caldav/_inc---caldav-MKCALENDAR.php.html">caldav-MKCALENDAR.php</a> in caldav-MKCALENDAR.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">caldav-OPTIONS.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/caldav/_inc---caldav-OPTIONS.php.html">caldav-OPTIONS.php</a> in caldav-OPTIONS.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">caldav-POST.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/caldav/_inc---caldav-POST.php.html">caldav-POST.php</a> in caldav-POST.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">caldav-PROPFIND.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/propfind/_inc---caldav-PROPFIND.php.html">caldav-PROPFIND.php</a> in caldav-PROPFIND.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">caldav-PROPPATCH.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/caldav/_inc---caldav-PROPPATCH.php.html">caldav-PROPPATCH.php</a> in caldav-PROPPATCH.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">caldav-PUT-functions.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/caldav/_inc---caldav-PUT-functions.php.html">caldav-PUT-functions.php</a> in caldav-PUT-functions.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">caldav-PUT.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/caldav/_inc---caldav-PUT.php.html">caldav-PUT.php</a> in caldav-PUT.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">caldav-REPORT-calquery.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_inc---caldav-REPORT-calquery.php.html">caldav-REPORT-calquery.php</a> in caldav-REPORT-calquery.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">caldav-REPORT-freebusy.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_inc---caldav-REPORT-freebusy.php.html">caldav-REPORT-freebusy.php</a> in caldav-REPORT-freebusy.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">caldav-REPORT-multiget.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_inc---caldav-REPORT-multiget.php.html">caldav-REPORT-multiget.php</a> in caldav-REPORT-multiget.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">caldav-REPORT-principal.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_inc---caldav-REPORT-principal.php.html">caldav-REPORT-principal.php</a> in caldav-REPORT-principal.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">caldav-REPORT.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/caldav/_inc---caldav-REPORT.php.html">caldav-REPORT.php</a> in caldav-REPORT.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">CalDAVPrincipal.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Principal/_inc---CalDAVPrincipal.php.html">CalDAVPrincipal.php</a> in CalDAVPrincipal.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">CalDAVRequest.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/_inc---CalDAVRequest.php.html">CalDAVRequest.php</a> in CalDAVRequest.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">check_UTF8.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_inc---check_UTF8.php.html">check_UTF8.php</a> in check_UTF8.php</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="d"></a>
|
|
<div class="index-letter-section">
|
|
<div style="float: left" class="index-letter-title">d</div>
|
|
<div style="float: right"><a href="#top">top</a></div>
|
|
<div style="clear: both"></div>
|
|
</div>
|
|
<dl>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$depth</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/CalDAVRequest.html#var$depth">CalDAVRequest::$depth</a> in CalDAVRequest.php</div>
|
|
<div class="index-item-description">The depth parameter from the request headers, coerced into a valid integer: 0, 1 or DEPTH_INFINITY which is defined above. The default is set per various RFCs.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$description</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RRuleTest.html#var$description">RRuleTest::$description</a> in test-RRULE.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$dtstart</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RRuleTest.html#var$dtstart">RRuleTest::$dtstart</a> in test-RRULE.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">DateDifference</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/iCalDate.html#methodDateDifference">iCalDate::DateDifference()</a> in RRule.php</div>
|
|
<div class="index-item-description">Produce an iCalendar format DURATION for the difference between this an another iCalDate</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">DaysInMonth</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/iCalDate.html#methodDaysInMonth">iCalDate::DaysInMonth()</a> in RRule.php</div>
|
|
<div class="index-item-description">No of days in a month 1(Jan) - 12(Dec)</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">DepthRegexTail</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/CalDAVRequest.html#methodDepthRegexTail">CalDAVRequest::DepthRegexTail()</a> in CalDAVRequest.php</div>
|
|
<div class="index-item-description">Returns the tail of a Regex appropriate for this Depth, when appended to</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Constant.png" alt="Constant" title="Constant" />
|
|
<span class="const-title">DEPTH_INFINITY</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/_inc---CalDAVRequest.php.html#defineDEPTH_INFINITY">DEPTH_INFINITY</a> in CalDAVRequest.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">DigestAuthSession</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/HTTPAuthSession/HTTPAuthSession.html#methodDigestAuthSession">HTTPAuthSession::DigestAuthSession()</a> in HTTPAuthSession.php</div>
|
|
<div class="index-item-description">Handle Digest HTTP Authentication (no passwords were harmed in this transaction!)</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">DoCalendarQuery</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/CalDAVClient.html#methodDoCalendarQuery">CalDAVClient::DoCalendarQuery()</a> in caldav-client.php</div>
|
|
<div class="index-item-description">Given XML for a calendar query, return an array of the events (/todos) in the response. Each event in the array will have a 'href', 'etag' and '$response_type' part, where the 'href' is relative to the calendar and the '$response_type' contains the definition of the calendar data in iCalendar format.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">DoDELETERequest</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/CalDAVClient.html#methodDoDELETERequest">CalDAVClient::DoDELETERequest()</a> in caldav-client.php</div>
|
|
<div class="index-item-description">DELETE a text/icalendar resource</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">DoGETRequest</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/CalDAVClient.html#methodDoGETRequest">CalDAVClient::DoGETRequest()</a> in caldav-client.php</div>
|
|
<div class="index-item-description">Get a single item from the server.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">DoOptionsRequest</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/CalDAVClient.html#methodDoOptionsRequest">CalDAVClient::DoOptionsRequest()</a> in caldav-client.php</div>
|
|
<div class="index-item-description">Send an OPTIONS request to the server</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">DoPUTRequest</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/CalDAVClient.html#methodDoPUTRequest">CalDAVClient::DoPUTRequest()</a> in caldav-client.php</div>
|
|
<div class="index-item-description">PUT a text/icalendar resource, returning the etag</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">DoRequest</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/CalDAVClient.html#methodDoRequest">CalDAVClient::DoRequest()</a> in caldav-client.php</div>
|
|
<div class="index-item-description">Send a request to the server</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">DoResponse</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/CalDAVRequest.html#methodDoResponse">CalDAVRequest::DoResponse()</a> in CalDAVRequest.php</div>
|
|
<div class="index-item-description">Utility function we call when we have a simple status-based response to return to the client. Possibly</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">DoXMLRequest</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/CalDAVClient.html#methodDoXMLRequest">CalDAVClient::DoXMLRequest()</a> in caldav-client.php</div>
|
|
<div class="index-item-description">Send an XML request to the server (e.g. PROPFIND, REPORT, MKCALENDAR)</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">davical_configuration_missing.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_inc---davical_configuration_missing.php.html">davical_configuration_missing.php</a> in davical_configuration_missing.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">drivers_ldap.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/ldap/_inc---drivers_ldap.php.html">drivers_ldap.php</a> in drivers_ldap.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">drivers_squid_pam.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/ldap/_inc---drivers_squid_pam.php.html">drivers_squid_pam.php</a> in drivers_squid_pam.php</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="e"></a>
|
|
<div class="index-letter-section">
|
|
<div style="float: left" class="index-letter-title">e</div>
|
|
<div style="float: right"><a href="#top">top</a></div>
|
|
<div style="clear: both"></div>
|
|
</div>
|
|
<dl>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$entry</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/CalDAVClient.html#var$entry">CalDAVClient::$entry</a> in caldav-client.php</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="f"></a>
|
|
<div class="index-letter-section">
|
|
<div style="float: left" class="index-letter-title">f</div>
|
|
<div style="float: right"><a href="#top">top</a></div>
|
|
<div style="clear: both"></div>
|
|
</div>
|
|
<dl>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">FailIfLocked</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/CalDAVRequest.html#methodFailIfLocked">CalDAVRequest::FailIfLocked()</a> in CalDAVRequest.php</div>
|
|
<div class="index-item-description">This will either (a) return false if no locks apply, or (b) return the lock_token which the request successfully included to open the lock, or: (c) respond directly to the client with the failure.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">freebusy.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_htdocs---freebusy.php.html">freebusy.php</a> in freebusy.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">freebusy-GET.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_inc---freebusy-GET.php.html">freebusy-GET.php</a> in freebusy-GET.php</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="g"></a>
|
|
<div class="index-letter-section">
|
|
<div style="float: left" class="index-letter-title">g</div>
|
|
<div style="float: right"><a href="#top">top</a></div>
|
|
<div style="clear: both"></div>
|
|
</div>
|
|
<dl>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$group_membership</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Principal/CalDAVPrincipal.html#var$group_membership">CalDAVPrincipal::$group_membership</a> in CalDAVPrincipal.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$group_member_set</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Principal/CalDAVPrincipal.html#var$group_member_set">CalDAVPrincipal::$group_member_set</a> in CalDAVPrincipal.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">getAllUsers</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/ldap/ldapDrivers.html#methodgetAllUsers">ldapDrivers::getAllUsers()</a> in drivers_ldap.php</div>
|
|
<div class="index-item-description">Retrieve all users from the LDAP directory</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">GetDepthName</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/CalDAVRequest.html#methodGetDepthName">CalDAVRequest::GetDepthName()</a> in CalDAVRequest.php</div>
|
|
<div class="index-item-description">Returns the name for this depth: 0, 1, infinity</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">GetEntryByHref</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/CalDAVClient.html#methodGetEntryByHref">CalDAVClient::GetEntryByHref()</a> in caldav-client.php</div>
|
|
<div class="index-item-description">Get the calendar entry by HREF</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">GetEntryByUid</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/CalDAVClient.html#methodGetEntryByUid">CalDAVClient::GetEntryByUid()</a> in caldav-client.php</div>
|
|
<div class="index-item-description">Get the calendar entry by UID</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">GetEvents</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/CalDAVClient.html#methodGetEvents">CalDAVClient::GetEvents()</a> in caldav-client.php</div>
|
|
<div class="index-item-description">Get the events in a range from $start to $finish. The dates should be in the</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">GetLockDetails</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/CalDAVRequest.html#methodGetLockDetails">CalDAVRequest::GetLockDetails()</a> in CalDAVRequest.php</div>
|
|
<div class="index-item-description">Returns the DB object associated with a lock token, or false.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">GetLockRow</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/CalDAVRequest.html#methodGetLockRow">CalDAVRequest::GetLockRow()</a> in CalDAVRequest.php</div>
|
|
<div class="index-item-description">Returns the locked row, either from the cache or from the database</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">GetMonthByDay</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/iCalDate.html#methodGetMonthByDay">iCalDate::GetMonthByDay()</a> in RRule.php</div>
|
|
<div class="index-item-description">Applies any BYDAY to the month to return a set of days</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">GetMonthByMonthDay</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/iCalDate.html#methodGetMonthByMonthDay">iCalDate::GetMonthByMonthDay()</a> in RRule.php</div>
|
|
<div class="index-item-description">Applies any BYMONTHDAY to the month to return a set of days</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">GetNext</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/RRule.html#methodGetNext">RRule::GetNext()</a> in RRule.php</div>
|
|
<div class="index-item-description">This is most of the meat of the RRULE processing, where we find the next date.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">GetRelationships</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RSCDSSession/RSCDSSession.html#methodGetRelationships">RSCDSSession::GetRelationships()</a> in RSCDSSession.php</div>
|
|
<div class="index-item-description">Method used to get the user's relationships</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">GetRoles</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RSCDSSession/RSCDSSession.html#methodGetRoles">RSCDSSession::GetRoles()</a> in RSCDSSession.php</div>
|
|
<div class="index-item-description">Method used to get the user's roles</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">GetRoles</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/HTTPAuthSession/HTTPAuthSession.html#methodGetRoles">HTTPAuthSession::GetRoles()</a> in HTTPAuthSession.php</div>
|
|
<div class="index-item-description">Internal function used to get the user's roles from the database.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">getStaticLdap</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/ldap/_inc---drivers_ldap.php.html#functiongetStaticLdap">getStaticLdap()</a> in drivers_ldap.php</div>
|
|
<div class="index-item-description">A generic function to create and fetch static objects</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">getStatusMessage</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_inc---always.php.html#functiongetStatusMessage">getStatusMessage()</a> in always.php</div>
|
|
<div class="index-item-description">Return the HTTP status code description for a given code. Hopefully this is an efficient way to code this.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">GetTodos</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/CalDAVClient.html#methodGetTodos">CalDAVClient::GetTodos()</a> in caldav-client.php</div>
|
|
<div class="index-item-description">Get the todo's in a range from $start to $finish. The dates should be in the</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">getUserByID</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_inc---always.php.html#functiongetUserByID">getUserByID()</a> in always.php</div>
|
|
<div class="index-item-description">Return a user record identified by a user_no, caching it for any subsequent lookup</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">getUserByName</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_inc---always.php.html#functiongetUserByName">getUserByName()</a> in always.php</div>
|
|
<div class="index-item-description">Return a user record identified by a username, caching it for any subsequent lookup</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">GetWeekByDay</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/iCalDate.html#methodGetWeekByDay">iCalDate::GetWeekByDay()</a> in RRule.php</div>
|
|
<div class="index-item-description">Applies any BYDAY to the week to return a set of days</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">get_collection</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/propfind/_inc---caldav-PROPFIND.php.html#functionget_collection">get_collection()</a> in caldav-PROPFIND.php</div>
|
|
<div class="index-item-description">Get XML response for a single collection. If Depth is >0 then</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">get_collection_contents</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/propfind/_inc---caldav-PROPFIND.php.html#functionget_collection_contents">get_collection_contents()</a> in caldav-PROPFIND.php</div>
|
|
<div class="index-item-description">Get XML response for items in the collection If '/' is requested, a list of visible users is given, otherwise a list of calendars for the user which are parented by this path.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">get_item</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/propfind/_inc---caldav-PROPFIND.php.html#functionget_item">get_item()</a> in caldav-PROPFIND.php</div>
|
|
<div class="index-item-description">Get XML response for a single item. Depth is irrelevant for this.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">GreaterThan</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/iCalDate.html#methodGreaterThan">iCalDate::GreaterThan()</a> in RRule.php</div>
|
|
<div class="index-item-description">Test if $this is greater than the date parameter</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="h"></a>
|
|
<div class="index-letter-section">
|
|
<div style="float: left" class="index-letter-title">h</div>
|
|
<div style="float: right"><a href="#top">top</a></div>
|
|
<div style="clear: both"></div>
|
|
</div>
|
|
<dl>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$headers</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/CalDAVClient.html#var$headers">CalDAVClient::$headers</a> in caldav-client.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">HandleAction</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RSCDSUser/RSCDSUser.html#methodHandleAction">RSCDSUser::HandleAction()</a> in RSCDSUser.php</div>
|
|
<div class="index-item-description">Handle any unusual actions we might invent</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">handle_freebusy_request</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/caldav/_inc---caldav-POST.php.html#functionhandle_freebusy_request">handle_freebusy_request()</a> in caldav-POST.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">help.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_htdocs---help.php.html">help.php</a> in help.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Constructor.png" alt="Method" title="Method" />
|
|
<span class="method-title">HTTPAuthSession</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/HTTPAuthSession/HTTPAuthSession.html#methodHTTPAuthSession">HTTPAuthSession::HTTPAuthSession()</a> in HTTPAuthSession.php</div>
|
|
<div class="index-item-description">The constructor, which just calls the actual type configured</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Class.png" alt="Class" title="Class" />
|
|
HTTPAuthSession
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/HTTPAuthSession/HTTPAuthSession.html">HTTPAuthSession</a> in HTTPAuthSession.php</div>
|
|
<div class="index-item-description">A Class for handling a session using HTTP Basic Authentication</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">HTTPAuthSession.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/HTTPAuthSession/_inc---HTTPAuthSession.php.html">HTTPAuthSession.php</a> in HTTPAuthSession.php</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="i"></a>
|
|
<div class="index-letter-section">
|
|
<div style="float: left" class="index-letter-title">i</div>
|
|
<div style="float: right"><a href="#top">top</a></div>
|
|
<div style="clear: both"></div>
|
|
</div>
|
|
<dl>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">index.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_htdocs---index.php.html">index.php</a> in index.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Constructor.png" alt="Method" title="Method" />
|
|
<span class="method-title">iCalDate</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/iCalDate.html#methodiCalDate">iCalDate::iCalDate()</a> in RRule.php</div>
|
|
<div class="index-item-description">The constructor takes either an iCalendar date, a text string formatted as an iCalendar date, or epoch seconds.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Class.png" alt="Class" title="Class" />
|
|
iCalDate
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/iCalDate.html">iCalDate</a> in RRule.php</div>
|
|
<div class="index-item-description">A Class for handling dates in iCalendar format. We do make the simplifying assumption that all date handling in here is normalised to GMT. One day we might provide some functions to do that, but for now it is done externally.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">importFromDirectory</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RSCDSSession/Tools.html#methodimportFromDirectory">Tools::importFromDirectory()</a> in tools.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">import_collection</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/caldav/_inc---caldav-PUT-functions.php.html#functionimport_collection">import_collection()</a> in caldav-PUT-functions.php</div>
|
|
<div class="index-item-description">This function will import a whole calendar</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">interactive-page.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_inc---interactive-page.php.html">interactive-page.php</a> in interactive-page.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">InitialiseRecord</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Principal/CalDAVPrincipal.html#methodInitialiseRecord">CalDAVPrincipal::InitialiseRecord()</a> in CalDAVPrincipal.php</div>
|
|
<div class="index-item-description">Initialise the Principal object from a $usr record from the DB.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">IsCollection</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/CalDAVRequest.html#methodIsCollection">CalDAVRequest::IsCollection()</a> in CalDAVRequest.php</div>
|
|
<div class="index-item-description">Returns true if the URL referenced by this request points at a collection.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">IsInfiniteDepth</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/CalDAVRequest.html#methodIsInfiniteDepth">CalDAVRequest::IsInfiniteDepth()</a> in CalDAVRequest.php</div>
|
|
<div class="index-item-description">Returns true if the request asked for infinite depth</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">IsLocked</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/CalDAVRequest.html#methodIsLocked">CalDAVRequest::IsLocked()</a> in CalDAVRequest.php</div>
|
|
<div class="index-item-description">Checks whether the resource is locked, returning any lock token, or false</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">IsPrincipal</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/CalDAVRequest.html#methodIsPrincipal">CalDAVRequest::IsPrincipal()</a> in CalDAVRequest.php</div>
|
|
<div class="index-item-description">Returns true if the URL referenced by this request points at a principal.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">item_to_xml</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/propfind/_inc---caldav-PROPFIND.php.html#functionitem_to_xml">item_to_xml()</a> in caldav-PROPFIND.php</div>
|
|
<div class="index-item-description">Return XML for a single data item from the DB</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="l"></a>
|
|
<div class="index-letter-section">
|
|
<div style="float: left" class="index-letter-title">l</div>
|
|
<div style="float: right"><a href="#top">top</a></div>
|
|
<div style="clear: both"></div>
|
|
</div>
|
|
<dl>
|
|
<dt class="field">
|
|
<img src="media/images/Class.png" alt="Class" title="Class" />
|
|
ldapDrivers
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/ldap/ldapDrivers.html">ldapDrivers</a> in drivers_ldap.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Constructor.png" alt="Method" title="Method" />
|
|
<span class="method-title">ldapDrivers</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/ldap/ldapDrivers.html#methodldapDrivers">ldapDrivers::ldapDrivers()</a> in drivers_ldap.php</div>
|
|
<div class="index-item-description">Constructor.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">LDAP_check</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/ldap/_inc---drivers_ldap.php.html#functionLDAP_check">LDAP_check()</a> in drivers_ldap.php</div>
|
|
<div class="index-item-description">Check the username / password against the LDAP server</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">LessThan</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/iCalDate.html#methodLessThan">iCalDate::LessThan()</a> in RRule.php</div>
|
|
<div class="index-item-description">Test if $this is less than the date parameter</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">local_session_sql</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RSCDSSession/_inc---RSCDSSession.php.html#functionlocal_session_sql">local_session_sql()</a> in RSCDSSession.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">LoginRequired</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RSCDSSession/RSCDSSession.html#methodLoginRequired">RSCDSSession::LoginRequired()</a> in RSCDSSession.php</div>
|
|
<div class="index-item-description">Checks that this user is logged in, and presents a login screen if they aren't.</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="m"></a>
|
|
<div class="index-letter-section">
|
|
<div style="float: left" class="index-letter-title">m</div>
|
|
<div style="float: right"><a href="#top">top</a></div>
|
|
<div style="clear: both"></div>
|
|
</div>
|
|
<dl>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$method</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/CalDAVRequest.html#var$method">CalDAVRequest::$method</a> in CalDAVRequest.php</div>
|
|
<div class="index-item-description">The HTTP request method: PROPFIND, LOCK, REPORT, OPTIONS, etc...</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">make_help_link</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_inc---page-header.php.html#functionmake_help_link">make_help_link()</a> in page-header.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">MonthDays</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/iCalDate.html#methodMonthDays">iCalDate::MonthDays()</a> in RRule.php</div>
|
|
<div class="index-item-description">Given a MonthDays string like "1MO", "-2WE" return an integer day of the month.</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="o"></a>
|
|
<div class="index-letter-section">
|
|
<div style="float: left" class="index-letter-title">o</div>
|
|
<div style="float: right"><a href="#top">top</a></div>
|
|
<div style="clear: both"></div>
|
|
</div>
|
|
<dl>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$options</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/CalDAVRequest.html#var$options">CalDAVRequest::$options</a> in CalDAVRequest.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">other_translated_strings.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_inc---other_translated_strings.php.html">other_translated_strings.php</a> in other_translated_strings.php</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="p"></a>
|
|
<div class="index-letter-section">
|
|
<div style="float: left" class="index-letter-title">p</div>
|
|
<div style="float: right"><a href="#top">top</a></div>
|
|
<div style="clear: both"></div>
|
|
</div>
|
|
<dl>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$pass</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/CalDAVClient.html#var$pass">CalDAVClient::$pass</a> in caldav-client.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$principal</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/CalDAVRequest.html#var$principal">CalDAVRequest::$principal</a> in CalDAVRequest.php</div>
|
|
<div class="index-item-description">The 'principal' (user/resource/...) which this request seeks to access</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">public.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/caldav/_htdocs---public.php.html">public.php</a> in public.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">page-footer.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_inc---page-footer.php.html">page-footer.php</a> in page-footer.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">page-header.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_inc---page-header.php.html">page-header.php</a> in page-header.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">ParseDigestHeader</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/HTTPAuthSession/HTTPAuthSession.html#methodParseDigestHeader">HTTPAuthSession::ParseDigestHeader()</a> in HTTPAuthSession.php</div>
|
|
<div class="index-item-description">Parse the HTTP Digest Auth Header</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">PHPTest</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RRuleTest.html#methodPHPTest">RRuleTest::PHPTest()</a> in test-RRULE.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">privileges</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/propfind/_inc---caldav-PROPFIND.php.html#functionprivileges">privileges()</a> in caldav-PROPFIND.php</div>
|
|
<div class="index-item-description">Returns the array of privilege names converted into XMLElements</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">public_events_only</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/caldav/_inc---caldav-PUT-functions.php.html#functionpublic_events_only">public_events_only()</a> in caldav-PUT-functions.php</div>
|
|
<div class="index-item-description">Check if this collection should force all events to be PUBLIC.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">putCalendarResource</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/caldav/_inc---caldav-PUT-functions.php.html#functionputCalendarResource">putCalendarResource()</a> in caldav-PUT-functions.php</div>
|
|
<div class="index-item-description">Put the resource from this request</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="r"></a>
|
|
<div class="index-letter-section">
|
|
<div style="float: left" class="index-letter-title">r</div>
|
|
<div style="float: right"><a href="#top">top</a></div>
|
|
<div style="clear: both"></div>
|
|
</div>
|
|
<dl>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$raw_post</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/CalDAVRequest.html#var$raw_post">CalDAVRequest::$raw_post</a> in CalDAVRequest.php</div>
|
|
<div class="index-item-description">The raw data sent along with the request</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$recur</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RRuleTest.html#var$recur">RRuleTest::$recur</a> in test-RRULE.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$result_description</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RRuleTest.html#var$result_description">RRuleTest::$result_description</a> in test-RRULE.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">relationship_types.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_htdocs---relationship_types.php.html">relationship_types.php</a> in relationship_types.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">roles.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_htdocs---roles.php.html">roles.php</a> in roles.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">RRule.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/_inc---RRule.php.html">RRule.php</a> in RRule.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">RSCDSSession.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RSCDSSession/_inc---RSCDSSession.php.html">RSCDSSession.php</a> in RSCDSSession.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">RSCDSUser.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RSCDSUser/_inc---RSCDSUser.php.html">RSCDSUser.php</a> in RSCDSUser.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">Render</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RSCDSUser/RSCDSUser.html#methodRender">RSCDSUser::Render()</a> in RSCDSUser.php</div>
|
|
<div class="index-item-description">Render the form / viewer as HTML to show the user</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">render</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RSCDSSession/Tools.html#methodrender">Tools::render()</a> in tools.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">Render</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/iCalDate.html#methodRender">iCalDate::Render()</a> in RRule.php</div>
|
|
<div class="index-item-description">Set the day of week used for calculation of week starts</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">RenderAsXML</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Principal/CalDAVPrincipal.html#methodRenderAsXML">CalDAVPrincipal::RenderAsXML()</a> in CalDAVPrincipal.php</div>
|
|
<div class="index-item-description">Render XML for a single Principal (user) from the DB</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">RenderCollections</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RSCDSUser/RSCDSUser.html#methodRenderCollections">RSCDSUser::RenderCollections()</a> in RSCDSUser.php</div>
|
|
<div class="index-item-description">Render the user's collections</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">renderImportFromDirectory</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RSCDSSession/Tools.html#methodrenderImportFromDirectory">Tools::renderImportFromDirectory()</a> in tools.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">RenderImportIcs</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RSCDSUser/RSCDSUser.html#methodRenderImportIcs">RSCDSUser::RenderImportIcs()</a> in RSCDSUser.php</div>
|
|
<div class="index-item-description">Render input file to import ics in calendar user</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">RenderPrivileges</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Principal/CalDAVPrincipal.html#methodRenderPrivileges">CalDAVPrincipal::RenderPrivileges()</a> in CalDAVPrincipal.php</div>
|
|
<div class="index-item-description">Returns the array of privilege names converted into XMLElements</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">RenderRelationshipsFrom</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RSCDSUser/RSCDSUser.html#methodRenderRelationshipsFrom">RSCDSUser::RenderRelationshipsFrom()</a> in RSCDSUser.php</div>
|
|
<div class="index-item-description">Render the user's relationships to other users & resources</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">RenderRelationshipsTo</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RSCDSUser/RSCDSUser.html#methodRenderRelationshipsTo">RSCDSUser::RenderRelationshipsTo()</a> in RSCDSUser.php</div>
|
|
<div class="index-item-description">Render the user's relationships to other users & resources</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">renderSyncLDAP</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RSCDSSession/Tools.html#methodrenderSyncLDAP">Tools::renderSyncLDAP()</a> in tools.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">requestUser</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/ldap/ldapDrivers.html#methodrequestUser">ldapDrivers::requestUser()</a> in drivers_ldap.php</div>
|
|
<div class="index-item-description">Returns the result of the LDAP query</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">rollback_on_error</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/caldav/_inc---caldav-PUT-functions.php.html#functionrollback_on_error">rollback_on_error()</a> in caldav-PUT-functions.php</div>
|
|
<div class="index-item-description">This function launches an error</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Class.png" alt="Class" title="Class" />
|
|
RRule
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/RRule.html">RRule</a> in RRule.php</div>
|
|
<div class="index-item-description">A Class for handling Events on a calendar which repeat</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Constructor.png" alt="Method" title="Method" />
|
|
<span class="method-title">RRule</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/RRule.html#methodRRule">RRule::RRule()</a> in RRule.php</div>
|
|
<div class="index-item-description">The constructor takes a start date and an RRULE definition. Both of these follow the iCalendar standard.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Class.png" alt="Class" title="Class" />
|
|
RRuleTest
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RRuleTest.html">RRuleTest</a> in test-RRULE.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Constructor.png" alt="Method" title="Method" />
|
|
<span class="method-title">RRuleTest</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RRuleTest.html#methodRRuleTest">RRuleTest::RRuleTest()</a> in test-RRULE.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Constructor.png" alt="Method" title="Method" />
|
|
<span class="method-title">RSCDSSession</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RSCDSSession/RSCDSSession.html#methodRSCDSSession">RSCDSSession::RSCDSSession()</a> in RSCDSSession.php</div>
|
|
<div class="index-item-description">Create a new RSCDSSession object.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Class.png" alt="Class" title="Class" />
|
|
RSCDSSession
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RSCDSSession/RSCDSSession.html">RSCDSSession</a> in RSCDSSession.php</div>
|
|
<div class="index-item-description">A class for creating and holding session information.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Constructor.png" alt="Method" title="Method" />
|
|
<span class="method-title">RSCDSUser</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RSCDSUser/RSCDSUser.html#methodRSCDSUser">RSCDSUser::RSCDSUser()</a> in RSCDSUser.php</div>
|
|
<div class="index-item-description">Constructor - nothing fancy as yet.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Class.png" alt="Class" title="Class" />
|
|
RSCDSUser
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RSCDSUser/RSCDSUser.html">RSCDSUser</a> in RSCDSUser.php</div>
|
|
<div class="index-item-description">A class for viewing and maintaining DAViCal User records</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="s"></a>
|
|
<div class="index-letter-section">
|
|
<div style="float: left" class="index-letter-title">s</div>
|
|
<div style="float: right"><a href="#top">top</a></div>
|
|
<div style="clear: both"></div>
|
|
</div>
|
|
<dl>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$schedule_inbox_url</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Principal/CalDAVPrincipal.html#var$schedule_inbox_url">CalDAVPrincipal::$schedule_inbox_url</a> in CalDAVPrincipal.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$schedule_outbox_url</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Principal/CalDAVPrincipal.html#var$schedule_outbox_url">CalDAVPrincipal::$schedule_outbox_url</a> in CalDAVPrincipal.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Global.png" alt="Global" title="Global" />
|
|
<span class="var-title">$session
|
|
The session object is global.</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RSCDSSession/_inc---RSCDSSession.php.html#global$session
|
|
The session object is global.">$session
|
|
The session object is global.</a> in RSCDSSession.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">send_page_header</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_inc---page-header.php.html#functionsend_page_header">send_page_header()</a> in page-header.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">SetContentType</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/CalDAVClient.html#methodSetContentType">CalDAVClient::SetContentType()</a> in caldav-client.php</div>
|
|
<div class="index-item-description">Add a Content-type: header.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">SetDepth</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/CalDAVClient.html#methodSetDepth">CalDAVClient::SetDepth()</a> in caldav-client.php</div>
|
|
<div class="index-item-description">Add a Depth: header. Valid values are 1 or infinity</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">SetEpochDate</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/iCalDate.html#methodSetEpochDate">iCalDate::SetEpochDate()</a> in RRule.php</div>
|
|
<div class="index-item-description">Set the date from an epoch</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">SetGMTDate</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/iCalDate.html#methodSetGMTDate">iCalDate::SetGMTDate()</a> in RRule.php</div>
|
|
<div class="index-item-description">Set the date from a text string</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">SetLocalDate</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/iCalDate.html#methodSetLocalDate">iCalDate::SetLocalDate()</a> in RRule.php</div>
|
|
<div class="index-item-description">Set the date from a text string</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">SetMatch</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/CalDAVClient.html#methodSetMatch">CalDAVClient::SetMatch()</a> in caldav-client.php</div>
|
|
<div class="index-item-description">Adds an If-Match or If-None-Match header</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">SetMonthDay</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/iCalDate.html#methodSetMonthDay">iCalDate::SetMonthDay()</a> in RRule.php</div>
|
|
<div class="index-item-description">Set the day in the month to what we have been given</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">setPermissions</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/CalDAVRequest.html#methodsetPermissions">CalDAVRequest::setPermissions()</a> in CalDAVRequest.php</div>
|
|
<div class="index-item-description">Permissions are controlled as follows:</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">SetUserAgent</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/CalDAVClient.html#methodSetUserAgent">CalDAVClient::SetUserAgent()</a> in caldav-client.php</div>
|
|
<div class="index-item-description">Add a Depth: header. Valid values are 1 or infinity</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">SetWeekStart</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/iCalDate.html#methodSetWeekStart">iCalDate::SetWeekStart()</a> in RRule.php</div>
|
|
<div class="index-item-description">Set the day of week used for calculation of week starts</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">SqlFilterFragment</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_inc---caldav-REPORT-calquery.php.html#functionSqlFilterFragment">SqlFilterFragment()</a> in caldav-REPORT-calquery.php</div>
|
|
<div class="index-item-description">Process a filter fragment returning an SQL fragment</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">SQLTest</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RRuleTest.html#methodSQLTest">RRuleTest::SQLTest()</a> in test-RRULE.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Class.png" alt="Class" title="Class" />
|
|
squidPamDrivers
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/ldap/squidPamDrivers.html">squidPamDrivers</a> in drivers_squid_pam.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Constructor.png" alt="Method" title="Method" />
|
|
<span class="method-title">squidPamDrivers</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/ldap/squidPamDrivers.html#methodsquidPamDrivers">squidPamDrivers::squidPamDrivers()</a> in drivers_squid_pam.php</div>
|
|
<div class="index-item-description">Constructor.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">SQUID_PAM_check</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/ldap/_inc---drivers_squid_pam.php.html#functionSQUID_PAM_check">SQUID_PAM_check()</a> in drivers_squid_pam.php</div>
|
|
<div class="index-item-description">Check the username / password against the PAM system</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">SupportedPrivileges</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/CalDAVRequest.html#methodSupportedPrivileges">CalDAVRequest::SupportedPrivileges()</a> in CalDAVRequest.php</div>
|
|
<div class="index-item-description">Return an array of what the DAV privileges are that are supported</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">sync_LDAP</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/ldap/_inc---drivers_ldap.php.html#functionsync_LDAP">sync_LDAP()</a> in drivers_ldap.php</div>
|
|
<div class="index-item-description">sync LDAP against the DB</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">sync_user_from_LDAP</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/ldap/_inc---drivers_ldap.php.html#functionsync_user_from_LDAP">sync_user_from_LDAP()</a> in drivers_ldap.php</div>
|
|
<div class="index-item-description">Synchronise a cached user with one from LDAP</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="t"></a>
|
|
<div class="index-letter-section">
|
|
<div style="float: left" class="index-letter-title">t</div>
|
|
<div style="float: right"><a href="#top">top</a></div>
|
|
<div style="clear: both"></div>
|
|
</div>
|
|
<dl>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">tools.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RSCDSSession/_htdocs---tools.php.html">tools.php</a> in tools.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">test-RRULE.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_inc---test-RRULE.php.html">test-RRULE.php</a> in test-RRULE.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">TestByMonth</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/iCalDate.html#methodTestByMonth">iCalDate::TestByMonth()</a> in RRule.php</div>
|
|
<div class="index-item-description">Test to see if our _mo matches something in the list of months we have received.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Class.png" alt="Class" title="Class" />
|
|
Tools
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RSCDSSession/Tools.html">Tools</a> in tools.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">translate_relationship_list</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Admin/_htdocs---users.php.html#functiontranslate_relationship_list">translate_relationship_list()</a> in users.php</div>
|
|
<div class="index-item-description">Translate relationship names in the relationship_list for each user. See the documentation for classBrowser::BrowserColumn for the definition of the hook function parameters.</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="u"></a>
|
|
<div class="index-letter-section">
|
|
<div style="float: left" class="index-letter-title">u</div>
|
|
<div style="float: right"><a href="#top">top</a></div>
|
|
<div style="clear: both"></div>
|
|
</div>
|
|
<dl>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$url</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Principal/CalDAVPrincipal.html#var$url">CalDAVPrincipal::$url</a> in CalDAVPrincipal.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$user</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/CalDAVClient.html#var$user">CalDAVClient::$user</a> in caldav-client.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$user_agent</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/CalDAVRequest.html#var$user_agent">CalDAVRequest::$user_agent</a> in CalDAVRequest.php</div>
|
|
<div class="index-item-description">The user agent making the request.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
|
|
<span class="var-title">$user_agent</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/CalDAVClient.html#var$user_agent">CalDAVClient::$user_agent</a> in caldav-client.php</div>
|
|
<div class="index-item-description">The useragent which is send to the caldav server</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">users.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Admin/_htdocs---users.php.html">users.php</a> in users.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Page.png" alt="Page" title="Page" />
|
|
<span class="include-title">usr.php</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_htdocs---usr.php.html">usr.php</a> in usr.php</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">unicodeToUtf8</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_inc---check_UTF8.php.html#functionunicodeToUtf8">unicodeToUtf8()</a> in check_UTF8.php</div>
|
|
<div class="index-item-description">Takes an array of ints representing the Unicode characters and returns a UTF-8 string. Astral planes are supported ie. the ints in the input can be > 0xFFFF. Occurrances of the BOM are ignored. Surrogates are not allowed.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">UnsupportedRequest</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/CalDAVRequest.html#methodUnsupportedRequest">CalDAVRequest::UnsupportedRequest()</a> in CalDAVRequest.php</div>
|
|
<div class="index-item-description">Sometimes it's a perfectly formed request, but we just don't do that :-(</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">UpdateUserFromExternal</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/authentication/_inc---auth-functions.php.html#functionUpdateUserFromExternal">UpdateUserFromExternal()</a> in auth-functions.php</div>
|
|
<div class="index-item-description">Update the local cache of the remote user details</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">UserFromPath</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/CalDAVRequest.html#methodUserFromPath">CalDAVRequest::UserFromPath()</a> in CalDAVRequest.php</div>
|
|
<div class="index-item-description">Work out the user whose calendar we are accessing, based on elements of the path.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">UsernameFromEMail</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Principal/CalDAVPrincipal.html#methodUsernameFromEMail">CalDAVPrincipal::UsernameFromEMail()</a> in CalDAVPrincipal.php</div>
|
|
<div class="index-item-description">Work out the username, based on the given e-mail</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">UsernameFromPath</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Principal/CalDAVPrincipal.html#methodUsernameFromPath">CalDAVPrincipal::UsernameFromPath()</a> in CalDAVPrincipal.php</div>
|
|
<div class="index-item-description">Work out the username, based on elements of the path.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">utf8ToUnicode</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/_inc---check_UTF8.php.html#functionutf8ToUnicode">utf8ToUnicode()</a> in check_UTF8.php</div>
|
|
<div class="index-item-description">Takes an UTF-8 string and returns an array of ints representing the Unicode characters. Astral planes are supported ie. the ints in the output can be > 0xFFFF. Occurrances of the BOM are ignored. Surrogates are not allowed.</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="v"></a>
|
|
<div class="index-letter-section">
|
|
<div style="float: left" class="index-letter-title">v</div>
|
|
<div style="float: right"><a href="#top">top</a></div>
|
|
<div style="clear: both"></div>
|
|
</div>
|
|
<dl>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">Validate</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RSCDSUser/RSCDSUser.html#methodValidate">RSCDSUser::Validate()</a> in RSCDSUser.php</div>
|
|
<div class="index-item-description">Validate the information the user submitted</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">ValidateLockToken</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/CalDAVRequest.html#methodValidateLockToken">CalDAVRequest::ValidateLockToken()</a> in CalDAVRequest.php</div>
|
|
<div class="index-item-description">Checks to see whether the lock token given matches one of the ones handed in with the request.</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="w"></a>
|
|
<div class="index-letter-section">
|
|
<div style="float: left" class="index-letter-title">w</div>
|
|
<div style="float: right"><a href="#top">top</a></div>
|
|
<div style="clear: both"></div>
|
|
</div>
|
|
<dl>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">WithinScope</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/RRule.html#methodWithinScope">RRule::WithinScope()</a> in RRule.php</div>
|
|
<div class="index-item-description">Processes the array of $relative_days to $base and removes any which are not within the scope of our rule.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">Write</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/RSCDSUser/RSCDSUser.html#methodWrite">RSCDSUser::Write()</a> in RSCDSUser.php</div>
|
|
<div class="index-item-description">Write the record to the file</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="x"></a>
|
|
<div class="index-letter-section">
|
|
<div style="float: left" class="index-letter-title">x</div>
|
|
<div style="float: right"><a href="#top">top</a></div>
|
|
<div style="clear: both"></div>
|
|
</div>
|
|
<dl>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">XMLResponse</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/Request/CalDAVRequest.html#methodXMLResponse">CalDAVRequest::XMLResponse()</a> in CalDAVRequest.php</div>
|
|
<div class="index-item-description">Send an XML Response. This function will never return.</div>
|
|
</dd>
|
|
</dl>
|
|
<a name="_"></a>
|
|
<div class="index-letter-section">
|
|
<div style="float: left" class="index-letter-title">_</div>
|
|
<div style="float: right"><a href="#top">top</a></div>
|
|
<div style="clear: both"></div>
|
|
</div>
|
|
<dl>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">_EpochFromParts</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/iCalDate.html#method_EpochFromParts">iCalDate::_EpochFromParts()</a> in RRule.php</div>
|
|
<div class="index-item-description">Given a local text date, convert it to an epoch</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">_GMTEpochFromParts</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/iCalDate.html#method_GMTEpochFromParts">iCalDate::_GMTEpochFromParts()</a> in RRule.php</div>
|
|
<div class="index-item-description">Given a GMT text date, convert it to an epoch</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">_GMTTextFromEpoch</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/iCalDate.html#method_GMTTextFromEpoch">iCalDate::_GMTTextFromEpoch()</a> in RRule.php</div>
|
|
<div class="index-item-description">Given a GMT epoch date, convert it to text</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">_PartsFromText</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/iCalDate.html#method_PartsFromText">iCalDate::_PartsFromText()</a> in RRule.php</div>
|
|
<div class="index-item-description">Given a text date, convert it to parts</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Method.png" alt="Method" title="Method" />
|
|
<span class="method-title">_TextFromEpoch</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/iCalDate.html#method_TextFromEpoch">iCalDate::_TextFromEpoch()</a> in RRule.php</div>
|
|
<div class="index-item-description">Given an epoch date, convert it to text</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Constructor.png" alt="Method" title="Method" />
|
|
<span class="method-title">__construct</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/ldap/squidPamDrivers.html#method__construct">squidPamDrivers::__construct()</a> in drivers_squid_pam.php</div>
|
|
<div class="index-item-description">The constructor</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Constructor.png" alt="Method" title="Method" />
|
|
<span class="method-title">__construct</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="davical/ldap/ldapDrivers.html#method__construct">ldapDrivers::__construct()</a> in drivers_ldap.php</div>
|
|
<div class="index-item-description">Initializes the LDAP connection</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">__curl_init_callback</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/_inc---caldav-client.php.html#function__curl_init_callback">__curl_init_callback()</a> in caldav-client.php</div>
|
|
<div class="index-item-description">I bet you find this hard to believe, but having to write this hack really annoys the crap out of me. WTF! Why does PHP/Curl not have a function which simply accepts a string as what the request will contain. Oh no. They only think of "POST" and "PUT a file". Crap.</div>
|
|
</dd>
|
|
<dt class="field">
|
|
<img src="media/images/Function.png" alt="Function" title="Function" />
|
|
<span class="method-title">__curl_read_callback</span>
|
|
</dt>
|
|
<dd class="index-item-body">
|
|
<div class="index-item-details"><a href="awl/caldav/_inc---caldav-client.php.html#function__curl_read_callback">__curl_read_callback()</a> in caldav-client.php</div>
|
|
<div class="index-item-description">As documented in the comments on this page(!)</div>
|
|
</dd>
|
|
</dl>
|
|
|
|
<div class="index-letter-menu">
|
|
<a class="index-letter" href="elementindex.html#a">a</a>
|
|
<a class="index-letter" href="elementindex.html#b">b</a>
|
|
<a class="index-letter" href="elementindex.html#c">c</a>
|
|
<a class="index-letter" href="elementindex.html#d">d</a>
|
|
<a class="index-letter" href="elementindex.html#e">e</a>
|
|
<a class="index-letter" href="elementindex.html#f">f</a>
|
|
<a class="index-letter" href="elementindex.html#g">g</a>
|
|
<a class="index-letter" href="elementindex.html#h">h</a>
|
|
<a class="index-letter" href="elementindex.html#i">i</a>
|
|
<a class="index-letter" href="elementindex.html#l">l</a>
|
|
<a class="index-letter" href="elementindex.html#m">m</a>
|
|
<a class="index-letter" href="elementindex.html#o">o</a>
|
|
<a class="index-letter" href="elementindex.html#p">p</a>
|
|
<a class="index-letter" href="elementindex.html#r">r</a>
|
|
<a class="index-letter" href="elementindex.html#s">s</a>
|
|
<a class="index-letter" href="elementindex.html#t">t</a>
|
|
<a class="index-letter" href="elementindex.html#u">u</a>
|
|
<a class="index-letter" href="elementindex.html#v">v</a>
|
|
<a class="index-letter" href="elementindex.html#w">w</a>
|
|
<a class="index-letter" href="elementindex.html#x">x</a>
|
|
<a class="index-letter" href="elementindex.html#_">_</a>
|
|
</div>
|
|
</body>
|
|
</html>
|