mirror of
https://gitlab.com/davical-project/davical.git
synced 2026-09-01 18:48:17 +00:00
Add the API docs into the repository.
This commit is contained in:
Andrew McMillan
parent
4e0abf5e4b
commit
06f35dabd6
176
docs/api/awl/caldav/RRule.html
Normal file
176
docs/api/awl/caldav/RRule.html
Normal file
@ -0,0 +1,176 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs For Class RRule</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="class-name"><img src="../../media/images/Class_logo.png"
|
||||
alt=" Class"
|
||||
title=" Class"
|
||||
style="vertical-align: middle"> RRule</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">A Class for handling Events on a calendar which repeat</p>
|
||||
<p class="description"><p>Here's the spec, from RFC2445:</p><p>At this point we are going to restrict ourselves to parts of the RRULE specification seen in the wild. And by "in the wild" I don't include within people's timezone definitions. We always convert time zones to canonical names and assume the lower level libraries can do a better job with them than we can.</p><p>We will concentrate on: FREQ=(YEARLY|MONTHLY|WEEKLY|DAILY) UNTIL= COUNT= INTERVAL= BYDAY= BYMONTHDAY= BYSETPOS= WKST= BYYEARDAY= BYWEEKNO= BYMONTH=</p></p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_inc---RRule.php.html">/inc/RRule.php</a> (line <span class="field">675</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="sec-method-summary"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Method Summary</span></div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<div class="method-summary">
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Constructor.png" alt=" "/>
|
||||
<span class="method-result">RRule</span>
|
||||
<a href="#RRule" title="details" class="method-name">RRule</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$start</span>, <span class="var-type"></span> <span class="var-name">$rrule</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#GetNext" title="details" class="method-name">&GetNext</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#WithinScope" title="details" class="method-name">WithinScope</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$base</span>, <span class="var-type"></span> <span class="var-name">$relative_days</span>)
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-methods"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Methods</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
<a name="methodRRule" id="RRule"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Constructor.png" />
|
||||
<span class="method-title">Constructor RRule</span> (line <span class="line-number">707</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">The constructor takes a start date and an RRULE definition. Both of these follow the iCalendar standard.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">RRule</span>
|
||||
<span class="method-name">
|
||||
RRule
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$start</span>, <span class="var-type"></span> <span class="var-name">$rrule</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$start</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$rrule</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodGetNext" id="GetNext"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">GetNext</span> (line <span class="line-number">818</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">This is most of the meat of the RRULE processing, where we find the next date.</p>
|
||||
<p class="description"><p>We maintain an</p></p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
&GetNext
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodWithinScope" id="WithinScope"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">WithinScope</span> (line <span class="line-number">758</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Processes the array of $relative_days to $base and removes any which are not within the scope of our rule.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
WithinScope
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$base</span>, <span class="var-type"></span> <span class="var-name">$relative_days</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$base</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$relative_days</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
80
docs/api/awl/caldav/_inc---RRule.php.html
Normal file
80
docs/api/awl/caldav/_inc---RRule.php.html
Normal file
@ -0,0 +1,80 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page RRule.php</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/RRule.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Class for parsing RRule and getting us the dates</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@catalyst.net.nz">andrew@catalyst.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Catalyst .Net Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
|
||||
<img src="../../media/images/Class.png"
|
||||
alt=" class"
|
||||
title=" class"/>
|
||||
<a href="../../awl/caldav/iCalDate.html">iCalDate</a>
|
||||
</td>
|
||||
<td>
|
||||
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.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
|
||||
<img src="../../media/images/Class.png"
|
||||
alt=" class"
|
||||
title=" class"/>
|
||||
<a href="../../awl/caldav/RRule.html">RRule</a>
|
||||
</td>
|
||||
<td>
|
||||
A Class for handling Events on a calendar which repeat
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
908
docs/api/awl/caldav/iCalDate.html
Normal file
908
docs/api/awl/caldav/iCalDate.html
Normal file
@ -0,0 +1,908 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs For Class iCalDate</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="class-name"><img src="../../media/images/Class_logo.png"
|
||||
alt=" Class"
|
||||
title=" Class"
|
||||
style="vertical-align: middle"> iCalDate</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">A Class for 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.</p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_inc---RRule.php.html">/inc/RRule.php</a> (line <span class="field">21</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="sec-method-summary"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Method Summary</span></div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<div class="method-summary">
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Constructor.png" alt=" "/>
|
||||
<span class="method-result">iCalDate</span>
|
||||
<a href="#iCalDate" title="details" class="method-name">iCalDate</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$input</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#AddDays" title="details" class="method-name">AddDays</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$dd</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#AddDuration" title="details" class="method-name">AddDuration</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$duration</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#AddMonths" title="details" class="method-name">AddMonths</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$mo</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">array</span>
|
||||
<a href="#ApplyBySetPos" title="details" class="method-name">&ApplyBySetPos</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$bysplist</span>, <span class="var-type">string</span> <span class="var-name">$set</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">string</span>
|
||||
<a href="#DateDifference" title="details" class="method-name">DateDifference</a>
|
||||
(<span class="var-type">date</span> <span class="var-name">$from</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#DaysInMonth" title="details" class="method-name">DaysInMonth</a>
|
||||
([<span class="var-type"></span> <span class="var-name">$mo</span> = <span class="var-default">false</span>], [<span class="var-type"></span> <span class="var-name">$yy</span> = <span class="var-default">false</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">array</span>
|
||||
<a href="#GetMonthByDay" title="details" class="method-name">GetMonthByDay</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$byday</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">array</span>
|
||||
<a href="#GetMonthByMonthDay" title="details" class="method-name">GetMonthByMonthDay</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$bymonthday</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">array</span>
|
||||
<a href="#GetWeekByDay" title="details" class="method-name">GetWeekByDay</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$byday</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">boolean</span>
|
||||
<a href="#GreaterThan" title="details" class="method-name">GreaterThan</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$lesser</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">boolean</span>
|
||||
<a href="#LessThan" title="details" class="method-name">LessThan</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$greater</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">array</span>
|
||||
<a href="#MonthDays" title="details" class="method-name">&MonthDays</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$dow_first</span>, <span class="var-type">string</span> <span class="var-name">$days_in_month</span>, <span class="var-type">string</span> <span class="var-name">$dayspec</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#Render" title="details" class="method-name">Render</a>
|
||||
([<span class="var-type"></span> <span class="var-name">$fmt</span> = <span class="var-default">'Y-m-d H:i:s'</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#SetEpochDate" title="details" class="method-name">SetEpochDate</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$input</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#SetGMTDate" title="details" class="method-name">SetGMTDate</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$input</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#SetLocalDate" title="details" class="method-name">SetLocalDate</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$input</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#SetMonthDay" title="details" class="method-name">SetMonthDay</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$dd</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#SetWeekStart" title="details" class="method-name">SetWeekStart</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">boolean</span>
|
||||
<a href="#TestByMonth" title="details" class="method-name">TestByMonth</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$monthlist</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#_EpochFromParts" title="details" class="method-name">_EpochFromParts</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#_GMTEpochFromParts" title="details" class="method-name">_GMTEpochFromParts</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#_GMTTextFromEpoch" title="details" class="method-name">_GMTTextFromEpoch</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#_PartsFromText" title="details" class="method-name">_PartsFromText</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#_TextFromEpoch" title="details" class="method-name">_TextFromEpoch</a>
|
||||
()
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-methods"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Methods</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
<a name="methodiCalDate" id="iCalDate"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Constructor.png" />
|
||||
<span class="method-title">Constructor iCalDate</span> (line <span class="line-number">50</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">The constructor takes either an iCalendar date, a text string formatted as an iCalendar date, or epoch seconds.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">iCalDate</span>
|
||||
<span class="method-name">
|
||||
iCalDate
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$input</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$input</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodAddDays" id="AddDays"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">AddDays</span> (line <span class="line-number">254</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Add some integer number of days to a date</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
AddDays
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$dd</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$dd</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodAddDuration" id="AddDuration"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">AddDuration</span> (line <span class="line-number">282</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Add duration</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
AddDuration
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$duration</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$duration</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodAddMonths" id="AddMonths"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">AddMonths</span> (line <span class="line-number">226</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Add some number of months to a date</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
AddMonths
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$mo</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$mo</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodApplyBySetPos" id="ApplyBySetPos"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">ApplyBySetPos</span> (line <span class="line-number">547</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Given set position descriptions like '1', '3', '11', '-3' or '-1' and a set, return the subset matching the list of set positions.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> The subset which matches.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
&ApplyBySetPos
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$bysplist</span>, <span class="var-type">string</span> <span class="var-name">$set</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$bysplist</span><span class="var-description">: The list of set positions.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$set</span><span class="var-description">: The set of days that we will apply the positions to.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodDateDifference" id="DateDifference"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">DateDifference</span> (line <span class="line-number">318</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Produce an iCalendar format DURATION for the difference between this an another iCalDate</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> The date difference, as an iCalendar duration format</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
DateDifference
|
||||
</span>
|
||||
(<span class="var-type">date</span> <span class="var-name">$from</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">date</span>
|
||||
<span class="var-name">$from</span><span class="var-description">: The start of the period</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodDaysInMonth" id="DaysInMonth"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">DaysInMonth</span> (line <span class="line-number">177</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">No of days in a month 1(Jan) - 12(Dec)</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
DaysInMonth
|
||||
</span>
|
||||
([<span class="var-type"></span> <span class="var-name">$mo</span> = <span class="var-default">false</span>], [<span class="var-type"></span> <span class="var-name">$yy</span> = <span class="var-default">false</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$mo</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$yy</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodGetMonthByDay" id="GetMonthByDay"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">GetMonthByDay</span> (line <span class="line-number">401</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Applies any BYDAY to the month to return a set of days</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> An array of the day numbers for the month which meet the rule.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
GetMonthByDay
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$byday</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$byday</span><span class="var-description">: The BYDAY rule</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodGetMonthByMonthDay" id="GetMonthByMonthDay"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">GetMonthByMonthDay</span> (line <span class="line-number">422</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Applies any BYMONTHDAY to the month to return a set of days</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> An array of the day numbers for the month which meet the rule.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
GetMonthByMonthDay
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$bymonthday</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$bymonthday</span><span class="var-description">: The BYMONTHDAY rule</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodGetWeekByDay" id="GetWeekByDay"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">GetWeekByDay</span> (line <span class="line-number">441</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Applies any BYDAY to the week to return a set of days</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> An array of the day numbers for the week which meet the rule.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
GetWeekByDay
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$byday</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$byday</span><span class="var-description">: The BYDAY rule</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodGreaterThan" id="GreaterThan"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">GreaterThan</span> (line <span class="line-number">462</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Test if $this is greater than the date parameter</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> True if $this > $lesser</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
GreaterThan
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$lesser</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$lesser</span><span class="var-description">: The other date, as a local time string</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodLessThan" id="LessThan"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">LessThan</span> (line <span class="line-number">477</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Test if $this is less than the date parameter</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> True if $this < $greater</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
LessThan
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$greater</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$greater</span><span class="var-description">: The other date, as a local time string</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodMonthDays" id="MonthDays"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">MonthDays</span> (line <span class="line-number">496</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Given a MonthDays string like "1MO", "-2WE" return an integer day of the month.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> An array of the day numbers for the month which meet the rule.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
&MonthDays
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$dow_first</span>, <span class="var-type">string</span> <span class="var-name">$days_in_month</span>, <span class="var-type">string</span> <span class="var-name">$dayspec</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$dow_first</span><span class="var-description">: The day of week of the first of the month.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$days_in_month</span><span class="var-description">: The number of days in the month.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$dayspec</span><span class="var-description">: The specification for a month day (or days) which we parse.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodRender" id="Render"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">Render</span> (line <span class="line-number">169</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Set the day of week used for calculation of week starts</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
Render
|
||||
</span>
|
||||
([<span class="var-type"></span> <span class="var-name">$fmt</span> = <span class="var-default">'Y-m-d H:i:s'</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$fmt</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodSetEpochDate" id="SetEpochDate"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">SetEpochDate</span> (line <span class="line-number">103</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Set the date from an epoch</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
SetEpochDate
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$input</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$input</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodSetGMTDate" id="SetGMTDate"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">SetGMTDate</span> (line <span class="line-number">83</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Set the date from a text string</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
SetGMTDate
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$input</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$input</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodSetLocalDate" id="SetLocalDate"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">SetLocalDate</span> (line <span class="line-number">93</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Set the date from a text string</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
SetLocalDate
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$input</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$input</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodSetMonthDay" id="SetMonthDay"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">SetMonthDay</span> (line <span class="line-number">214</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Set the day in the month to what we have been given</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
SetMonthDay
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$dd</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$dd</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodSetWeekStart" id="SetWeekStart"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">SetWeekStart</span> (line <span class="line-number">160</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Set the day of week used for calculation of week starts</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
SetWeekStart
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodTestByMonth" id="TestByMonth"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">TestByMonth</span> (line <span class="line-number">389</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Test to see if our _mo matches something in the list of months we have received.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Whether this date falls within one of those months.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
TestByMonth
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$monthlist</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$monthlist</span><span class="var-description">: A comma-separated list of months.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="method_EpochFromParts" id="_EpochFromParts"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">_EpochFromParts</span> (line <span class="line-number">151</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Given a local text date, convert it to an epoch</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
_EpochFromParts
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="method_GMTEpochFromParts" id="_GMTEpochFromParts"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">_GMTEpochFromParts</span> (line <span class="line-number">142</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Given a GMT text date, convert it to an epoch</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
_GMTEpochFromParts
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="method_GMTTextFromEpoch" id="_GMTTextFromEpoch"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">_GMTTextFromEpoch</span> (line <span class="line-number">121</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Given a GMT epoch date, convert it to text</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
_GMTTextFromEpoch
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="method_PartsFromText" id="_PartsFromText"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">_PartsFromText</span> (line <span class="line-number">129</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Given a text date, convert it to parts</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
_PartsFromText
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="method_TextFromEpoch" id="_TextFromEpoch"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">_TextFromEpoch</span> (line <span class="line-number">113</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Given an epoch date, convert it to text</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
_TextFromEpoch
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
13
docs/api/blank.html
Normal file
13
docs/api/blank.html
Normal file
@ -0,0 +1,13 @@
|
||||
<html>
|
||||
<head>
|
||||
<title>DAViCal</title>
|
||||
<link rel="stylesheet" href="media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div align="center"><h1>DAViCal</h1></div>
|
||||
<b>Welcome to davical!</b><br />
|
||||
<br />
|
||||
This documentation was generated by <a href="http://www.phpdoc.org">phpDocumentor v1.3.2</a><br />
|
||||
</body>
|
||||
</html>
|
||||
28
docs/api/classtrees_awl.html
Normal file
28
docs/api/classtrees_awl.html
Normal file
@ -0,0 +1,28 @@
|
||||
<?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>
|
||||
|
||||
<!-- Start of Class Data -->
|
||||
<H2>
|
||||
|
||||
</H2>
|
||||
<h2>Root class iCalDate</h2>
|
||||
<ul>
|
||||
<li><a href="awl/caldav/iCalDate.html">iCalDate</a></li></ul>
|
||||
|
||||
<h2>Root class RRule</h2>
|
||||
<ul>
|
||||
<li><a href="awl/caldav/RRule.html">RRule</a></li></ul>
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:45 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</body>
|
||||
</html>
|
||||
52
docs/api/classtrees_davical.html
Normal file
52
docs/api/classtrees_davical.html
Normal file
@ -0,0 +1,52 @@
|
||||
<?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>
|
||||
|
||||
<!-- Start of Class Data -->
|
||||
<H2>
|
||||
|
||||
</H2>
|
||||
<h2>Root class CalDAVPrincipal</h2>
|
||||
<ul>
|
||||
<li><a href="davical/Principal/CalDAVPrincipal.html">CalDAVPrincipal</a></li></ul>
|
||||
|
||||
<h2>Root class CalDAVRequest</h2>
|
||||
<ul>
|
||||
<li><a href="davical/Request/CalDAVRequest.html">CalDAVRequest</a></li></ul>
|
||||
|
||||
<h2>Root class HTTPAuthSession</h2>
|
||||
<ul>
|
||||
<li><a href="davical/HTTPAuthSession/HTTPAuthSession.html">HTTPAuthSession</a></li></ul>
|
||||
|
||||
<h2>Root class ldapDrivers</h2>
|
||||
<ul>
|
||||
<li><a href="davical/ldap/ldapDrivers.html">ldapDrivers</a></li></ul>
|
||||
|
||||
<h2>Root class squidPamDrivers</h2>
|
||||
<ul>
|
||||
<li><a href="davical/ldap/squidPamDrivers.html">squidPamDrivers</a></li></ul>
|
||||
|
||||
<h2>Root class Tools</h2>
|
||||
<ul>
|
||||
<li><a href="davical/RSCDSSession/Tools.html">Tools</a></li></ul>
|
||||
|
||||
<h2>Root class Session</h2>
|
||||
<ul>
|
||||
<li><a href="davical/RSCDSSession/RSCDSSession.html">RSCDSSession</a></li></ul>
|
||||
|
||||
<h2>Root class User</h2>
|
||||
<ul>
|
||||
<li><a href="davical/RSCDSUser/RSCDSUser.html">RSCDSUser</a></li></ul>
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:45 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</body>
|
||||
</html>
|
||||
193
docs/api/davical/Admin/_htdocs---users.php.html
Normal file
193
docs/api/davical/Admin/_htdocs---users.php.html
Normal file
@ -0,0 +1,193 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page users.php</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/htdocs/users.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Display a list of all users</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@catalyst.net.nz">andrew@catalyst.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Catalyst .Net Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_page-header_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../../davical/_inc---page-header.php.html">page-header.php</a></span>)
|
||||
(line <span class="line-number">75</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_page-footer_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../../davical/_inc---page-footer.php.html">page-footer.php</a></span>)
|
||||
(line <span class="line-number">79</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_RSCDSSession_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../../davical/RSCDSSession/_inc---RSCDSSession.php.html">RSCDSSession.php</a></span>)
|
||||
(line <span class="line-number">12</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_classBrowser_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"classBrowser.php"</span>)
|
||||
(line <span class="line-number">38</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="___/inc/always_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"../inc/always.php"</span>)
|
||||
(line <span class="line-number">11</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Display a list of all users</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@catalyst.net.nz">andrew@catalyst.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Catalyst .Net Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
<a name="_interactive-page_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../../davical/_inc---interactive-page.php.html">interactive-page.php</a></span>)
|
||||
(line <span class="line-number">15</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<a name="sec-functions"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Functions</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
| <span class="disabled">Functions</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="functiontranslate_relationship_list" id="functiontranslate_relationship_list"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Function.png" />
|
||||
<span class="method-title">translate_relationship_list</span> (line <span class="line-number">22</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-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.</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
translate_relationship_list
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$value</span>, <span class="var-type"></span> <span class="var-name">$field</span>, <span class="var-type"></span> <span class="var-name">$row</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$value</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$field</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$row</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:47 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
360
docs/api/davical/HTTPAuthSession/HTTPAuthSession.html
Normal file
360
docs/api/davical/HTTPAuthSession/HTTPAuthSession.html
Normal file
@ -0,0 +1,360 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs For Class HTTPAuthSession</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="class-name"><img src="../../media/images/Class_logo.png"
|
||||
alt=" Class"
|
||||
title=" Class"
|
||||
style="vertical-align: middle"> HTTPAuthSession</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">A Class for handling a session using HTTP Basic Authentication</p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_inc---HTTPAuthSession.php.html">/inc/HTTPAuthSession.php</a> (line <span class="field">17</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="sec-method-summary"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Method Summary</span></div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<div class="method-summary">
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Constructor.png" alt=" "/>
|
||||
<span class="method-result">HTTPAuthSession</span>
|
||||
<a href="#HTTPAuthSession" title="details" class="method-name">HTTPAuthSession</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">boolean</span>
|
||||
<a href="#AllowedTo" title="details" class="method-name">AllowedTo</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$whatever</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#AssignSessionDetails" title="details" class="method-name">AssignSessionDetails</a>
|
||||
(<span class="var-type">object</span> <span class="var-name">$u</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#AuthFailedResponse" title="details" class="method-name">AuthFailedResponse</a>
|
||||
([<span class="var-type">string</span> <span class="var-name">$auth_header</span> = <span class="var-default">""</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#BasicAuthSession" title="details" class="method-name">BasicAuthSession</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#CheckPassword" title="details" class="method-name">CheckPassword</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$username</span>, <span class="var-type"></span> <span class="var-name">$password</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#DigestAuthSession" title="details" class="method-name">DigestAuthSession</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#GetRoles" title="details" class="method-name">GetRoles</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#ParseDigestHeader" title="details" class="method-name">ParseDigestHeader</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$auth_header</span>)
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-methods"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Methods</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
<a name="methodHTTPAuthSession" id="HTTPAuthSession"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Constructor.png" />
|
||||
<span class="method-title">Constructor HTTPAuthSession</span> (line <span class="line-number">50</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">The constructor, which just calls the actual type configured</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">HTTPAuthSession</span>
|
||||
<span class="method-name">
|
||||
HTTPAuthSession
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodAllowedTo" id="AllowedTo"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">AllowedTo</span> (line <span class="line-number">236</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Checks whether a user is allowed to do something.</p>
|
||||
<p class="description"><p>The check is performed to see if the user has that role.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Whether or not the user has the specified role.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
AllowedTo
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$whatever</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$whatever</span><span class="var-description">: The role we want to know if the user has.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodAssignSessionDetails" id="AssignSessionDetails"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">AssignSessionDetails</span> (line <span class="line-number">259</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Internal function used to assign the session details to a user's new session.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
AssignSessionDetails
|
||||
</span>
|
||||
(<span class="var-type">object</span> <span class="var-name">$u</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">object</span>
|
||||
<span class="var-name">$u</span><span class="var-description">: The user+session object we (probably) read from the database.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodAuthFailedResponse" id="AuthFailedResponse"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">AuthFailedResponse</span> (line <span class="line-number">66</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Authorisation failed, so we send some headers to say so.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
AuthFailedResponse
|
||||
</span>
|
||||
([<span class="var-type">string</span> <span class="var-name">$auth_header</span> = <span class="var-default">""</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$auth_header</span><span class="var-description">: The WWW-Authenticate header details.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodBasicAuthSession" id="BasicAuthSession"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">BasicAuthSession</span> (line <span class="line-number">84</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Handle Basic HTTP Authentication (not secure unless https)</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
BasicAuthSession
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodCheckPassword" id="CheckPassword"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">CheckPassword</span> (line <span class="line-number">201</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">CheckPassword does all of the password checking and returns a user record object, or false if it all ends in tears.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
CheckPassword
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$username</span>, <span class="var-type"></span> <span class="var-name">$password</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$username</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$password</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodDigestAuthSession" id="DigestAuthSession"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">DigestAuthSession</span> (line <span class="line-number">148</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Handle Digest HTTP Authentication (no passwords were harmed in this transaction!)</p>
|
||||
<p class="description"><p>Note that this will not actually work, unless we can either: (A) store the password plain text in the database (B) store an md5( username || realm || password ) in the database</p><p>The problem is that potentially means that the administrator can collect the sorts of things people use as passwords. I believe this is quite a bad idea. In scenario (B) while they cannot see the password itself, they can see a hash which only varies when the password varies, so can see when two users have the same password, or can use some of the reverse lookup sites to attempt to reverse the hash. I think this is a less bad idea, but not ideal. Probably better than running Basic auth of HTTP though!</p></p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
DigestAuthSession
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodGetRoles" id="GetRoles"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">GetRoles</span> (line <span class="line-number">244</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Internal function used to get the user's roles from the database.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
GetRoles
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodParseDigestHeader" id="ParseDigestHeader"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">ParseDigestHeader</span> (line <span class="line-number">182</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Parse the HTTP Digest Auth Header</p>
|
||||
<p class="description"><p><ul><li>largely sourced from the PHP documentation</li></ul></p></p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
ParseDigestHeader
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$auth_header</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$auth_header</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@ -0,0 +1,69 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page HTTPAuthSession.php</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/HTTPAuthSession.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">A Class for handling HTTP Authentication</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@catalyst.net.nz">andrew@catalyst.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Catalyst .Net Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
|
||||
<img src="../../media/images/Class.png"
|
||||
alt=" class"
|
||||
title=" class"/>
|
||||
<a href="../../davical/HTTPAuthSession/HTTPAuthSession.html">HTTPAuthSession</a>
|
||||
</td>
|
||||
<td>
|
||||
A Class for handling a session using HTTP Basic Authentication
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
351
docs/api/davical/Principal/CalDAVPrincipal.html
Normal file
351
docs/api/davical/Principal/CalDAVPrincipal.html
Normal file
@ -0,0 +1,351 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs For Class CalDAVPrincipal</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="class-name"><img src="../../media/images/Class_logo.png"
|
||||
alt=" Class"
|
||||
title=" Class"
|
||||
style="vertical-align: middle"> CalDAVPrincipal</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
||||
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">A class for things to do with a DAV Principal</p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_inc---CalDAVPrincipal.php.html">/inc/CalDAVPrincipal.php</a> (line <span class="field">25</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<a name="sec-var-summary"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Variable Summary</span></div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
||||
|
|
||||
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<div class="var-summary">
|
||||
<div class="var-title">
|
||||
<img src="../../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">Whether</span>
|
||||
<a href="#$by_email" title="details" class="var-name">$by_email</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">RFC4791:</span>
|
||||
<a href="#$calendar_home_set" title="details" class="var-name">$calendar_home_set</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">draft-desruisseaux-caldav-sched-03:</span>
|
||||
<a href="#$schedule_inbox_url" title="details" class="var-name">$schedule_inbox_url</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">draft-desruisseaux-caldav-sched-03:</span>
|
||||
<a href="#$schedule_outbox_url" title="details" class="var-name">$schedule_outbox_url</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">The</span>
|
||||
<a href="#$url" title="details" class="var-name">$url</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-method-summary"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Method Summary</span></div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
||||
|
||||
|
|
||||
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<div class="method-summary">
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Constructor.png" alt=" "/>
|
||||
<span class="method-result">boolean</span>
|
||||
<a href="#CalDAVPrincipal" title="details" class="method-name">CalDAVPrincipal</a>
|
||||
([<span class="var-type">mixed</span> <span class="var-name">$parameters</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#InitialiseRecord" title="details" class="method-name">InitialiseRecord</a>
|
||||
(<span class="var-type">object</span> <span class="var-name">$usr</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#UsernameFromPath" title="details" class="method-name">UsernameFromPath</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$path</span>, [<span class="var-type">array</span> <span class="var-name">$options</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-vars"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Variables</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
||||
|
||||
|
||||
|
|
||||
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
|
||||
<a name="var$by_email" id="$by_email"><!-- --></A>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="var-header">
|
||||
<img src="../../media/images/Variable.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-type">Whether</span>
|
||||
<span class="var-name">$by_email</span>
|
||||
(line <span class="line-number">53</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">var:</span> or not we are using an e-mail address based URL.</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$calendar_home_set" id="$calendar_home_set"><!-- --></A>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="var-header">
|
||||
<img src="../../media/images/Variable.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-type">RFC4791:</span>
|
||||
<span class="var-name">$calendar_home_set</span>
|
||||
(line <span class="line-number">36</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">var:</span> Identifies the URL(s) of any WebDAV collections that contain calendar collections owned by the associated principal resource.</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$schedule_inbox_url" id="$schedule_inbox_url"><!-- --></A>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="var-header">
|
||||
<img src="../../media/images/Variable.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-type">draft-desruisseaux-caldav-sched-03:</span>
|
||||
<span class="var-name">$schedule_inbox_url</span>
|
||||
(line <span class="line-number">42</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">var:</span> Identify the URL of the scheduling Inbox collection owned by the associated principal resource.</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$schedule_outbox_url" id="$schedule_outbox_url"><!-- --></A>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="var-header">
|
||||
<img src="../../media/images/Variable.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-type">draft-desruisseaux-caldav-sched-03:</span>
|
||||
<span class="var-name">$schedule_outbox_url</span>
|
||||
(line <span class="line-number">48</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">var:</span> Identify the URL of the scheduling Outbox collection owned by the associated principal resource.</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$url" id="$url"><!-- --></A>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="var-header">
|
||||
<img src="../../media/images/Variable.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-type">The</span>
|
||||
<span class="var-name">$url</span>
|
||||
(line <span class="line-number">30</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">var:</span> home URL of the principal</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-methods"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Methods</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
||||
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
<a name="methodCalDAVPrincipal" id="CalDAVPrincipal"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Constructor.png" />
|
||||
<span class="method-title">Constructor CalDAVPrincipal</span> (line <span class="line-number">63</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Constructor</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Whether we actually read data from the DB to initialise the record.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
CalDAVPrincipal
|
||||
</span>
|
||||
([<span class="var-type">mixed</span> <span class="var-name">$parameters</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">$parameters</span><span class="var-description">: If null, an empty Principal is created. If it is an integer then that ID is read (if possible). If it is an array then the Principal matching the supplied elements is read.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodInitialiseRecord" id="InitialiseRecord"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">InitialiseRecord</span> (line <span class="line-number">103</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Initialise the Principal object from a $usr record from the DB.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
InitialiseRecord
|
||||
</span>
|
||||
(<span class="var-type">object</span> <span class="var-name">$usr</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">object</span>
|
||||
<span class="var-name">$usr</span><span class="var-description">: The usr record from the DB.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodUsernameFromPath" id="UsernameFromPath"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">UsernameFromPath</span> (line <span class="line-number">134</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Work out the username, based on elements of the path.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
UsernameFromPath
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$path</span>, [<span class="var-type">array</span> <span class="var-name">$options</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$path</span><span class="var-description">: The path to be used.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">array</span>
|
||||
<span class="var-name">$options</span><span class="var-description">: The request options, controlling whether e-mail paths are allowed.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
69
docs/api/davical/Principal/_inc---CalDAVPrincipal.php.html
Normal file
69
docs/api/davical/Principal/_inc---CalDAVPrincipal.php.html
Normal file
@ -0,0 +1,69 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page CalDAVPrincipal.php</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/CalDAVPrincipal.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">An object representing a DAV 'Principal'</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@mcmillan.net.nz">andrew@mcmillan.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Catalyst .Net Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
|
||||
<img src="../../media/images/Class.png"
|
||||
alt=" class"
|
||||
title=" class"/>
|
||||
<a href="../../davical/Principal/CalDAVPrincipal.html">CalDAVPrincipal</a>
|
||||
</td>
|
||||
<td>
|
||||
A class for things to do with a DAV Principal
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
236
docs/api/davical/RSCDSSession/RSCDSSession.html
Normal file
236
docs/api/davical/RSCDSSession/RSCDSSession.html
Normal file
@ -0,0 +1,236 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs For Class RSCDSSession</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="class-name"><img src="../../media/images/Class_logo.png"
|
||||
alt=" Class"
|
||||
title=" Class"
|
||||
style="vertical-align: middle"> RSCDSSession</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">A class for creating and holding session information.</p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_inc---RSCDSSession.php.html">/inc/RSCDSSession.php</a> (line <span class="field">50</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre>Session
|
||||
|
|
||||
--RSCDSSession</pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="sec-method-summary"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Method Summary</span></div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<div class="method-summary">
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Constructor.png" alt=" "/>
|
||||
<span class="method-result">RSCDSSession</span>
|
||||
<a href="#RSCDSSession" title="details" class="method-name">RSCDSSession</a>
|
||||
([<span class="var-type">string</span> <span class="var-name">$sid</span> = <span class="var-default">""</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#AssignSessionDetails" title="details" class="method-name">AssignSessionDetails</a>
|
||||
(<span class="var-type">object</span> <span class="var-name">$u</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#GetRelationships" title="details" class="method-name">GetRelationships</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#GetRoles" title="details" class="method-name">GetRoles</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">boolean</span>
|
||||
<a href="#LoginRequired" title="details" class="method-name">LoginRequired</a>
|
||||
([<span class="var-type">string</span> <span class="var-name">$roles</span> = <span class="var-default">""</span>])
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-methods"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Methods</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
<a name="methodRSCDSSession" id="RSCDSSession"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Constructor.png" />
|
||||
<span class="method-title">Constructor RSCDSSession</span> (line <span class="line-number">61</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Create a new RSCDSSession object.</p>
|
||||
<p class="description"><p>We create a Session and extend it with some additional useful RSCDS related information.</p></p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">RSCDSSession</span>
|
||||
<span class="method-name">
|
||||
RSCDSSession
|
||||
</span>
|
||||
([<span class="var-type">string</span> <span class="var-name">$sid</span> = <span class="var-default">""</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$sid</span><span class="var-description">: A session identifier.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodAssignSessionDetails" id="AssignSessionDetails"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">AssignSessionDetails</span> (line <span class="line-number">70</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Internal function used to assign the session details to a user's new session.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
AssignSessionDetails
|
||||
</span>
|
||||
(<span class="var-type">object</span> <span class="var-name">$u</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">object</span>
|
||||
<span class="var-name">$u</span><span class="var-description">: The user+session object we (probably) read from the database.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodGetRelationships" id="GetRelationships"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">GetRelationships</span> (line <span class="line-number">98</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Method used to get the user's relationships</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
GetRelationships
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodGetRoles" id="GetRoles"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">GetRoles</span> (line <span class="line-number">83</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Method used to get the user's roles</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
GetRoles
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodLoginRequired" id="LoginRequired"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">LoginRequired</span> (line <span class="line-number">120</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Checks that this user is logged in, and presents a login screen if they aren't.</p>
|
||||
<p class="description"><p>The function can optionally confirm whether they are a member of one of a list of roles, and deny access if they are not a member of any of them.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Whether or not the user is logged in and is a member of one of the required roles.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
LoginRequired
|
||||
</span>
|
||||
([<span class="var-type">string</span> <span class="var-name">$roles</span> = <span class="var-default">""</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$roles</span><span class="var-description">: The list of roles that the user must be a member of one of to be allowed to proceed.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
181
docs/api/davical/RSCDSSession/Tools.html
Normal file
181
docs/api/davical/RSCDSSession/Tools.html
Normal file
@ -0,0 +1,181 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs For Class Tools</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="class-name"><img src="../../media/images/Class_logo.png"
|
||||
alt=" Class"
|
||||
title=" Class"
|
||||
style="vertical-align: middle"> Tools</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_htdocs---tools.php.html">/htdocs/tools.php</a> (line <span class="field">36</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="sec-method-summary"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Method Summary</span></div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<div class="method-summary">
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#importFromDirectory" title="details" class="method-name">importFromDirectory</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#render" title="details" class="method-name">render</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#renderImportFromDirectory" title="details" class="method-name">renderImportFromDirectory</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#renderSyncLDAP" title="details" class="method-name">renderSyncLDAP</a>
|
||||
()
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-methods"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Methods</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
<a name="methodimportFromDirectory" id="importFromDirectory"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">importFromDirectory</span> (line <span class="line-number">97</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
importFromDirectory
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodrender" id="render"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">render</span> (line <span class="line-number">38</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
render
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodrenderImportFromDirectory" id="renderImportFromDirectory"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">renderImportFromDirectory</span> (line <span class="line-number">70</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
renderImportFromDirectory
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodrenderSyncLDAP" id="renderSyncLDAP"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">renderSyncLDAP</span> (line <span class="line-number">46</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
renderSyncLDAP
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:47 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
193
docs/api/davical/RSCDSSession/_htdocs---tools.php.html
Normal file
193
docs/api/davical/RSCDSSession/_htdocs---tools.php.html
Normal file
@ -0,0 +1,193 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page tools.php</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/htdocs/tools.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Tools for manipulating calendars</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Maxime Delorme <<a href="mailto:mdelorme@tennaxia.com">mdelorme@tennaxia.com</a>></li>
|
||||
<li><span class="field">copyright:</span> Maxime Delorme</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
|
||||
<img src="../../media/images/Class.png"
|
||||
alt=" class"
|
||||
title=" class"/>
|
||||
<a href="../../davical/RSCDSSession/Tools.html">Tools</a>
|
||||
</td>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_page-header_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../../davical/_inc---page-header.php.html">page-header.php</a></span>)
|
||||
(line <span class="line-number">32</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_page-footer_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../../davical/_inc---page-footer.php.html">page-footer.php</a></span>)
|
||||
(line <span class="line-number">154</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_DataEntry_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"DataEntry.php"</span>)
|
||||
(line <span class="line-number">16</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="___/inc/always_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"../inc/always.php"</span>)
|
||||
(line <span class="line-number">12</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Tools for manipulating calendars</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Maxime Delorme <<a href="mailto:mdelorme@tennaxia.com">mdelorme@tennaxia.com</a>></li>
|
||||
<li><span class="field">copyright:</span> Maxime Delorme</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
<a name="_interactive-page_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../../davical/_inc---interactive-page.php.html">interactive-page.php</a></span>)
|
||||
(line <span class="line-number">17</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_classBrowser_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"classBrowser.php"</span>)
|
||||
(line <span class="line-number">18</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_RSCDSSession_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../../davical/RSCDSSession/_inc---RSCDSSession.php.html">RSCDSSession.php</a></span>)
|
||||
(line <span class="line-number">13</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:47 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
192
docs/api/davical/RSCDSSession/_inc---RSCDSSession.php.html
Normal file
192
docs/api/davical/RSCDSSession/_inc---RSCDSSession.php.html
Normal file
@ -0,0 +1,192 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page RSCDSSession.php</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/RSCDSSession.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
| <a href="#sec-variables">Variables</a>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">DAViCal extensions to AWL Session handling</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@catalyst.net.nz">andrew@catalyst.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Catalyst .Net Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
| <a href="#sec-variables">Variables</a>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
|
||||
<img src="../../media/images/Class.png"
|
||||
alt=" class"
|
||||
title=" class"/>
|
||||
<a href="../../davical/RSCDSSession/RSCDSSession.html">RSCDSSession</a>
|
||||
</td>
|
||||
<td>
|
||||
A class for creating and holding session information.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <span class="disabled">Includes</span>
|
||||
| <a href="#sec-variables">Variables</a>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_PgQuery_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">'PgQuery.php'</span>)
|
||||
(line <span class="line-number">15</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">All session data is held in the database.</p>
|
||||
|
||||
</div>
|
||||
<a name="_Session_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">'Session.php'</span>)
|
||||
(line <span class="line-number">41</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">We extend the AWL Session class.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-variables"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Variables</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
| <span class="disabled">Variables</span>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="global$session
|
||||
The session object is global." id="global$session
|
||||
The session object is global."><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Global.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-type">resource</span>
|
||||
<span class="var-name">$session
|
||||
The session object is global.</span>
|
||||
(line <span class="line-number">22</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">name:</span> $session
|
||||
The session object is global.</li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-functions"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Functions</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
| <a href="#sec-variables">Variables</a>
|
||||
| <span class="disabled">Functions</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="functionlocal_session_sql" id="functionlocal_session_sql"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Function.png" />
|
||||
<span class="method-title">local_session_sql</span> (line <span class="line-number">31</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">todo:</span> Make this a defined constant</li>
|
||||
</ul>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
local_session_sql
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
432
docs/api/davical/RSCDSUser/RSCDSUser.html
Normal file
432
docs/api/davical/RSCDSUser/RSCDSUser.html
Normal file
@ -0,0 +1,432 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs For Class RSCDSUser</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="class-name"><img src="../../media/images/Class_logo.png"
|
||||
alt=" Class"
|
||||
title=" Class"
|
||||
style="vertical-align: middle"> RSCDSUser</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">A class for viewing and maintaining DAViCal User records</p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_inc---RSCDSUser.php.html">/inc/RSCDSUser.php</a> (line <span class="field">24</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre>User
|
||||
|
|
||||
--RSCDSUser</pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="sec-method-summary"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Method Summary</span></div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<div class="method-summary">
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Constructor.png" alt=" "/>
|
||||
<span class="method-result">RSCDSUser</span>
|
||||
<a href="#RSCDSUser" title="details" class="method-name">RSCDSUser</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$id</span>, [<span class="var-type"></span> <span class="var-name">$prefix</span> = <span class="var-default">""</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">boolean</span>
|
||||
<a href="#AllowedTo" title="details" class="method-name">AllowedTo</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$whatever</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#HandleAction" title="details" class="method-name">HandleAction</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$action</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">string</span>
|
||||
<a href="#Render" title="details" class="method-name">Render</a>
|
||||
([<span class="var-type"></span> <span class="var-name">$title</span> = <span class="var-default">""</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">string</span>
|
||||
<a href="#RenderCollections" title="details" class="method-name">RenderCollections</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$ef</span>, [<span class="var-type"></span> <span class="var-name">$title</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">string</span>
|
||||
<a href="#RenderImportIcs" title="details" class="method-name">RenderImportIcs</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$ef</span>, [<span class="var-type"></span> <span class="var-name">$title</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">string</span>
|
||||
<a href="#RenderRelationshipsFrom" title="details" class="method-name">RenderRelationshipsFrom</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$ef</span>, [<span class="var-type"></span> <span class="var-name">$title</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">string</span>
|
||||
<a href="#RenderRelationshipsTo" title="details" class="method-name">RenderRelationshipsTo</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$ef</span>, [<span class="var-type"></span> <span class="var-name">$title</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">boolean</span>
|
||||
<a href="#Validate" title="details" class="method-name">Validate</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#Write" title="details" class="method-name">Write</a>
|
||||
()
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-methods"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Methods</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
<a name="methodRSCDSUser" id="RSCDSUser"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Constructor.png" />
|
||||
<span class="method-title">Constructor RSCDSUser</span> (line <span class="line-number">30</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Constructor - nothing fancy as yet.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">RSCDSUser</span>
|
||||
<span class="method-name">
|
||||
RSCDSUser
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$id</span>, [<span class="var-type"></span> <span class="var-name">$prefix</span> = <span class="var-default">""</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$id</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$prefix</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodAllowedTo" id="AllowedTo"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">AllowedTo</span> (line <span class="line-number">279</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Extend parent definition of what the current user is allowed to do</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Whether they are allowed to.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
AllowedTo
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$whatever</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$whatever</span><span class="var-description">: What the user wants to do</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodHandleAction" id="HandleAction"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">HandleAction</span> (line <span class="line-number">302</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Handle any unusual actions we might invent</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
HandleAction
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$action</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$action</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodRender" id="Render"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">Render</span> (line <span class="line-number">38</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Render the form / viewer as HTML to show the user</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> An HTML fragment to display in the page.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
Render
|
||||
</span>
|
||||
([<span class="var-type"></span> <span class="var-name">$title</span> = <span class="var-default">""</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$title</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodRenderCollections" id="RenderCollections"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">RenderCollections</span> (line <span class="line-number">232</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Render the user's collections</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> The string of html to be output</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
RenderCollections
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$ef</span>, [<span class="var-type"></span> <span class="var-name">$title</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$ef</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$title</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodRenderImportIcs" id="RenderImportIcs"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">RenderImportIcs</span> (line <span class="line-number">82</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Render input file to import ics in calendar user</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> The string of html to be output</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
RenderImportIcs
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$ef</span>, [<span class="var-type"></span> <span class="var-name">$title</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$ef</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$title</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodRenderRelationshipsFrom" id="RenderRelationshipsFrom"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">RenderRelationshipsFrom</span> (line <span class="line-number">104</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Render the user's relationships to other users & resources</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> The string of html to be output</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
RenderRelationshipsFrom
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$ef</span>, [<span class="var-type"></span> <span class="var-name">$title</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$ef</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$title</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodRenderRelationshipsTo" id="RenderRelationshipsTo"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">RenderRelationshipsTo</span> (line <span class="line-number">154</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Render the user's relationships to other users & resources</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> The string of html to be output</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
RenderRelationshipsTo
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$ef</span>, [<span class="var-type"></span> <span class="var-name">$title</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$ef</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$title</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodValidate" id="Validate"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">Validate</span> (line <span class="line-number">269</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Validate the information the user submitted</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Whether the form data validated OK.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
Validate
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodWrite" id="Write"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">Write</span> (line <span class="line-number">332</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Write the record to the file</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
Write
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:47 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
127
docs/api/davical/RSCDSUser/_inc---RSCDSUser.php.html
Normal file
127
docs/api/davical/RSCDSUser/_inc---RSCDSUser.php.html
Normal file
@ -0,0 +1,127 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page RSCDSUser.php</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/RSCDSUser.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">User maintain / view with DAViCal specific associated tables</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@catalyst.net.nz">andrew@catalyst.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Catalyst .Net Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
|
||||
<img src="../../media/images/Class.png"
|
||||
alt=" class"
|
||||
title=" class"/>
|
||||
<a href="../../davical/RSCDSUser/RSCDSUser.html">RSCDSUser</a>
|
||||
</td>
|
||||
<td>
|
||||
A class for viewing and maintaining DAViCal User records
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_User_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"User.php"</span>)
|
||||
(line <span class="line-number">12</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_classBrowser_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"classBrowser.php"</span>)
|
||||
(line <span class="line-number">13</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_auth-functions_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../../davical/authentication/_inc---auth-functions.php.html">"auth-functions.php"</a></span>)
|
||||
(line <span class="line-number">14</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:47 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
887
docs/api/davical/Request/CalDAVRequest.html
Normal file
887
docs/api/davical/Request/CalDAVRequest.html
Normal file
@ -0,0 +1,887 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs For Class CalDAVRequest</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="class-name"><img src="../../media/images/Class_logo.png"
|
||||
alt=" Class"
|
||||
title=" Class"
|
||||
style="vertical-align: middle"> CalDAVRequest</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
||||
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">A class for collecting things to do with this request.</p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_inc---CalDAVRequest.php.html">/inc/CalDAVRequest.php</a> (line <span class="field">27</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<a name="sec-var-summary"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Variable Summary</span></div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
||||
|
|
||||
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<div class="var-summary">
|
||||
<div class="var-title">
|
||||
<img src="../../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">mixed</span>
|
||||
<a href="#$collection_id" title="details" class="var-name">$collection_id</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">mixed</span>
|
||||
<a href="#$collection_path" title="details" class="var-name">$collection_path</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">mixed</span>
|
||||
<a href="#$depth" title="details" class="var-name">$depth</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">mixed</span>
|
||||
<a href="#$method" title="details" class="var-name">$method</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">mixed</span>
|
||||
<a href="#$options" title="details" class="var-name">$options</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">mixed</span>
|
||||
<a href="#$principal" title="details" class="var-name">$principal</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">mixed</span>
|
||||
<a href="#$raw_post" title="details" class="var-name">$raw_post</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">mixed</span>
|
||||
<a href="#$user_agent" title="details" class="var-name">$user_agent</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-method-summary"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Method Summary</span></div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
||||
|
||||
|
|
||||
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<div class="method-summary">
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Constructor.png" alt=" "/>
|
||||
<span class="method-result">CalDAVRequest</span>
|
||||
<a href="#CalDAVRequest" title="details" class="method-name">CalDAVRequest</a>
|
||||
([<span class="var-type"></span> <span class="var-name">$options</span> = <span class="var-default">array()</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#AllowedTo" title="details" class="method-name">AllowedTo</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$activity</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#DepthRegexTail" title="details" class="method-name">DepthRegexTail</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#DoResponse" title="details" class="method-name">DoResponse</a>
|
||||
(<span class="var-type">int</span> <span class="var-name">$status</span>, [<span class="var-type">string</span> <span class="var-name">$message</span> = <span class="var-default">""</span>], [<span class="var-type"></span> <span class="var-name">$content_type</span> = <span class="var-default">"text/plain; charset=\"utf-8\""</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">mixed</span>
|
||||
<a href="#FailIfLocked" title="details" class="method-name">FailIfLocked</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#GetDepthName" title="details" class="method-name">GetDepthName</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#GetLockDetails" title="details" class="method-name">GetLockDetails</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$lock_token</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#GetLockRow" title="details" class="method-name">GetLockRow</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$lock_token</span>, <span class="var-type">string</span> <span class="var-name">$dav_name</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#IsCollection" title="details" class="method-name">IsCollection</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#IsInfiniteDepth" title="details" class="method-name">IsInfiniteDepth</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#IsLocked" title="details" class="method-name">IsLocked</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$dav_name</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#IsPrincipal" title="details" class="method-name">IsPrincipal</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#setPermissions" title="details" class="method-name">setPermissions</a>
|
||||
(<span class="var-type">int</span> <span class="var-name">$user_no</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">array</span>
|
||||
<a href="#SupportedPrivileges" title="details" class="method-name">SupportedPrivileges</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#UnsupportedRequest" title="details" class="method-name">UnsupportedRequest</a>
|
||||
(<span class="var-type">array</span> <span class="var-name">$unsupported</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#UserFromPath" title="details" class="method-name">UserFromPath</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#ValidateLockToken" title="details" class="method-name">ValidateLockToken</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$lock_token</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#XMLResponse" title="details" class="method-name">XMLResponse</a>
|
||||
(<span class="var-type">int</span> <span class="var-name">$status</span>, <span class="var-type">XMLElement</span> <span class="var-name">$xmltree</span>)
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-vars"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Variables</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
||||
|
||||
|
||||
|
|
||||
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
|
||||
<a name="var$collection_id" id="$collection_id"><!-- --></A>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="var-header">
|
||||
<img src="../../media/images/Variable.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">$collection_id</span>
|
||||
(line <span class="line-number">60</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">The ID of the collection containing this path, or of this path if it is a collection</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$collection_path" id="$collection_path"><!-- --></A>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="var-header">
|
||||
<img src="../../media/images/Variable.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">$collection_path</span>
|
||||
(line <span class="line-number">65</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">The path corresponding to the collection_id</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$depth" id="$depth"><!-- --></A>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="var-header">
|
||||
<img src="../../media/images/Variable.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">$depth</span>
|
||||
(line <span class="line-number">45</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-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.</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$method" id="$method"><!-- --></A>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="var-header">
|
||||
<img src="../../media/images/Variable.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">$method</span>
|
||||
(line <span class="line-number">39</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">The HTTP request method: PROPFIND, LOCK, REPORT, OPTIONS, etc...</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$options" id="$options"><!-- --></A>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="var-header">
|
||||
<img src="../../media/images/Variable.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">$options</span>
|
||||
(line <span class="line-number">29</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$principal" id="$principal"><!-- --></A>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="var-header">
|
||||
<img src="../../media/images/Variable.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">$principal</span>
|
||||
(line <span class="line-number">50</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">The 'principal' (user/resource/...) which this request seeks to access</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$raw_post" id="$raw_post"><!-- --></A>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="var-header">
|
||||
<img src="../../media/images/Variable.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">$raw_post</span>
|
||||
(line <span class="line-number">34</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">The raw data sent along with the request</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$user_agent" id="$user_agent"><!-- --></A>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="var-header">
|
||||
<img src="../../media/images/Variable.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">$user_agent</span>
|
||||
(line <span class="line-number">55</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">The user agent making the request.</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-methods"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Methods</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
||||
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
<a name="methodCalDAVRequest" id="CalDAVRequest"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Constructor.png" />
|
||||
<span class="method-title">Constructor CalDAVRequest</span> (line <span class="line-number">70</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Create a new CalDAVRequest object.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">CalDAVRequest</span>
|
||||
<span class="method-name">
|
||||
CalDAVRequest
|
||||
</span>
|
||||
([<span class="var-type"></span> <span class="var-name">$options</span> = <span class="var-default">array()</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$options</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodAllowedTo" id="AllowedTo"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">AllowedTo</span> (line <span class="line-number">531</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Are we allowed to do the requested activity</p>
|
||||
<p class="description"><p>+------------+------------------------------------------------------+ | METHOD | PRIVILEGES | +------------+------------------------------------------------------+ | MKCALENDAR | DAV:bind | | REPORT | DAV:read or CALDAV:read-free-busy (on all referenced | | | resources) | +------------+------------------------------------------------------+</p></p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
AllowedTo
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$activity</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$activity</span><span class="var-description">: The activity we want to do.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodDepthRegexTail" id="DepthRegexTail"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">DepthRegexTail</span> (line <span class="line-number">377</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the tail of a Regex appropriate for this Depth, when appended to</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
DepthRegexTail
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodDoResponse" id="DoResponse"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">DoResponse</span> (line <span class="line-number">610</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Utility function we call when we have a simple status-based response to return to the client. Possibly</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
DoResponse
|
||||
</span>
|
||||
(<span class="var-type">int</span> <span class="var-name">$status</span>, [<span class="var-type">string</span> <span class="var-name">$message</span> = <span class="var-default">""</span>], [<span class="var-type"></span> <span class="var-name">$content_type</span> = <span class="var-default">"text/plain; charset=\"utf-8\""</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">int</span>
|
||||
<span class="var-name">$status</span><span class="var-description">: The HTTP status code to send.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$message</span><span class="var-description">: The friendly text message to send with the response.</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$content_type</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodFailIfLocked" id="FailIfLocked"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">FailIfLocked</span> (line <span class="line-number">456</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-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.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> false (no lock) or opaquelocktoken (opened lock)</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">mixed</span>
|
||||
<span class="method-name">
|
||||
FailIfLocked
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodGetDepthName" id="GetDepthName"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">GetDepthName</span> (line <span class="line-number">368</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the name for this depth: 0, 1, infinity</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
GetDepthName
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodGetLockDetails" id="GetLockDetails"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">GetLockDetails</span> (line <span class="line-number">442</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the DB object associated with a lock token, or false.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
GetLockDetails
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$lock_token</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$lock_token</span><span class="var-description">: The opaquelocktoken which we are looking for</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodGetLockRow" id="GetLockRow"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">GetLockRow</span> (line <span class="line-number">388</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the locked row, either from the cache or from the database</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
GetLockRow
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$lock_token</span>, <span class="var-type">string</span> <span class="var-name">$dav_name</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$dav_name</span><span class="var-description">: The resource which we want to know the lock status for</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$lock_token</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodIsCollection" id="IsCollection"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">IsCollection</span> (line <span class="line-number">491</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns true if the URL referenced by this request points at a collection.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
IsCollection
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodIsInfiniteDepth" id="IsInfiniteDepth"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">IsInfiniteDepth</span> (line <span class="line-number">513</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns true if the request asked for infinite depth</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
IsInfiniteDepth
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodIsLocked" id="IsLocked"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">IsLocked</span> (line <span class="line-number">336</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Checks whether the resource is locked, returning any lock token, or false</p>
|
||||
<p class="description"><p>FIXME: This logic does not catch all locking scenarios. For example an infinite depth request should check the permissions for all collections and resources within that. At present we only maintain permissions on a per-collection basis though.</p></p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
IsLocked
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$dav_name</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$dav_name</span><span class="var-description">: The resource which we want to know the lock status for</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodIsPrincipal" id="IsPrincipal"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">IsPrincipal</span> (line <span class="line-number">502</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns true if the URL referenced by this request points at a principal.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
IsPrincipal
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsetPermissions" id="setPermissions"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">setPermissions</span> (line <span class="line-number">285</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Permissions are controlled as follows:</p>
|
||||
<p class="description"><p><ol><li>if the path is '/', the request has read privileges</li><li>if the requester is an admin, the request has read/write priviliges</li><li>if there is a <user name> component which matches the logged on user
|
||||
then the request has read/write privileges</li><li>otherwise we query the defined relationships between users and use
|
||||
the minimum privileges returned from that analysis.</li></ol></p></p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setPermissions
|
||||
</span>
|
||||
(<span class="var-type">int</span> <span class="var-name">$user_no</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">int</span>
|
||||
<span class="var-name">$user_no</span><span class="var-description">: The current user number</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodSupportedPrivileges" id="SupportedPrivileges"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">SupportedPrivileges</span> (line <span class="line-number">632</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Return an array of what the DAV privileges are that are supported</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> The supported privileges.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
SupportedPrivileges
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodUnsupportedRequest" id="UnsupportedRequest"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">UnsupportedRequest</span> (line <span class="line-number">575</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sometimes it's a perfectly formed request, but we just don't do that :-(</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
UnsupportedRequest
|
||||
</span>
|
||||
(<span class="var-type">array</span> <span class="var-name">$unsupported</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">array</span>
|
||||
<span class="var-name">$unsupported</span><span class="var-description">: An array of the properties we don't support.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodUserFromPath" id="UserFromPath"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">UserFromPath</span> (line <span class="line-number">244</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Work out the user whose calendar we are accessing, based on elements of the path.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
UserFromPath
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodValidateLockToken" id="ValidateLockToken"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">ValidateLockToken</span> (line <span class="line-number">414</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Checks to see whether the lock token given matches one of the ones handed in with the request.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
ValidateLockToken
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$lock_token</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$lock_token</span><span class="var-description">: The opaquelocktoken which we are looking for</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodXMLResponse" id="XMLResponse"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">XMLResponse</span> (line <span class="line-number">595</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Send an XML Response. This function will never return.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
XMLResponse
|
||||
</span>
|
||||
(<span class="var-type">int</span> <span class="var-name">$status</span>, <span class="var-type">XMLElement</span> <span class="var-name">$xmltree</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">int</span>
|
||||
<span class="var-name">$status</span><span class="var-description">: The HTTP status to respond</span> </li>
|
||||
<li>
|
||||
<span class="var-type">XMLElement</span>
|
||||
<span class="var-name">$xmltree</span><span class="var-description">: An XMLElement tree to be rendered</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
152
docs/api/davical/Request/_inc---CalDAVRequest.php.html
Normal file
152
docs/api/davical/Request/_inc---CalDAVRequest.php.html
Normal file
@ -0,0 +1,152 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page CalDAVRequest.php</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/CalDAVRequest.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
| <a href="#sec-constants">Constants</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Functions that are needed for all CalDAV Requests</p>
|
||||
<p class="description"><p><ul><li>Ascertaining the paths</li><li>Ascertaining the current user's permission to those paths.</li><li>Utility functions which we can use to decide whether this
|
||||
is a permitted activity for this user.</li></ul></p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@mcmillan.net.nz">andrew@mcmillan.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Catalyst .Net Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
| <a href="#sec-constants">Constants</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
|
||||
<img src="../../media/images/Class.png"
|
||||
alt=" class"
|
||||
title=" class"/>
|
||||
<a href="../../davical/Request/CalDAVRequest.html">CalDAVRequest</a>
|
||||
</td>
|
||||
<td>
|
||||
A class for collecting things to do with this request.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <span class="disabled">Includes</span>
|
||||
| <a href="#sec-constants">Constants</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_XMLElement_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"XMLElement.php"</span>)
|
||||
(line <span class="line-number">17</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Functions that are needed for all CalDAV Requests</p>
|
||||
<p class="description"><p><ul><li>Ascertaining the paths</li><li>Ascertaining the current user's permission to those paths.</li><li>Utility functions which we can use to decide whether this
|
||||
is a permitted activity for this user.</li></ul></p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@mcmillan.net.nz">andrew@mcmillan.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Catalyst .Net Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
<a name="_CalDAVPrincipal_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../../davical/Principal/_inc---CalDAVPrincipal.php.html">"CalDAVPrincipal.php"</a></span>)
|
||||
(line <span class="line-number">18</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-constants"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Constants</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
| <span class="disabled">Constants</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="defineDEPTH_INFINITY"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Constant.png" />
|
||||
<span class="const-title">
|
||||
<span class="const-name">DEPTH_INFINITY</span> = 9999
|
||||
(line <span class="line-number">20</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
166
docs/api/davical/_htdocs---collection.php.html
Normal file
166
docs/api/davical/_htdocs---collection.php.html
Normal file
@ -0,0 +1,166 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page collection.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/htdocs/collection.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_page-header_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---page-header.php.html">page-header.php</a></span>)
|
||||
(line <span class="line-number">48</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_page-footer_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---page-footer.php.html">page-footer.php</a></span>)
|
||||
(line <span class="line-number">13</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_page-header_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---page-header.php.html">page-header.php</a></span>)
|
||||
(line <span class="line-number">12</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_page-footer_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---page-footer.php.html">page-footer.php</a></span>)
|
||||
(line <span class="line-number">52</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="___/inc/always_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"../inc/always.php"</span>)
|
||||
(line <span class="line-number">2</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_classBrowser_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"classBrowser.php"</span>)
|
||||
(line <span class="line-number">17</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_interactive-page_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---interactive-page.php.html">interactive-page.php</a></span>)
|
||||
(line <span class="line-number">6</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_RSCDSSession_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../davical/RSCDSSession/_inc---RSCDSSession.php.html">RSCDSSession.php</a></span>)
|
||||
(line <span class="line-number">3</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
108
docs/api/davical/_htdocs---freebusy.php.html
Normal file
108
docs/api/davical/_htdocs---freebusy.php.html
Normal file
@ -0,0 +1,108 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page freebusy.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/htdocs/freebusy.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_freebusy-GET_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include_once</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---freebusy-GET.php.html">freebusy-GET.php</a></span>)
|
||||
(line <span class="line-number">22</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">We also allow URLs like .../freebusy.php/user@example.com to work, so long as the e-mail matches a single user whose calendar we have rights to.</p>
|
||||
<p class="description"><p>NOTE: It is OK for there to *be* duplicate e-mail addresses, just so long as we only have read permission (or more) for only one of them.</p></p>
|
||||
|
||||
</div>
|
||||
<a name="___/inc/always_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"../inc/always.php"</span>)
|
||||
(line <span class="line-number">2</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_CalDAVRequest_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../davical/Request/_inc---CalDAVRequest.php.html">CalDAVRequest.php</a></span>)
|
||||
(line <span class="line-number">8</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_HTTPAuthSession_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../davical/HTTPAuthSession/_inc---HTTPAuthSession.php.html">HTTPAuthSession.php</a></span>)
|
||||
(line <span class="line-number">5</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
121
docs/api/davical/_htdocs---help.php.html
Normal file
121
docs/api/davical/_htdocs---help.php.html
Normal file
@ -0,0 +1,121 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page help.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/htdocs/help.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_page-footer_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---page-footer.php.html">page-footer.php</a></span>)
|
||||
(line <span class="line-number">18</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_page-header_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---page-header.php.html">page-header.php</a></span>)
|
||||
(line <span class="line-number">9</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="___/inc/always_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"../inc/always.php"</span>)
|
||||
(line <span class="line-number">2</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_interactive-page_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---interactive-page.php.html">interactive-page.php</a></span>)
|
||||
(line <span class="line-number">6</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_RSCDSSession_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../davical/RSCDSSession/_inc---RSCDSSession.php.html">RSCDSSession.php</a></span>)
|
||||
(line <span class="line-number">3</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
137
docs/api/davical/_htdocs---index.php.html
Normal file
137
docs/api/davical/_htdocs---index.php.html
Normal file
@ -0,0 +1,137 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page index.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/htdocs/index.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="___/inc/always_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name">"../inc/always.php"</span>)
|
||||
(line <span class="line-number">10</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="__/caldav_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/caldav/_htdocs---caldav.php.html">"./caldav.php"</a></span>)
|
||||
(line <span class="line-number">6</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">If the request is not a GET or POST then they must really want caldav.php!</p>
|
||||
|
||||
</div>
|
||||
<a name="_RSCDSSession_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/RSCDSSession/_inc---RSCDSSession.php.html">RSCDSSession.php</a></span>)
|
||||
(line <span class="line-number">11</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_interactive-page_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---interactive-page.php.html">interactive-page.php</a></span>)
|
||||
(line <span class="line-number">14</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_page-footer_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---page-footer.php.html">page-footer.php</a></span>)
|
||||
(line <span class="line-number">69</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_page-header_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---page-header.php.html">page-header.php</a></span>)
|
||||
(line <span class="line-number">15</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
166
docs/api/davical/_htdocs---relationship_types.php.html
Normal file
166
docs/api/davical/_htdocs---relationship_types.php.html
Normal file
@ -0,0 +1,166 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page relationship_types.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/htdocs/relationship_types.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_page-header_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---page-header.php.html">page-header.php</a></span>)
|
||||
(line <span class="line-number">98</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_page-footer_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---page-footer.php.html">page-footer.php</a></span>)
|
||||
(line <span class="line-number">108</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_interactive-page_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---interactive-page.php.html">interactive-page.php</a></span>)
|
||||
(line <span class="line-number">6</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="___/inc/always_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"../inc/always.php"</span>)
|
||||
(line <span class="line-number">2</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_RSCDSSession_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../davical/RSCDSSession/_inc---RSCDSSession.php.html">RSCDSSession.php</a></span>)
|
||||
(line <span class="line-number">3</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_DataUpdate_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"DataUpdate.php"</span>)
|
||||
(line <span class="line-number">9</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_classBrowser_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"classBrowser.php"</span>)
|
||||
(line <span class="line-number">10</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_DataEntry_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"DataEntry.php"</span>)
|
||||
(line <span class="line-number">8</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
136
docs/api/davical/_htdocs---roles.php.html
Normal file
136
docs/api/davical/_htdocs---roles.php.html
Normal file
@ -0,0 +1,136 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page roles.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/htdocs/roles.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_page-header_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---page-header.php.html">page-header.php</a></span>)
|
||||
(line <span class="line-number">36</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_page-footer_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---page-footer.php.html">page-footer.php</a></span>)
|
||||
(line <span class="line-number">39</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="___/inc/always_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"../inc/always.php"</span>)
|
||||
(line <span class="line-number">2</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_RSCDSSession_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../davical/RSCDSSession/_inc---RSCDSSession.php.html">RSCDSSession.php</a></span>)
|
||||
(line <span class="line-number">3</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_classBrowser_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"classBrowser.php"</span>)
|
||||
(line <span class="line-number">9</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_interactive-page_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---interactive-page.php.html">interactive-page.php</a></span>)
|
||||
(line <span class="line-number">6</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
169
docs/api/davical/_htdocs---usr.php.html
Normal file
169
docs/api/davical/_htdocs---usr.php.html
Normal file
@ -0,0 +1,169 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page usr.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/htdocs/usr.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_caldav-PUT-functions_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---caldav-PUT-functions.php.html">caldav-PUT-functions.php</a></span>)
|
||||
(line <span class="line-number">55</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_page-footer_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---page-footer.php.html">page-footer.php</a></span>)
|
||||
(line <span class="line-number">94</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_check_UTF8_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---check_UTF8.php.html">check_UTF8.php</a></span>)
|
||||
(line <span class="line-number">52</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">If the user has uploaded a .ics file as a calendar, we fake this out</p>
|
||||
<p class="description"><p>as if it were a "PUT" request against a collection. This is something of a hack. It works though :-)</p></p>
|
||||
|
||||
</div>
|
||||
<a name="_page-header_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---page-header.php.html">page-header.php</a></span>)
|
||||
(line <span class="line-number">92</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Handle any actions, such as 'delete_relation'</p>
|
||||
|
||||
</div>
|
||||
<a name="___/inc/always_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"../inc/always.php"</span>)
|
||||
(line <span class="line-number">2</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_interactive-page_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---interactive-page.php.html">interactive-page.php</a></span>)
|
||||
(line <span class="line-number">7</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_RSCDSSession_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../davical/RSCDSSession/_inc---RSCDSSession.php.html">RSCDSSession.php</a></span>)
|
||||
(line <span class="line-number">3</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_RSCDSUser_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../davical/RSCDSUser/_inc---RSCDSUser.php.html">RSCDSUser.php</a></span>)
|
||||
(line <span class="line-number">9</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:47 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
62
docs/api/davical/_inc---caldav-LOCK.php.html
Normal file
62
docs/api/davical/_inc---caldav-LOCK.php.html
Normal file
@ -0,0 +1,62 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page caldav-LOCK.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/caldav-LOCK.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_XMLElement_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"XMLElement.php"</span>)
|
||||
(line <span class="line-number">10</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">We support both LOCK and UNLOCK methods in this function</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:45 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
254
docs/api/davical/_inc---caldav-PUT-functions.php.html
Normal file
254
docs/api/davical/_inc---caldav-PUT-functions.php.html
Normal file
@ -0,0 +1,254 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page caldav-PUT-functions.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/caldav-PUT-functions.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_iCalendar_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include_once</span>
|
||||
(<span class="include-name">"iCalendar.php"</span>)
|
||||
(line <span class="line-number">9</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Check if the user wants to put just one EVENT/TODO or a whole calendar</p>
|
||||
<p class="description"><p>if the collection = calendar = $request_container doesn't exist then create it return true if it's a whole calendar</p></p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<a name="sec-functions"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Functions</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
| <span class="disabled">Functions</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="functioncontrolRequestContainer" id="functioncontrolRequestContainer"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Function.png" />
|
||||
<span class="method-title">controlRequestContainer</span> (line <span class="line-number">42</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Work out the location we are doing the PUT to, and check that we have the rights to do the needful.</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
controlRequestContainer
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$username</span>, <span class="var-type">int</span> <span class="var-name">$user_no</span>, <span class="var-type">string</span> <span class="var-name">$path</span>, <span class="var-type">boolean</span> <span class="var-name">$caldav_context</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$username</span><span class="var-description">: The name of the destination user</span> </li>
|
||||
<li>
|
||||
<span class="var-type">int</span>
|
||||
<span class="var-name">$user_no</span><span class="var-description">: The user making the change</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$path</span><span class="var-description">: The DAV path the resource is bing PUT to</span> </li>
|
||||
<li>
|
||||
<span class="var-type">boolean</span>
|
||||
<span class="var-name">$caldav_context</span><span class="var-description">: Whether we are responding via CalDAV or interactively</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionimport_collection" id="functionimport_collection"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Function.png" />
|
||||
<span class="method-title">import_collection</span> (line <span class="line-number">122</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">This function will import a whole calendar</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
import_collection
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$ics_content</span>, <span class="var-type">int</span> <span class="var-name">$user_no</span>, <span class="var-type">string</span> <span class="var-name">$path</span>, <span class="var-type">boolean</span> <span class="var-name">$caldav_context</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$ics_content</span><span class="var-description">: the ics file to import</span> </li>
|
||||
<li>
|
||||
<span class="var-type">int</span>
|
||||
<span class="var-name">$user_no</span><span class="var-description">: the user wich will receive this ics file</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$path</span><span class="var-description">: the $path where it will be store such as /user_foo/home/</span> </li>
|
||||
<li>
|
||||
<span class="var-type">boolean</span>
|
||||
<span class="var-name">$caldav_context</span><span class="var-description">: Whether we are responding via CalDAV or interactively</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionpublic_events_only" id="functionpublic_events_only"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Function.png" />
|
||||
<span class="method-title">public_events_only</span> (line <span class="line-number">91</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Check if this collection should force all events to be PUBLIC.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Return true if public events only are allowed.</li>
|
||||
</ul>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
public_events_only
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$user_no</span>, <span class="var-type">string</span> <span class="var-name">$dav_name</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$user_no</span><span class="var-description">: the user that owns the collection</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$dav_name</span><span class="var-description">: the collection to check</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionputCalendarResource" id="functionputCalendarResource"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Function.png" />
|
||||
<span class="method-title">putCalendarResource</span> (line <span class="line-number">273</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Put the resource from this request</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Either 'INSERT' or 'UPDATE': the type of action that the PUT resulted in</li>
|
||||
</ul>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
putCalendarResource
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">&$request</span>, <span class="var-type">int</span> <span class="var-name">$author</span>, <span class="var-type">boolean</span> <span class="var-name">$caldav_context</span>, <span class="var-type">object</span> <span class="var-name">$request</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">object</span>
|
||||
<span class="var-name">$request</span><span class="var-description">: A reference to the request object</span> </li>
|
||||
<li>
|
||||
<span class="var-type">int</span>
|
||||
<span class="var-name">$author</span><span class="var-description">: The user_no who wants to put this resource on the server</span> </li>
|
||||
<li>
|
||||
<span class="var-type">boolean</span>
|
||||
<span class="var-name">$caldav_context</span><span class="var-description">: Whether we are responding via CalDAV or interactively</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">&$request</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionrollback_on_error" id="functionrollback_on_error"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Function.png" />
|
||||
<span class="method-title">rollback_on_error</span> (line <span class="line-number">19</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">This function launches an error</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
rollback_on_error
|
||||
</span>
|
||||
(<span class="var-type">boolean</span> <span class="var-name">$caldav_context</span>, <span class="var-type">int</span> <span class="var-name">$user_no</span>, <span class="var-type">string</span> <span class="var-name">$path</span>, [<span class="var-type">string</span> <span class="var-name">$message</span> = <span class="var-default">''</span>], [<span class="var-type">int</span> <span class="var-name">$error_no</span> = <span class="var-default">500</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">boolean</span>
|
||||
<span class="var-name">$caldav_context</span><span class="var-description">: Whether we are responding via CalDAV or interactively</span> </li>
|
||||
<li>
|
||||
<span class="var-type">int</span>
|
||||
<span class="var-name">$user_no</span><span class="var-description">: the user wich will receive this ics file</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$path</span><span class="var-description">: the $path where the PUT failed to store such as /user_foo/home/</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$message</span><span class="var-description">: An optional error message to return to the client</span> </li>
|
||||
<li>
|
||||
<span class="var-type">int</span>
|
||||
<span class="var-name">$error_no</span><span class="var-description">: An optional value for the HTTP error code</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:45 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
149
docs/api/davical/_inc---caldav-REPORT-calquery.php.html
Normal file
149
docs/api/davical/_inc---caldav-REPORT-calquery.php.html
Normal file
@ -0,0 +1,149 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page caldav-REPORT-calquery.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/caldav-REPORT-calquery.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Build the array of properties to include in the report output</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="sec-functions"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Functions</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Functions</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="functionapply_filter" id="functionapply_filter"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Function.png" />
|
||||
<span class="method-title">apply_filter</span> (line <span class="line-number">57</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-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.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> True if the check succeeded, false otherwise.</li>
|
||||
</ul>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
apply_filter
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$filters</span>, <span class="var-type">string</span> <span class="var-name">$item</span>, <span class="var-type">array</span> <span class="var-name">$filter</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">array</span>
|
||||
<span class="var-name">$filter</span><span class="var-description">: An array of XMLElement which is the filter definition</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$item</span><span class="var-description">: The database row retrieved for this calendar item</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$filters</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionBuildSqlFilter" id="functionBuildSqlFilter"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Function.png" />
|
||||
<span class="method-title">BuildSqlFilter</span> (line <span class="line-number">228</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-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.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> A string suitable for use as an SQL 'WHERE' clause selecting the desired records.</li>
|
||||
</ul>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
BuildSqlFilter
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$filter</span>, <span class="var-type">arrayref</span> <span class="var-name">&$filter</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">arrayref</span>
|
||||
<span class="var-name">&$filter</span><span class="var-description">: A reference to an array of XMLElement defining the filter</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$filter</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionSqlFilterFragment" id="functionSqlFilterFragment"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Function.png" />
|
||||
<span class="method-title">SqlFilterFragment</span> (line <span class="line-number">72</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Process a filter fragment returning an SQL fragment</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
SqlFilterFragment
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$filter</span>, <span class="var-type"></span> <span class="var-name">$components</span>, [<span class="var-type"></span> <span class="var-name">$property</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$parameter</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$filter</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$components</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$property</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$parameter</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
77
docs/api/davical/_inc---caldav-REPORT-freebusy.php.html
Normal file
77
docs/api/davical/_inc---caldav-REPORT-freebusy.php.html
Normal file
@ -0,0 +1,77 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page caldav-REPORT-freebusy.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/caldav-REPORT-freebusy.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_iCalendar_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include_once</span>
|
||||
(<span class="include-name">"iCalendar.php"</span>)
|
||||
(line <span class="line-number">5</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Handle the FREE-BUSY-QUERY variant of REPORT</p>
|
||||
|
||||
</div>
|
||||
<a name="_RRule_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include_once</span>
|
||||
(<span class="include-name"><a href="../awl/caldav/_inc---RRule.php.html">"RRule.php"</a></span>)
|
||||
(line <span class="line-number">6</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
37
docs/api/davical/_inc---caldav-REPORT-multiget.php.html
Normal file
37
docs/api/davical/_inc---caldav-REPORT-multiget.php.html
Normal file
@ -0,0 +1,37 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page caldav-REPORT-multiget.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/caldav-REPORT-multiget.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">TODO:</span> Tidy up namespace handling in the responses.</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
78
docs/api/davical/_inc---caldav-REPORT-principal.php.html
Normal file
78
docs/api/davical/_inc---caldav-REPORT-principal.php.html
Normal file
@ -0,0 +1,78 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page caldav-REPORT-principal.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/caldav-REPORT-principal.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="sec-functions"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Functions</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Functions</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="functionprincipal_to_xml" id="functionprincipal_to_xml"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Function.png" />
|
||||
<span class="method-title">principal_to_xml</span> (line <span class="line-number">14</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Return XML for a single Principal (user) from the DB TODO: Refactor this functionality into the CalDAVPrincipal object</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> An XML document which is the response for the principal</li>
|
||||
</ul>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
principal_to_xml
|
||||
</span>
|
||||
(<span class="var-type">array</span> <span class="var-name">$properties</span>, <span class="var-type">string</span> <span class="var-name">$item</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">array</span>
|
||||
<span class="var-name">$properties</span><span class="var-description">: The requested properties for this principal</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$item</span><span class="var-description">: The user data for this calendar</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
125
docs/api/davical/_inc---check_UTF8.php.html
Normal file
125
docs/api/davical/_inc---check_UTF8.php.html
Normal file
@ -0,0 +1,125 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page check_UTF8.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/check_UTF8.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="sec-functions"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Functions</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Functions</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="functioncheck_string" id="functioncheck_string"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Function.png" />
|
||||
<span class="method-title">check_string</span> (line <span class="line-number">211</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
check_string
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$ics</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$ics</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionunicodeToUtf8" id="functionunicodeToUtf8"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Function.png" />
|
||||
<span class="method-title">unicodeToUtf8</span> (line <span class="line-number">179</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-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.</p>
|
||||
<p class="description"><p>Returns false if the input array contains ints that represent surrogates or are outside the Unicode range.</p></p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
unicodeToUtf8
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">&$arr</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">&$arr</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionutf8ToUnicode" id="functionutf8ToUnicode"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Function.png" />
|
||||
<span class="method-title">utf8ToUnicode</span> (line <span class="line-number">59</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-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.</p>
|
||||
<p class="description"><p>Returns false if the input string isn't a valid UTF-8 octet sequence.</p></p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
utf8ToUnicode
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">&$str</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">&$str</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@ -0,0 +1,76 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page davical_configuration_missing.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/davical_configuration_missing.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_page-header_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---page-header.php.html">"page-header.php"</a></span>)
|
||||
(line <span class="line-number">2</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_page-footer_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---page-footer.php.html">"page-footer.php"</a></span>)
|
||||
(line <span class="line-number">31</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
76
docs/api/davical/_inc---freebusy-GET.php.html
Normal file
76
docs/api/davical/_inc---freebusy-GET.php.html
Normal file
@ -0,0 +1,76 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page freebusy-GET.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/freebusy-GET.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_RRule_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include_once</span>
|
||||
(<span class="include-name"><a href="../awl/caldav/_inc---RRule.php.html">"RRule.php"</a></span>)
|
||||
(line <span class="line-number">3</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_iCalendar_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"iCalendar.php"</span>)
|
||||
(line <span class="line-number">2</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
61
docs/api/davical/_inc---interactive-page.php.html
Normal file
61
docs/api/davical/_inc---interactive-page.php.html
Normal file
@ -0,0 +1,61 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page interactive-page.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/interactive-page.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_MenuSet_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"MenuSet.php"</span>)
|
||||
(line <span class="line-number">2</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
34
docs/api/davical/_inc---other_translated_strings.php.html
Normal file
34
docs/api/davical/_inc---other_translated_strings.php.html
Normal file
@ -0,0 +1,34 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page other_translated_strings.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/other_translated_strings.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
34
docs/api/davical/_inc---page-footer.php.html
Normal file
34
docs/api/davical/_inc---page-footer.php.html
Normal file
@ -0,0 +1,34 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page page-footer.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/page-footer.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
91
docs/api/davical/_inc---page-header.php.html
Normal file
91
docs/api/davical/_inc---page-header.php.html
Normal file
@ -0,0 +1,91 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page page-header.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/page-header.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="sec-functions"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Functions</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Functions</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="functionmake_help_link" id="functionmake_help_link"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Function.png" />
|
||||
<span class="method-title">make_help_link</span> (line <span class="line-number">7</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
make_help_link
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$matches</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$matches</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionsend_page_header" id="functionsend_page_header"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Function.png" />
|
||||
<span class="method-title">send_page_header</span> (line <span class="line-number">30</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
send_page_header
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
76
docs/api/davical/_inc---test-RRULE.php.html
Normal file
76
docs/api/davical/_inc---test-RRULE.php.html
Normal file
@ -0,0 +1,76 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page test-RRULE.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/test-RRULE.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="___/inc/always_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"../inc/always.php"</span>)
|
||||
(line <span class="line-number">2</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_RRule_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../awl/caldav/_inc---RRule.php.html">"RRule.php"</a></span>)
|
||||
(line <span class="line-number">3</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:47 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
207
docs/api/davical/authentication/_inc---auth-functions.php.html
Normal file
207
docs/api/davical/authentication/_inc---auth-functions.php.html
Normal file
@ -0,0 +1,207 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page auth-functions.php</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/auth-functions.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">The authentication handling plugins can be used by the Session class to provide authentication.</p>
|
||||
<p class="description"><p>Each authenticate hook needs to: <ul><li>Accept a username / password</li><li>Confirm the username / password are correct</li><li>Create (or update) a 'usr' record in our database</li><li>Return the 'usr' record as an object</li><li>Return === false when authentication fails</li></ul> It can expect that: <ul><li>Configuration data will be in $c->authenticate_hook['config'], which might be an array, or whatever is needed.</li></ul> In order to be called: <ul><li>This file should be included</li><li>$c->authenticate_hook['call'] should be set to the name of the plugin</li><li>$c->authenticate_hook['config'] should be set up with any configuration data for the plugin</li></ul></p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@catalyst.net.nz">andrew@catalyst.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Catalyst IT Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_DataUpdate_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"DataUpdate.php"</span>)
|
||||
(line <span class="line-number">29</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_AWLUtilities_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"AWLUtilities.php"</span>)
|
||||
(line <span class="line-number">28</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<a name="sec-functions"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Functions</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
| <span class="disabled">Functions</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="functionAuthExternalAWL" id="functionAuthExternalAWL"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Function.png" />
|
||||
<span class="method-title">AuthExternalAWL</span> (line <span class="line-number">142</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Authenticate against a different PostgreSQL database which contains a usr table in the AWL format.</p>
|
||||
<p class="description"><p>Use this as in the following example config snippet:</p><p>require_once('auth-functions.php'); $c->authenticate_hook = array( 'call' => 'AuthExternalAwl', 'config' => array( // A PgSQL database connection string for the database containing user records 'connection' => 'dbname=wrms host=otherhost port=5433 user=general', // Which columns should be fetched from the database 'columns' => "user_no, active, email_ok, joined, last_update AS updated, last_used, username, password, fullname, email", // a WHERE clause to limit the records returned. 'where' => "active AND org_code=7" ) );</p></p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
AuthExternalAWL
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$username</span>, <span class="var-type"></span> <span class="var-name">$password</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$username</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$password</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionCreateDefaultRelationships" id="functionCreateDefaultRelationships"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Function.png" />
|
||||
<span class="method-title">CreateDefaultRelationships</span> (line <span class="line-number">63</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Create default relationships</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
CreateDefaultRelationships
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$username</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$username</span><span class="var-description">: The username of the user we are creating relationships for.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionCreateHomeCalendar" id="functionCreateHomeCalendar"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Function.png" />
|
||||
<span class="method-title">CreateHomeCalendar</span> (line <span class="line-number">36</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Create a default home calendar for the user.</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
CreateHomeCalendar
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$username</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$username</span><span class="var-description">: The username of the user we are creating relationships for.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionUpdateUserFromExternal" id="functionUpdateUserFromExternal"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Function.png" />
|
||||
<span class="method-title">UpdateUserFromExternal</span> (line <span class="line-number">90</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Update the local cache of the remote user details</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
UpdateUserFromExternal
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">&$usr</span>, <span class="var-type">object</span> <span class="var-name">$usr</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">object</span>
|
||||
<span class="var-name">$usr</span><span class="var-description">: The user details we read from the remote.</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">&$usr</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:45 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
300
docs/api/davical/caldav/_htdocs---caldav.php.html
Normal file
300
docs/api/davical/caldav/_htdocs---caldav.php.html
Normal file
@ -0,0 +1,300 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page caldav.php</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/htdocs/caldav.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">CalDAV Server - main program</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@catalyst.net.nz">andrew@catalyst.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Catalyst .Net Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_caldav-OPTIONS_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include_once</span>
|
||||
(<span class="include-name"><a href="../../davical/caldav/_inc---caldav-OPTIONS.php.html">caldav-OPTIONS.php</a></span>)
|
||||
(line <span class="line-number">37</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_caldav-MKCALENDAR_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include_once</span>
|
||||
(<span class="include-name"><a href="../../davical/caldav/_inc---caldav-MKCALENDAR.php.html">caldav-MKCALENDAR.php</a></span>)
|
||||
(line <span class="line-number">41</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_caldav-PROPFIND_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include_once</span>
|
||||
(<span class="include-name"><a href="../../davical/propfind/_inc---caldav-PROPFIND.php.html">caldav-PROPFIND.php</a></span>)
|
||||
(line <span class="line-number">39</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_caldav-REPORT_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include_once</span>
|
||||
(<span class="include-name"><a href="../../davical/caldav/_inc---caldav-REPORT.php.html">caldav-REPORT.php</a></span>)
|
||||
(line <span class="line-number">38</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_caldav-PROPPATCH_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include_once</span>
|
||||
(<span class="include-name"><a href="../../davical/caldav/_inc---caldav-PROPPATCH.php.html">caldav-PROPPATCH.php</a></span>)
|
||||
(line <span class="line-number">40</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_caldav-GET_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include_once</span>
|
||||
(<span class="include-name"><a href="../../davical/caldav/_inc---caldav-GET.php.html">caldav-GET.php</a></span>)
|
||||
(line <span class="line-number">45</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_caldav-MKCALENDAR_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include_once</span>
|
||||
(<span class="include-name"><a href="../../davical/caldav/_inc---caldav-MKCALENDAR.php.html">caldav-MKCALENDAR.php</a></span>)
|
||||
(line <span class="line-number">42</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_caldav-LOCK_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include_once</span>
|
||||
(<span class="include-name"><a href="../../davical/_inc---caldav-LOCK.php.html">caldav-LOCK.php</a></span>)
|
||||
(line <span class="line-number">48</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_caldav-GET_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include_once</span>
|
||||
(<span class="include-name"><a href="../../davical/caldav/_inc---caldav-GET.php.html">caldav-GET.php</a></span>)
|
||||
(line <span class="line-number">44</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_caldav-DELETE_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include_once</span>
|
||||
(<span class="include-name"><a href="../../davical/caldav/_inc---caldav-DELETE.php.html">caldav-DELETE.php</a></span>)
|
||||
(line <span class="line-number">46</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_caldav-PUT_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include_once</span>
|
||||
(<span class="include-name"><a href="../../davical/caldav/_inc---caldav-PUT.php.html">caldav-PUT.php</a></span>)
|
||||
(line <span class="line-number">43</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_caldav-LOCK_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include_once</span>
|
||||
(<span class="include-name"><a href="../../davical/_inc---caldav-LOCK.php.html">caldav-LOCK.php</a></span>)
|
||||
(line <span class="line-number">47</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_test-RRULE_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include_once</span>
|
||||
(<span class="include-name"><a href="../../davical/_inc---test-RRULE.php.html">test-RRULE.php</a></span>)
|
||||
(line <span class="line-number">50</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="___/inc/always_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"../inc/always.php"</span>)
|
||||
(line <span class="line-number">11</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">CalDAV Server - main program</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@catalyst.net.nz">andrew@catalyst.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Catalyst .Net Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
<a name="_HTTPAuthSession_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../../davical/HTTPAuthSession/_inc---HTTPAuthSession.php.html">HTTPAuthSession.php</a></span>)
|
||||
(line <span class="line-number">14</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_CalDAVRequest_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../../davical/Request/_inc---CalDAVRequest.php.html">CalDAVRequest.php</a></span>)
|
||||
(line <span class="line-number">33</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">From reading the "Scheduling Extensions to CalDAV" draft I don't think that we will be doing 'calendar-schedule' any time soon. The current spec is at: http://www.ietf.org/internet-drafts/draft-desruisseaux-caldav-sched-03.txt</p>
|
||||
<p class="description"><p>access-control is rfc3744, so we will say we do it, but I doubt if we do it in all (or even much of) it's glory really.</p></p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
179
docs/api/davical/caldav/_htdocs---public.php.html
Normal file
179
docs/api/davical/caldav/_htdocs---public.php.html
Normal file
@ -0,0 +1,179 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page public.php</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/htdocs/public.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">CalDAV Server - main program</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@catalyst.net.nz">andrew@catalyst.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Catalyst .Net Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_caldav-REPORT_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include_once</span>
|
||||
(<span class="include-name"><a href="../../davical/caldav/_inc---caldav-REPORT.php.html">caldav-REPORT.php</a></span>)
|
||||
(line <span class="line-number">28</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_caldav-OPTIONS_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include_once</span>
|
||||
(<span class="include-name"><a href="../../davical/caldav/_inc---caldav-OPTIONS.php.html">caldav-OPTIONS.php</a></span>)
|
||||
(line <span class="line-number">27</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_caldav-GET_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include_once</span>
|
||||
(<span class="include-name"><a href="../../davical/caldav/_inc---caldav-GET.php.html">caldav-GET.php</a></span>)
|
||||
(line <span class="line-number">30</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_caldav-PROPFIND_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include_once</span>
|
||||
(<span class="include-name"><a href="../../davical/propfind/_inc---caldav-PROPFIND.php.html">caldav-PROPFIND.php</a></span>)
|
||||
(line <span class="line-number">29</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_test-RRULE_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include_once</span>
|
||||
(<span class="include-name"><a href="../../davical/_inc---test-RRULE.php.html">test-RRULE.php</a></span>)
|
||||
(line <span class="line-number">43</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_caldav-GET_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include_once</span>
|
||||
(<span class="include-name"><a href="../../davical/caldav/_inc---caldav-GET.php.html">caldav-GET.php</a></span>)
|
||||
(line <span class="line-number">31</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="___/inc/always_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"../inc/always.php"</span>)
|
||||
(line <span class="line-number">11</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">CalDAV Server - main program</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@catalyst.net.nz">andrew@catalyst.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Catalyst .Net Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
<a name="_CalDAVRequest_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../../davical/Request/_inc---CalDAVRequest.php.html">CalDAVRequest.php</a></span>)
|
||||
(line <span class="line-number">23</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">A simplified DAV header in this case</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
40
docs/api/davical/caldav/_inc---caldav-DELETE.php.html
Normal file
40
docs/api/davical/caldav/_inc---caldav-DELETE.php.html
Normal file
@ -0,0 +1,40 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page caldav-DELETE.php</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/caldav-DELETE.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">CalDAV Server - handle DELETE method</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@catalyst.net.nz">andrew@catalyst.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Catalyst .Net Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:45 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
68
docs/api/davical/caldav/_inc---caldav-GET.php.html
Normal file
68
docs/api/davical/caldav/_inc---caldav-GET.php.html
Normal file
@ -0,0 +1,68 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page caldav-GET.php</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/caldav-GET.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">CalDAV Server - handle GET method</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@catalyst.net.nz">andrew@catalyst.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Catalyst .Net Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_iCalendar_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include_once</span>
|
||||
(<span class="include-name">"iCalendar.php"</span>)
|
||||
(line <span class="line-number">48</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Here we are constructing a whole calendar response for this collection, including the timezones that are referred to by the events we have selected.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:45 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
40
docs/api/davical/caldav/_inc---caldav-MKCALENDAR.php.html
Normal file
40
docs/api/davical/caldav/_inc---caldav-MKCALENDAR.php.html
Normal file
@ -0,0 +1,40 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page caldav-MKCALENDAR.php</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/caldav-MKCALENDAR.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">CalDAV Server - handle MKCALENDAR method</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@catalyst.net.nz">andrew@catalyst.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Catalyst .Net Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:45 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
40
docs/api/davical/caldav/_inc---caldav-OPTIONS.php.html
Normal file
40
docs/api/davical/caldav/_inc---caldav-OPTIONS.php.html
Normal file
@ -0,0 +1,40 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page caldav-OPTIONS.php</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/caldav-OPTIONS.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">CalDAV Server - handle OPTIONS method</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@catalyst.net.nz">andrew@catalyst.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Catalyst .Net Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:45 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
40
docs/api/davical/caldav/_inc---caldav-PROPPATCH.php.html
Normal file
40
docs/api/davical/caldav/_inc---caldav-PROPPATCH.php.html
Normal file
@ -0,0 +1,40 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page caldav-PROPPATCH.php</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/caldav-PROPPATCH.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">CalDAV Server - handle PROPPATCH method</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@catalyst.net.nz">andrew@catalyst.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Catalyst .Net Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:45 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
73
docs/api/davical/caldav/_inc---caldav-PUT.php.html
Normal file
73
docs/api/davical/caldav/_inc---caldav-PUT.php.html
Normal file
@ -0,0 +1,73 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page caldav-PUT.php</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/caldav-PUT.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">CalDAV Server - handle PUT method</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@catalyst.net.nz">andrew@catalyst.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Catalyst .Net Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_caldav-PUT-functions_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include_once</span>
|
||||
(<span class="include-name"><a href="../../davical/_inc---caldav-PUT-functions.php.html">'caldav-PUT-functions.php'</a></span>)
|
||||
(line <span class="line-number">25</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">CalDAV Server - handle PUT method</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@catalyst.net.nz">andrew@catalyst.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Catalyst .Net Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
178
docs/api/davical/caldav/_inc---caldav-REPORT.php.html
Normal file
178
docs/api/davical/caldav/_inc---caldav-REPORT.php.html
Normal file
@ -0,0 +1,178 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page caldav-REPORT.php</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/caldav-REPORT.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">CalDAV Server - handle REPORT method</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@catalyst.net.nz">andrew@catalyst.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Catalyst .Net Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_caldav-REPORT-freebusy_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../../davical/_inc---caldav-REPORT-freebusy.php.html">"caldav-REPORT-freebusy.php"</a></span>)
|
||||
(line <span class="line-number">44</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_caldav-REPORT-principal_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../../davical/_inc---caldav-REPORT-principal.php.html">"caldav-REPORT-principal.php"</a></span>)
|
||||
(line <span class="line-number">48</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_caldav-REPORT-calquery_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../../davical/_inc---caldav-REPORT-calquery.php.html">"caldav-REPORT-calquery.php"</a></span>)
|
||||
(line <span class="line-number">163</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_caldav-REPORT-multiget_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../../davical/_inc---caldav-REPORT-multiget.php.html">"caldav-REPORT-multiget.php"</a></span>)
|
||||
(line <span class="line-number">167</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_iCalendar_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"iCalendar.php"</span>)
|
||||
(line <span class="line-number">35</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">CalDAV Server - handle REPORT method</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@catalyst.net.nz">andrew@catalyst.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Catalyst .Net Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<a name="sec-functions"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Functions</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
| <span class="disabled">Functions</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="functioncalendar_to_xml" id="functioncalendar_to_xml"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Function.png" />
|
||||
<span class="method-title">calendar_to_xml</span> (line <span class="line-number">68</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Return XML for a single calendar (or todo) entry from the DB</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> An XML document which is the response for the calendar</li>
|
||||
</ul>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
calendar_to_xml
|
||||
</span>
|
||||
(<span class="var-type">array</span> <span class="var-name">$properties</span>, <span class="var-type">string</span> <span class="var-name">$item</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">array</span>
|
||||
<span class="var-name">$properties</span><span class="var-description">: The properties for this calendar</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$item</span><span class="var-description">: The calendar data for this calendar</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
218
docs/api/davical/ldap/_inc---drivers_ldap.php.html
Normal file
218
docs/api/davical/ldap/_inc---drivers_ldap.php.html
Normal file
@ -0,0 +1,218 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page drivers_ldap.php</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/drivers_ldap.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Manages LDAP repository connection</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Maxime Delorme <<a href="mailto:mdelorme@tennaxia.net">mdelorme@tennaxia.net</a>></li>
|
||||
<li><span class="field">copyright:</span> Maxime Delorme</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
|
||||
<img src="../../media/images/Class.png"
|
||||
alt=" class"
|
||||
title=" class"/>
|
||||
<a href="../../davical/ldap/ldapDrivers.html">ldapDrivers</a>
|
||||
</td>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <span class="disabled">Includes</span>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_auth-functions_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../../davical/authentication/_inc---auth-functions.php.html">"auth-functions.php"</a></span>)
|
||||
(line <span class="line-number">13</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<a name="sec-functions"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Functions</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
| <span class="disabled">Functions</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="functiongetStaticLdap" id="functiongetStaticLdap"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Function.png" />
|
||||
<span class="method-title">getStaticLdap</span> (line <span class="line-number">199</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">A generic function to create and fetch static objects</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
getStaticLdap
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionLDAP_check" id="functionLDAP_check"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Function.png" />
|
||||
<span class="method-title">LDAP_check</span> (line <span class="line-number">244</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Check the username / password against the LDAP server</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
LDAP_check
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$username</span>, <span class="var-type"></span> <span class="var-name">$password</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$username</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$password</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionsync_LDAP" id="functionsync_LDAP"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Function.png" />
|
||||
<span class="method-title">sync_LDAP</span> (line <span class="line-number">314</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">sync LDAP against the DB</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
sync_LDAP
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionsync_user_from_LDAP" id="functionsync_user_from_LDAP"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Function.png" />
|
||||
<span class="method-title">sync_user_from_LDAP</span> (line <span class="line-number">216</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Synchronise a cached user with one from LDAP</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
sync_user_from_LDAP
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">&$usr</span>, <span class="var-type"></span> <span class="var-name">$mapping</span>, <span class="var-type"></span> <span class="var-name">$ldap_values</span>, <span class="var-type">object</span> <span class="var-name">$usr</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">object</span>
|
||||
<span class="var-name">$usr</span><span class="var-description">: A user record to be updated (or created)</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">&$usr</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$mapping</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$ldap_values</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
147
docs/api/davical/ldap/_inc---drivers_squid_pam.php.html
Normal file
147
docs/api/davical/ldap/_inc---drivers_squid_pam.php.html
Normal file
@ -0,0 +1,147 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page drivers_squid_pam.php</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/drivers_squid_pam.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Manages PAM repository connection with SQUID help</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Eric Seigne <<a href="mailto:eric.seigne@ryxeo.com">eric.seigne@ryxeo.com</a>></li>
|
||||
<li><span class="field">copyright:</span> Eric Seigne</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
|
||||
<img src="../../media/images/Class.png"
|
||||
alt=" class"
|
||||
title=" class"/>
|
||||
<a href="../../davical/ldap/squidPamDrivers.html">squidPamDrivers</a>
|
||||
</td>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <span class="disabled">Includes</span>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_auth-functions_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../../davical/authentication/_inc---auth-functions.php.html">"auth-functions.php"</a></span>)
|
||||
(line <span class="line-number">13</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Manages PAM repository connection with SQUID help</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Eric Seigne <<a href="mailto:eric.seigne@ryxeo.com">eric.seigne@ryxeo.com</a>></li>
|
||||
<li><span class="field">copyright:</span> Eric Seigne</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<a name="sec-functions"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Functions</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
| <span class="disabled">Functions</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="functionSQUID_PAM_check" id="functionSQUID_PAM_check"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Function.png" />
|
||||
<span class="method-title">SQUID_PAM_check</span> (line <span class="line-number">53</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Check the username / password against the PAM system</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
SQUID_PAM_check
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$username</span>, <span class="var-type"></span> <span class="var-name">$password</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$username</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$password</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
214
docs/api/davical/ldap/ldapDrivers.html
Normal file
214
docs/api/davical/ldap/ldapDrivers.html
Normal file
@ -0,0 +1,214 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs For Class ldapDrivers</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="class-name"><img src="../../media/images/Class_logo.png"
|
||||
alt=" Class"
|
||||
title=" Class"
|
||||
style="vertical-align: middle"> ldapDrivers</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_inc---drivers_ldap.php.html">/inc/drivers_ldap.php</a> (line <span class="field">15</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="sec-method-summary"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Method Summary</span></div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<div class="method-summary">
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Constructor.png" alt=" "/>
|
||||
<span class="method-result">ldapDrivers</span>
|
||||
<a href="#__construct" title="details" class="method-name">__construct</a>
|
||||
(<span class="var-type">array</span> <span class="var-name">$config</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Constructor.png" alt=" "/>
|
||||
<span class="method-result">ldapDrivers</span>
|
||||
<a href="#ldapDrivers" title="details" class="method-name">ldapDrivers</a>
|
||||
(<span class="var-type">array</span> <span class="var-name">$config</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#getAllUsers" title="details" class="method-name">getAllUsers</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$attributes</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">array</span>
|
||||
<a href="#requestUser" title="details" class="method-name">requestUser</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$filter</span>, [<span class="var-type">array</span> <span class="var-name">$attributes</span> = <span class="var-default">NULL</span>], <span class="var-type">string</span> <span class="var-name">$passwd</span>)
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-methods"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Methods</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
<a name="method__construct" id="__construct"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Constructor.png" />
|
||||
<span class="method-title">Constructor __construct</span> (line <span class="line-number">43</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Initializes the LDAP connection</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">ldapDrivers</span>
|
||||
<span class="method-name">
|
||||
__construct
|
||||
</span>
|
||||
(<span class="var-type">array</span> <span class="var-name">$config</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">array</span>
|
||||
<span class="var-name">$config</span><span class="var-description">: The configuration data</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodldapDrivers" id="ldapDrivers"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Constructor.png" />
|
||||
<span class="method-title">Constructor ldapDrivers</span> (line <span class="line-number">33</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Constructor.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">ldapDrivers</span>
|
||||
<span class="method-name">
|
||||
ldapDrivers
|
||||
</span>
|
||||
(<span class="var-type">array</span> <span class="var-name">$config</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">array</span>
|
||||
<span class="var-name">$config</span><span class="var-description">: The configuration data</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetAllUsers" id="getAllUsers"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">getAllUsers</span> (line <span class="line-number">124</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Retrieve all users from the LDAP directory</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
getAllUsers
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$attributes</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$attributes</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodrequestUser" id="requestUser"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">requestUser</span> (line <span class="line-number">155</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the result of the LDAP query</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Contains selected attributes from all entries corresponding to the given filter</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
requestUser
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$filter</span>, [<span class="var-type">array</span> <span class="var-name">$attributes</span> = <span class="var-default">NULL</span>], <span class="var-type">string</span> <span class="var-name">$passwd</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$filter</span><span class="var-description">: The filter used to search entries</span> </li>
|
||||
<li>
|
||||
<span class="var-type">array</span>
|
||||
<span class="var-name">$attributes</span><span class="var-description">: Attributes to be returned</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$passwd</span><span class="var-description">: password to check</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
139
docs/api/davical/ldap/squidPamDrivers.html
Normal file
139
docs/api/davical/ldap/squidPamDrivers.html
Normal file
@ -0,0 +1,139 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs For Class squidPamDrivers</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="class-name"><img src="../../media/images/Class_logo.png"
|
||||
alt=" Class"
|
||||
title=" Class"
|
||||
style="vertical-align: middle"> squidPamDrivers</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_inc---drivers_squid_pam.php.html">/inc/drivers_squid_pam.php</a> (line <span class="field">15</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="sec-method-summary"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Method Summary</span></div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<div class="method-summary">
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Constructor.png" alt=" "/>
|
||||
<span class="method-result">squidPamDrivers</span>
|
||||
<a href="#__construct" title="details" class="method-name">__construct</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$config</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Constructor.png" alt=" "/>
|
||||
<span class="method-result">squidPamDrivers</span>
|
||||
<a href="#squidPamDrivers" title="details" class="method-name">squidPamDrivers</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$config</span>)
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-methods"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Methods</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
<a name="method__construct" id="__construct"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Constructor.png" />
|
||||
<span class="method-title">Constructor __construct</span> (line <span class="line-number">38</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">The constructor</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">squidPamDrivers</span>
|
||||
<span class="method-name">
|
||||
__construct
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$config</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$config</span><span class="var-description">: path where /usr/lib/squid/pam_auth is</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsquidPamDrivers" id="squidPamDrivers"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Constructor.png" />
|
||||
<span class="method-title">Constructor squidPamDrivers</span> (line <span class="line-number">28</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Constructor.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">squidPamDrivers</span>
|
||||
<span class="method-name">
|
||||
squidPamDrivers
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$config</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$config</span><span class="var-description">: path where /usr/lib/squid/pam_auth is</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:46 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
432
docs/api/davical/propfind/_inc---caldav-PROPFIND.php.html
Normal file
432
docs/api/davical/propfind/_inc---caldav-PROPFIND.php.html
Normal file
@ -0,0 +1,432 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page caldav-PROPFIND.php</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/caldav-PROPFIND.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">CalDAV Server - handle PROPFIND method</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@catalyst.net.nz">andrew@catalyst.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Catalyst .Net Ltd, Andrew McMillan</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2 or later</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_XMLElement_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"XMLElement.php"</span>)
|
||||
(line <span class="line-number">17</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_iCalendar_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">"iCalendar.php"</span>)
|
||||
(line <span class="line-number">18</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<a name="sec-functions"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Functions</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
| <span class="disabled">Functions</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="functionadd_namespace" id="functionadd_namespace"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Function.png" />
|
||||
<span class="method-title">add_namespace</span> (line <span class="line-number">27</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
add_namespace
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$prefix</span>, <span class="var-type"></span> <span class="var-name">$namespace</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$prefix</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$namespace</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionadd_principal_properties" id="functionadd_principal_properties"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Function.png" />
|
||||
<span class="method-title">add_principal_properties</span> (line <span class="line-number">276</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Handles any properties related to the DAV::PRINCIPAL in the request</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
add_principal_properties
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">&$prop</span>, <span class="var-type"></span> <span class="var-name">&$not_found</span>, <span class="var-type"></span> <span class="var-name">&$denied</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">&$prop</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">&$not_found</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">&$denied</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functioncaldav_tag" id="functioncaldav_tag"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Function.png" />
|
||||
<span class="method-title">caldav_tag</span> (line <span class="line-number">120</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
caldav_tag
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$tag</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$tag</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functioncollection_to_xml" id="functioncollection_to_xml"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Function.png" />
|
||||
<span class="method-title">collection_to_xml</span> (line <span class="line-number">315</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns an XML sub-tree for a single collection record from the DB</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
collection_to_xml
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$collection</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$collection</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionget_arbitrary_properties" id="functionget_arbitrary_properties"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Function.png" />
|
||||
<span class="method-title">get_arbitrary_properties</span> (line <span class="line-number">252</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Fetches any arbitrary properties that were requested by the PROPFIND into an array, which we return.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> The arbitrary properties.</li>
|
||||
</ul>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
get_arbitrary_properties
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$dav_name</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$dav_name</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionget_collection" id="functionget_collection"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Function.png" />
|
||||
<span class="method-title">get_collection</span> (line <span class="line-number">638</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Get XML response for a single collection. If Depth is >0 then</p>
|
||||
<p class="description"><p>subsidiary collections will also be got up to $depth</p></p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
get_collection
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$depth</span>, <span class="var-type"></span> <span class="var-name">$user_no</span>, <span class="var-type"></span> <span class="var-name">$collection_path</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$depth</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$user_no</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$collection_path</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionget_collection_contents" id="functionget_collection_contents"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Function.png" />
|
||||
<span class="method-title">get_collection_contents</span> (line <span class="line-number">569</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-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.</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
get_collection_contents
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$depth</span>, <span class="var-type"></span> <span class="var-name">$user_no</span>, <span class="var-type"></span> <span class="var-name">$collection</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$depth</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$user_no</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$collection</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionget_item" id="functionget_item"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Function.png" />
|
||||
<span class="method-title">get_item</span> (line <span class="line-number">691</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Get XML response for a single item. Depth is irrelevant for this.</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
get_item
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$item_path</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$item_path</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionitem_to_xml" id="functionitem_to_xml"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Function.png" />
|
||||
<span class="method-title">item_to_xml</span> (line <span class="line-number">472</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Return XML for a single data item from the DB</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
item_to_xml
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$item</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$item</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionnamespace_array" id="functionnamespace_array"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Function.png" />
|
||||
<span class="method-title">namespace_array</span> (line <span class="line-number">108</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
namespace_array
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionns_tag" id="functionns_tag"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Function.png" />
|
||||
<span class="method-title">ns_tag</span> (line <span class="line-number">50</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
ns_tag
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$in_tag</span>, [<span class="var-type"></span> <span class="var-name">$namespace</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$prefix</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$in_tag</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$namespace</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$prefix</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionprivileges" id="functionprivileges"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Function.png" />
|
||||
<span class="method-title">privileges</span> (line <span class="line-number">238</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns the array of privilege names converted into XMLElements</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
privileges
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$privilege_names</span>, [<span class="var-type"></span> <span class="var-name">$container</span> = <span class="var-default">&quot;privilege&quot;</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$privilege_names</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$container</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:45 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
1677
docs/api/elementindex.html
Normal file
1677
docs/api/elementindex.html
Normal file
File diff suppressed because it is too large
Load Diff
382
docs/api/elementindex_awl.html
Normal file
382
docs/api/elementindex_awl.html
Normal file
@ -0,0 +1,382 @@
|
||||
<?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>[awl] element index</h2>
|
||||
<h3>Package indexes</h3>
|
||||
<ul>
|
||||
<li><a href="elementindex_davical.html">davical</a></li>
|
||||
</ul>
|
||||
<a href="elementindex.html">All elements</a>
|
||||
<br />
|
||||
<div class="index-letter-menu">
|
||||
<a class="index-letter" href="elementindex_awl.html#a">a</a>
|
||||
<a class="index-letter" href="elementindex_awl.html#d">d</a>
|
||||
<a class="index-letter" href="elementindex_awl.html#g">g</a>
|
||||
<a class="index-letter" href="elementindex_awl.html#i">i</a>
|
||||
<a class="index-letter" href="elementindex_awl.html#l">l</a>
|
||||
<a class="index-letter" href="elementindex_awl.html#m">m</a>
|
||||
<a class="index-letter" href="elementindex_awl.html#r">r</a>
|
||||
<a class="index-letter" href="elementindex_awl.html#s">s</a>
|
||||
<a class="index-letter" href="elementindex_awl.html#t">t</a>
|
||||
<a class="index-letter" href="elementindex_awl.html#w">w</a>
|
||||
<a class="index-letter" href="elementindex_awl.html#_">_</a>
|
||||
</div>
|
||||
|
||||
<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>
|
||||
</dl>
|
||||
<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/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>
|
||||
</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/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>
|
||||
</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/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">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/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="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/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>
|
||||
</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/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>
|
||||
</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/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="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/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/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/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" />
|
||||
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>
|
||||
</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/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">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">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>
|
||||
</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/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>
|
||||
</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>
|
||||
</dl>
|
||||
|
||||
<div class="index-letter-menu">
|
||||
<a class="index-letter" href="elementindex_awl.html#a">a</a>
|
||||
<a class="index-letter" href="elementindex_awl.html#d">d</a>
|
||||
<a class="index-letter" href="elementindex_awl.html#g">g</a>
|
||||
<a class="index-letter" href="elementindex_awl.html#i">i</a>
|
||||
<a class="index-letter" href="elementindex_awl.html#l">l</a>
|
||||
<a class="index-letter" href="elementindex_awl.html#m">m</a>
|
||||
<a class="index-letter" href="elementindex_awl.html#r">r</a>
|
||||
<a class="index-letter" href="elementindex_awl.html#s">s</a>
|
||||
<a class="index-letter" href="elementindex_awl.html#t">t</a>
|
||||
<a class="index-letter" href="elementindex_awl.html#w">w</a>
|
||||
<a class="index-letter" href="elementindex_awl.html#_">_</a>
|
||||
</div>
</body>
|
||||
</html>
|
||||
1430
docs/api/elementindex_davical.html
Normal file
1430
docs/api/elementindex_davical.html
Normal file
File diff suppressed because it is too large
Load Diff
225
docs/api/errors.html
Normal file
225
docs/api/errors.html
Normal file
@ -0,0 +1,225 @@
|
||||
<?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>phpDocumentor Parser Errors and Warnings</title>
|
||||
<link rel="stylesheet" href="media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<a href="#Post-parsing">Post-parsing</a><br />
|
||||
<a href="#auth-functions.php">auth-functions.php</a><br />
|
||||
<a href="#caldav-LOCK.php">caldav-LOCK.php</a><br />
|
||||
<a href="#caldav-MKCALENDAR.php">caldav-MKCALENDAR.php</a><br />
|
||||
<a href="#caldav-PROPFIND.php">caldav-PROPFIND.php</a><br />
|
||||
<a href="#caldav-PUT-functions.php">caldav-PUT-functions.php</a><br />
|
||||
<a href="#caldav-PUT.php">caldav-PUT.php</a><br />
|
||||
<a href="#caldav-REPORT-calquery.php">caldav-REPORT-calquery.php</a><br />
|
||||
<a href="#caldav-REPORT-freebusy.php">caldav-REPORT-freebusy.php</a><br />
|
||||
<a href="#caldav-REPORT-multiget.php">caldav-REPORT-multiget.php</a><br />
|
||||
<a href="#caldav-REPORT-principal.php">caldav-REPORT-principal.php</a><br />
|
||||
<a href="#caldav-REPORT.php">caldav-REPORT.php</a><br />
|
||||
<a href="#caldav.php">caldav.php</a><br />
|
||||
<a href="#CalDAVRequest.php">CalDAVRequest.php</a><br />
|
||||
<a href="#check_UTF8.php">check_UTF8.php</a><br />
|
||||
<a href="#collection.php">collection.php</a><br />
|
||||
<a href="#davical_configuration_missing.php">davical_configuration_missing.php</a><br />
|
||||
<a href="#drivers_ldap.php">drivers_ldap.php</a><br />
|
||||
<a href="#drivers_squid_pam.php">drivers_squid_pam.php</a><br />
|
||||
<a href="#freebusy-GET.php">freebusy-GET.php</a><br />
|
||||
<a href="#freebusy.php">freebusy.php</a><br />
|
||||
<a href="#help.php">help.php</a><br />
|
||||
<a href="#index.php">index.php</a><br />
|
||||
<a href="#interactive-page.php">interactive-page.php</a><br />
|
||||
<a href="#other_translated_strings.php">other_translated_strings.php</a><br />
|
||||
<a href="#page-footer.php">page-footer.php</a><br />
|
||||
<a href="#page-header.php">page-header.php</a><br />
|
||||
<a href="#public.php">public.php</a><br />
|
||||
<a href="#relationship_types.php">relationship_types.php</a><br />
|
||||
<a href="#roles.php">roles.php</a><br />
|
||||
<a href="#RSCDSUser.php">RSCDSUser.php</a><br />
|
||||
<a href="#test-RRULE.php">test-RRULE.php</a><br />
|
||||
<a href="#tools.php">tools.php</a><br />
|
||||
<a href="#users.php">users.php</a><br />
|
||||
<a href="#usr.php">usr.php</a><br />
|
||||
<a name="Post-parsing"></a>
|
||||
<h1>Post-parsing</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning</b> - Class RSCDSUser parent User not found<br />
|
||||
<b>Warning</b> - Class RSCDSSession parent Session not found<br />
|
||||
<a name="always.php"></a>
|
||||
<h1>always.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 42</b> - Page-level DocBlock precedes "require_once "AWLUtilities.php"", use another DocBlock to document the source element<br />
|
||||
<h2>Errors:</h2><br />
|
||||
<b>Error on line 42</b> - require_once include's DocBlock has @package tag, illegal. ignoring tag "@package rscds"<br />
|
||||
<a name="auth-functions.php"></a>
|
||||
<h1>auth-functions.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 27</b> - Page-level DocBlock precedes "require_once "AWLUtilities.php"", use another DocBlock to document the source element<br />
|
||||
<a name="caldav-LOCK.php"></a>
|
||||
<h1>caldav-LOCK.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 138</b> - File "/home/andrew/projects/davical/inc/caldav-LOCK.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br />
|
||||
<a name="caldav-MKCALENDAR.php"></a>
|
||||
<h1>caldav-MKCALENDAR.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 10</b> - package davical is already in category Technical, will now replace with category Documentation<br />
|
||||
<a name="caldav-PROPFIND.php"></a>
|
||||
<h1>caldav-PROPFIND.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 16</b> - Page-level DocBlock precedes "require_once "XMLElement.php"", use another DocBlock to document the source element<br />
|
||||
<a name="caldav-PUT-functions.php"></a>
|
||||
<h1>caldav-PUT-functions.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 415</b> - File "/home/andrew/projects/davical/inc/caldav-PUT-functions.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br />
|
||||
<a name="caldav-PUT.php"></a>
|
||||
<h1>caldav-PUT.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 24</b> - Page-level DocBlock precedes "include_once 'caldav-PUT-functions.php'", use another DocBlock to document the source element<br />
|
||||
<h2>Errors:</h2><br />
|
||||
<b>Error on line 24</b> - DocBlock has multiple @package tags, illegal. ignoring additional tag "@package davical"<br />
|
||||
<b>Error on line 24</b> - "include" include_once's DocBlock has @subpackage tags, illegal. ignoring tag "@subpackage caldav"<br />
|
||||
<a name="caldav-REPORT-calquery.php"></a>
|
||||
<h1>caldav-REPORT-calquery.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 32</b> - no @package tag was used in a DocBlock for file /home/andrew/projects/davical/inc/caldav-REPORT-calquery.php<br />
|
||||
<a name="caldav-REPORT-freebusy.php"></a>
|
||||
<h1>caldav-REPORT-freebusy.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 101</b> - File "/home/andrew/projects/davical/inc/caldav-REPORT-freebusy.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br />
|
||||
<a name="caldav-REPORT-multiget.php"></a>
|
||||
<h1>caldav-REPORT-multiget.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 11</b> - no @package tag was used in a DocBlock for file /home/andrew/projects/davical/inc/caldav-REPORT-multiget.php<br />
|
||||
<b>Warning on line 11</b> - package davical is already in category Technical, will now replace with category Documentation<br />
|
||||
<a name="caldav-REPORT-principal.php"></a>
|
||||
<h1>caldav-REPORT-principal.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 135</b> - File "/home/andrew/projects/davical/inc/caldav-REPORT-principal.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br />
|
||||
<a name="caldav-REPORT.php"></a>
|
||||
<h1>caldav-REPORT.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 34</b> - Page-level DocBlock precedes "require_once "iCalendar.php"", use another DocBlock to document the source element<br />
|
||||
<h2>Errors:</h2><br />
|
||||
<b>Error on line 34</b> - DocBlock has multiple @package tags, illegal. ignoring additional tag "@package davical"<br />
|
||||
<b>Error on line 34</b> - "include" require_once's DocBlock has @subpackage tags, illegal. ignoring tag "@subpackage caldav"<br />
|
||||
<a name="caldav.php"></a>
|
||||
<h1>caldav.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 10</b> - Page-level DocBlock precedes "require_once "../inc/always.php"", use another DocBlock to document the source element<br />
|
||||
<h2>Errors:</h2><br />
|
||||
<b>Error on line 10</b> - "include" require_once's DocBlock has @subpackage tags, illegal. ignoring tag "@subpackage caldav"<br />
|
||||
<b>Error on line 10</b> - DocBlock has multiple @package tags, illegal. ignoring additional tag "@package davical"<br />
|
||||
<a name="CalDAVRequest.php"></a>
|
||||
<h1>CalDAVRequest.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 16</b> - Page-level DocBlock precedes "require_once "XMLElement.php"", use another DocBlock to document the source element<br />
|
||||
<h2>Errors:</h2><br />
|
||||
<b>Error on line 16</b> - DocBlock has multiple @package tags, illegal. ignoring additional tag "@package davical"<br />
|
||||
<b>Error on line 16</b> - "include" require_once's DocBlock has @subpackage tags, illegal. ignoring tag "@subpackage Request"<br />
|
||||
<a name="check_UTF8.php"></a>
|
||||
<h1>check_UTF8.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 227</b> - File "/home/andrew/projects/davical/inc/check_UTF8.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br />
|
||||
<a name="collection.php"></a>
|
||||
<h1>collection.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 52</b> - File "/home/andrew/projects/davical/htdocs/collection.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br />
|
||||
<a name="davical_configuration_missing.php"></a>
|
||||
<h1>davical_configuration_missing.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 30</b> - File "/home/andrew/projects/davical/inc/davical_configuration_missing.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br />
|
||||
<a name="drivers_ldap.php"></a>
|
||||
<h1>drivers_ldap.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 12</b> - Page-level DocBlock precedes "require_once "auth-functions.php"", use another DocBlock to document the source element<br />
|
||||
<b>Warning on line 15</b> - no @package tag was used in a DocBlock for class ldapDrivers<br />
|
||||
<a name="drivers_squid_pam.php"></a>
|
||||
<h1>drivers_squid_pam.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 12</b> - Page-level DocBlock precedes "require_once "auth-functions.php"", use another DocBlock to document the source element<br />
|
||||
<b>Warning on line 15</b> - no @package tag was used in a DocBlock for class squidPamDrivers<br />
|
||||
<h2>Errors:</h2><br />
|
||||
<b>Error on line 12</b> - DocBlock has multiple @package tags, illegal. ignoring additional tag "@package davical"<br />
|
||||
<b>Error on line 12</b> - "include" require_once's DocBlock has @subpackage tags, illegal. ignoring tag "@subpackage ldap"<br />
|
||||
<a name="freebusy-GET.php"></a>
|
||||
<h1>freebusy-GET.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 111</b> - File "/home/andrew/projects/davical/inc/freebusy-GET.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br />
|
||||
<a name="freebusy.php"></a>
|
||||
<h1>freebusy.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 32</b> - File "/home/andrew/projects/davical/htdocs/freebusy.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br />
|
||||
<a name="help.php"></a>
|
||||
<h1>help.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 19</b> - File "/home/andrew/projects/davical/htdocs/help.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br />
|
||||
<a name="index.php"></a>
|
||||
<h1>index.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 68</b> - File "/home/andrew/projects/davical/htdocs/index.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br />
|
||||
<a name="interactive-page.php"></a>
|
||||
<h1>interactive-page.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 19</b> - File "/home/andrew/projects/davical/inc/interactive-page.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br />
|
||||
<a name="other_translated_strings.php"></a>
|
||||
<h1>other_translated_strings.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 44</b> - File "/home/andrew/projects/davical/inc/other_translated_strings.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br />
|
||||
<a name="page-footer.php"></a>
|
||||
<h1>page-footer.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 1</b> - File "/home/andrew/projects/davical/inc/page-footer.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br />
|
||||
<a name="page-header.php"></a>
|
||||
<h1>page-header.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 96</b> - File "/home/andrew/projects/davical/inc/page-header.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br />
|
||||
<a name="public.php"></a>
|
||||
<h1>public.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 10</b> - Page-level DocBlock precedes "require_once "../inc/always.php"", use another DocBlock to document the source element<br />
|
||||
<h2>Errors:</h2><br />
|
||||
<b>Error on line 10</b> - DocBlock has multiple @package tags, illegal. ignoring additional tag "@package davical"<br />
|
||||
<b>Error on line 10</b> - "include" require_once's DocBlock has @subpackage tags, illegal. ignoring tag "@subpackage caldav"<br />
|
||||
<a name="relationship_types.php"></a>
|
||||
<h1>relationship_types.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 108</b> - File "/home/andrew/projects/davical/htdocs/relationship_types.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br />
|
||||
<a name="roles.php"></a>
|
||||
<h1>roles.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 39</b> - File "/home/andrew/projects/davical/htdocs/roles.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br />
|
||||
<a name="RSCDSUser.php"></a>
|
||||
<h1>RSCDSUser.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 11</b> - Page-level DocBlock precedes "require_once "User.php"", use another DocBlock to document the source element<br />
|
||||
<a name="test-RRULE.php"></a>
|
||||
<h1>test-RRULE.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 39</b> - File "/home/andrew/projects/davical/inc/test-RRULE.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br />
|
||||
<a name="tools.php"></a>
|
||||
<h1>tools.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 11</b> - Page-level DocBlock precedes "require_once "../inc/always.php"", use another DocBlock to document the source element<br />
|
||||
<b>Warning on line 35</b> - no @package tag was used in a DocBlock for class Tools<br />
|
||||
<h2>Errors:</h2><br />
|
||||
<b>Error on line 11</b> - DocBlock has multiple @package tags, illegal. ignoring additional tag "@package davical"<br />
|
||||
<b>Error on line 11</b> - "include" require_once's DocBlock has @subpackage tags, illegal. ignoring tag "@subpackage RSCDSSession"<br />
|
||||
<a name="users.php"></a>
|
||||
<h1>users.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 10</b> - Page-level DocBlock precedes "require_once "../inc/always.php"", use another DocBlock to document the source element<br />
|
||||
<h2>Errors:</h2><br />
|
||||
<b>Error on line 10</b> - "include" require_once's DocBlock has @subpackage tags, illegal. ignoring tag "@subpackage Admin"<br />
|
||||
<b>Error on line 10</b> - DocBlock has multiple @package tags, illegal. ignoring additional tag "@package davical"<br />
|
||||
<a name="usr.php"></a>
|
||||
<h1>usr.php</h1>
|
||||
<h2>Warnings:</h2><br />
|
||||
<b>Warning on line 94</b> - File "/home/andrew/projects/davical/htdocs/usr.php" has no page-level DocBlock, use @package in the first DocBlock to create one<br />
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 18 Sep 2008 00:10:47 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</body>
|
||||
</html>
|
||||
24
docs/api/index.html
Normal file
24
docs/api/index.html
Normal file
@ -0,0 +1,24 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html
|
||||
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//FR"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- Generated by phpDocumentor on Thu, 18 Sep 2008 00:10:45 +1200 -->
|
||||
<title>DAViCal</title>
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
|
||||
<FRAMESET rows='120,*'>
|
||||
<FRAME src='packages.html' name='left_top' frameborder="1" bordercolor="#999999">
|
||||
<FRAMESET cols='25%,*'>
|
||||
<FRAME src='li_davical.html' name='left_bottom' frameborder="1" bordercolor="#999999">
|
||||
<FRAME src='blank.html' name='right' frameborder="1" bordercolor="#999999">
|
||||
</FRAMESET>
|
||||
<NOFRAMES>
|
||||
<H2>Frame Alert</H2>
|
||||
<P>This document is designed to be viewed using the frames feature.
|
||||
If you see this message, you are using a non-frame-capable web client.</P>
|
||||
</NOFRAMES>
|
||||
</FRAMESET>
|
||||
</HTML>
|
||||
45
docs/api/li_awl.html
Normal file
45
docs/api/li_awl.html
Normal file
@ -0,0 +1,45 @@
|
||||
<?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>
|
||||
<div class="package-title">awl</div>
|
||||
<div class="package-details">
|
||||
|
||||
<dl class="tree">
|
||||
|
||||
<dt class="folder-title">Description</dt>
|
||||
<dd>
|
||||
<a href='classtrees_awl.html' target='right'>Class trees</a><br />
|
||||
<a href='elementindex_awl.html' target='right'>Index of elements</a><br />
|
||||
<a href="todolist.html" target="right">Todo List</a><br />
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="sub-package"><img class="tree-icon" src="media/images/package.png" alt="Sub-package">caldav</dt>
|
||||
<dd>
|
||||
<dl class="tree">
|
||||
<dt class="folder-title"><img class="tree-icon" src="media/images/class_folder.png" alt=" ">Classes</dt>
|
||||
<dd><img class="tree-icon" src="media/images/Class.png" alt="Class"><a href='awl/caldav/iCalDate.html' target='right'>iCalDate</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Class.png" alt="Class"><a href='awl/caldav/RRule.html' target='right'>RRule</a></dd>
|
||||
<dt class="folder-title"><img class="tree-icon" src="media/images/folder.png" alt=" ">Files</dt>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='awl/caldav/_inc---RRule.php.html' target='right'>RRule.php</a></dd>
|
||||
</dl>
|
||||
</dd>
|
||||
|
||||
|
||||
</dl>
|
||||
</div>
|
||||
<p class="notes"><a href="http://www.phpdoc.org" target="_blank">phpDocumentor v <span class="field">1.3.2</span></a></p>
|
||||
</BODY>
|
||||
</HTML>
|
||||
233
docs/api/li_davical.html
Normal file
233
docs/api/li_davical.html
Normal file
@ -0,0 +1,233 @@
|
||||
<?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>
|
||||
<div class="package-title">davical</div>
|
||||
<div class="package-details">
|
||||
|
||||
<dl class="tree">
|
||||
|
||||
<dt class="folder-title">Description</dt>
|
||||
<dd>
|
||||
<a href='classtrees_davical.html' target='right'>Class trees</a><br />
|
||||
<a href='elementindex_davical.html' target='right'>Index of elements</a><br />
|
||||
<a href="todolist.html" target="right">Todo List</a><br />
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
<dt class="folder-title"><img class="tree-icon" src="media/images/class_folder.png" alt=" ">Classes</dt>
|
||||
<dt class="folder-title"><img class="tree-icon" src="media/images/function_folder.png" alt=" ">Functions</dt>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/_inc---caldav-REPORT-calquery.php.html#functionapply_filter' target='right'>apply_filter</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/_inc---caldav-REPORT-calquery.php.html#functionBuildSqlFilter' target='right'>BuildSqlFilter</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/_inc---check_UTF8.php.html#functioncheck_string' target='right'>check_string</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/_inc---caldav-PUT-functions.php.html#functioncontrolRequestContainer' target='right'>controlRequestContainer</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/_inc---caldav-PUT-functions.php.html#functionimport_collection' target='right'>import_collection</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/_inc---page-header.php.html#functionmake_help_link' target='right'>make_help_link</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/_inc---caldav-REPORT-principal.php.html#functionprincipal_to_xml' target='right'>principal_to_xml</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/_inc---caldav-PUT-functions.php.html#functionpublic_events_only' target='right'>public_events_only</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/_inc---caldav-PUT-functions.php.html#functionputCalendarResource' target='right'>putCalendarResource</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/_inc---caldav-PUT-functions.php.html#functionrollback_on_error' target='right'>rollback_on_error</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/_inc---page-header.php.html#functionsend_page_header' target='right'>send_page_header</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/_inc---caldav-REPORT-calquery.php.html#functionSqlFilterFragment' target='right'>SqlFilterFragment</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/_inc---check_UTF8.php.html#functionunicodeToUtf8' target='right'>unicodeToUtf8</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/_inc---check_UTF8.php.html#functionutf8ToUnicode' target='right'>utf8ToUnicode</a></dd>
|
||||
<dt class="folder-title"><img class="tree-icon" src="media/images/folder.png" alt=" ">Files</dt>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/_inc---caldav-LOCK.php.html' target='right'>caldav-LOCK.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/_inc---caldav-PUT-functions.php.html' target='right'>caldav-PUT-functions.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/_inc---caldav-REPORT-calquery.php.html' target='right'>caldav-REPORT-calquery.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/_inc---caldav-REPORT-freebusy.php.html' target='right'>caldav-REPORT-freebusy.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/_inc---caldav-REPORT-multiget.php.html' target='right'>caldav-REPORT-multiget.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/_inc---caldav-REPORT-principal.php.html' target='right'>caldav-REPORT-principal.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/_inc---check_UTF8.php.html' target='right'>check_UTF8.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/_htdocs---collection.php.html' target='right'>collection.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/_inc---davical_configuration_missing.php.html' target='right'>davical_configuration_missing.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/_inc---freebusy-GET.php.html' target='right'>freebusy-GET.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/_htdocs---freebusy.php.html' target='right'>freebusy.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/_htdocs---help.php.html' target='right'>help.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/_htdocs---index.php.html' target='right'>index.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/_inc---interactive-page.php.html' target='right'>interactive-page.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/_inc---other_translated_strings.php.html' target='right'>other_translated_strings.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/_inc---page-footer.php.html' target='right'>page-footer.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/_inc---page-header.php.html' target='right'>page-header.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/_htdocs---relationship_types.php.html' target='right'>relationship_types.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/_htdocs---roles.php.html' target='right'>roles.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/_inc---test-RRULE.php.html' target='right'>test-RRULE.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/_htdocs---usr.php.html' target='right'>usr.php</a></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="sub-package"><img class="tree-icon" src="media/images/package.png" alt="Sub-package">Admin</dt>
|
||||
<dd>
|
||||
<dl class="tree">
|
||||
<dt class="folder-title"><img class="tree-icon" src="media/images/function_folder.png" alt=" ">Functions</dt>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/Admin/_htdocs---users.php.html#functiontranslate_relationship_list' target='right'>translate_relationship_list</a></dd>
|
||||
<dt class="folder-title"><img class="tree-icon" src="media/images/folder.png" alt=" ">Files</dt>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/Admin/_htdocs---users.php.html' target='right'>users.php</a></dd>
|
||||
</dl>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="sub-package"><img class="tree-icon" src="media/images/package.png" alt="Sub-package">authentication</dt>
|
||||
<dd>
|
||||
<dl class="tree">
|
||||
<dt class="folder-title"><img class="tree-icon" src="media/images/function_folder.png" alt=" ">Functions</dt>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/authentication/_inc---auth-functions.php.html#functionAuthExternalAWL' target='right'>AuthExternalAWL</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/authentication/_inc---auth-functions.php.html#functionCreateDefaultRelationships' target='right'>CreateDefaultRelationships</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/authentication/_inc---auth-functions.php.html#functionCreateHomeCalendar' target='right'>CreateHomeCalendar</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/authentication/_inc---auth-functions.php.html#functionUpdateUserFromExternal' target='right'>UpdateUserFromExternal</a></dd>
|
||||
<dt class="folder-title"><img class="tree-icon" src="media/images/folder.png" alt=" ">Files</dt>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/authentication/_inc---auth-functions.php.html' target='right'>auth-functions.php</a></dd>
|
||||
</dl>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="sub-package"><img class="tree-icon" src="media/images/package.png" alt="Sub-package">caldav</dt>
|
||||
<dd>
|
||||
<dl class="tree">
|
||||
<dt class="folder-title"><img class="tree-icon" src="media/images/function_folder.png" alt=" ">Functions</dt>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/caldav/_inc---caldav-REPORT.php.html#functioncalendar_to_xml' target='right'>calendar_to_xml</a></dd>
|
||||
<dt class="folder-title"><img class="tree-icon" src="media/images/folder.png" alt=" ">Files</dt>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/caldav/_inc---caldav-DELETE.php.html' target='right'>caldav-DELETE.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/caldav/_inc---caldav-GET.php.html' target='right'>caldav-GET.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/caldav/_inc---caldav-MKCALENDAR.php.html' target='right'>caldav-MKCALENDAR.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/caldav/_inc---caldav-OPTIONS.php.html' target='right'>caldav-OPTIONS.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/caldav/_inc---caldav-PROPPATCH.php.html' target='right'>caldav-PROPPATCH.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/caldav/_inc---caldav-PUT.php.html' target='right'>caldav-PUT.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/caldav/_inc---caldav-REPORT.php.html' target='right'>caldav-REPORT.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/caldav/_htdocs---caldav.php.html' target='right'>caldav.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/caldav/_htdocs---public.php.html' target='right'>public.php</a></dd>
|
||||
</dl>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="sub-package"><img class="tree-icon" src="media/images/package.png" alt="Sub-package">HTTPAuthSession</dt>
|
||||
<dd>
|
||||
<dl class="tree">
|
||||
<dt class="folder-title"><img class="tree-icon" src="media/images/class_folder.png" alt=" ">Classes</dt>
|
||||
<dd><img class="tree-icon" src="media/images/Class.png" alt="Class"><a href='davical/HTTPAuthSession/HTTPAuthSession.html' target='right'>HTTPAuthSession</a></dd>
|
||||
<dt class="folder-title"><img class="tree-icon" src="media/images/folder.png" alt=" ">Files</dt>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/HTTPAuthSession/_inc---HTTPAuthSession.php.html' target='right'>HTTPAuthSession.php</a></dd>
|
||||
</dl>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="sub-package"><img class="tree-icon" src="media/images/package.png" alt="Sub-package">ldap</dt>
|
||||
<dd>
|
||||
<dl class="tree">
|
||||
<dt class="folder-title"><img class="tree-icon" src="media/images/class_folder.png" alt=" ">Classes</dt>
|
||||
<dd><img class="tree-icon" src="media/images/Class.png" alt="Class"><a href='davical/ldap/ldapDrivers.html' target='right'>ldapDrivers</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Class.png" alt="Class"><a href='davical/ldap/squidPamDrivers.html' target='right'>squidPamDrivers</a></dd>
|
||||
<dt class="folder-title"><img class="tree-icon" src="media/images/function_folder.png" alt=" ">Functions</dt>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/ldap/_inc---drivers_ldap.php.html#functiongetStaticLdap' target='right'>getStaticLdap</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/ldap/_inc---drivers_ldap.php.html#functionLDAP_check' target='right'>LDAP_check</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/ldap/_inc---drivers_squid_pam.php.html#functionSQUID_PAM_check' target='right'>SQUID_PAM_check</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/ldap/_inc---drivers_ldap.php.html#functionsync_LDAP' target='right'>sync_LDAP</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/ldap/_inc---drivers_ldap.php.html#functionsync_user_from_LDAP' target='right'>sync_user_from_LDAP</a></dd>
|
||||
<dt class="folder-title"><img class="tree-icon" src="media/images/folder.png" alt=" ">Files</dt>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/ldap/_inc---drivers_ldap.php.html' target='right'>drivers_ldap.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/ldap/_inc---drivers_squid_pam.php.html' target='right'>drivers_squid_pam.php</a></dd>
|
||||
</dl>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="sub-package"><img class="tree-icon" src="media/images/package.png" alt="Sub-package">Principal</dt>
|
||||
<dd>
|
||||
<dl class="tree">
|
||||
<dt class="folder-title"><img class="tree-icon" src="media/images/class_folder.png" alt=" ">Classes</dt>
|
||||
<dd><img class="tree-icon" src="media/images/Class.png" alt="Class"><a href='davical/Principal/CalDAVPrincipal.html' target='right'>CalDAVPrincipal</a></dd>
|
||||
<dt class="folder-title"><img class="tree-icon" src="media/images/folder.png" alt=" ">Files</dt>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/Principal/_inc---CalDAVPrincipal.php.html' target='right'>CalDAVPrincipal.php</a></dd>
|
||||
</dl>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="sub-package"><img class="tree-icon" src="media/images/package.png" alt="Sub-package">propfind</dt>
|
||||
<dd>
|
||||
<dl class="tree">
|
||||
<dt class="folder-title"><img class="tree-icon" src="media/images/function_folder.png" alt=" ">Functions</dt>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/propfind/_inc---caldav-PROPFIND.php.html#functionadd_namespace' target='right'>add_namespace</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/propfind/_inc---caldav-PROPFIND.php.html#functionadd_principal_properties' target='right'>add_principal_properties</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/propfind/_inc---caldav-PROPFIND.php.html#functioncaldav_tag' target='right'>caldav_tag</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/propfind/_inc---caldav-PROPFIND.php.html#functioncollection_to_xml' target='right'>collection_to_xml</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/propfind/_inc---caldav-PROPFIND.php.html#functionget_arbitrary_properties' target='right'>get_arbitrary_properties</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/propfind/_inc---caldav-PROPFIND.php.html#functionget_collection' target='right'>get_collection</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/propfind/_inc---caldav-PROPFIND.php.html#functionget_collection_contents' target='right'>get_collection_contents</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/propfind/_inc---caldav-PROPFIND.php.html#functionget_item' target='right'>get_item</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/propfind/_inc---caldav-PROPFIND.php.html#functionitem_to_xml' target='right'>item_to_xml</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/propfind/_inc---caldav-PROPFIND.php.html#functionnamespace_array' target='right'>namespace_array</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/propfind/_inc---caldav-PROPFIND.php.html#functionns_tag' target='right'>ns_tag</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/propfind/_inc---caldav-PROPFIND.php.html#functionprivileges' target='right'>privileges</a></dd>
|
||||
<dt class="folder-title"><img class="tree-icon" src="media/images/folder.png" alt=" ">Files</dt>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/propfind/_inc---caldav-PROPFIND.php.html' target='right'>caldav-PROPFIND.php</a></dd>
|
||||
</dl>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="sub-package"><img class="tree-icon" src="media/images/package.png" alt="Sub-package">Request</dt>
|
||||
<dd>
|
||||
<dl class="tree">
|
||||
<dt class="folder-title"><img class="tree-icon" src="media/images/class_folder.png" alt=" ">Classes</dt>
|
||||
<dd><img class="tree-icon" src="media/images/Class.png" alt="Class"><a href='davical/Request/CalDAVRequest.html' target='right'>CalDAVRequest</a></dd>
|
||||
<dt class="folder-title"><img class="tree-icon" src="media/images/folder.png" alt=" ">Files</dt>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/Request/_inc---CalDAVRequest.php.html' target='right'>CalDAVRequest.php</a></dd>
|
||||
</dl>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="sub-package"><img class="tree-icon" src="media/images/package.png" alt="Sub-package">RSCDSSession</dt>
|
||||
<dd>
|
||||
<dl class="tree">
|
||||
<dt class="folder-title"><img class="tree-icon" src="media/images/class_folder.png" alt=" ">Classes</dt>
|
||||
<dd><img class="tree-icon" src="media/images/Class.png" alt="Class"><a href='davical/RSCDSSession/RSCDSSession.html' target='right'>RSCDSSession</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Class.png" alt="Class"><a href='davical/RSCDSSession/Tools.html' target='right'>Tools</a></dd>
|
||||
<dt class="folder-title"><img class="tree-icon" src="media/images/function_folder.png" alt=" ">Functions</dt>
|
||||
<dd><img class="tree-icon" src="media/images/Function.png" alt="Function"><a href='davical/RSCDSSession/_inc---RSCDSSession.php.html#functionlocal_session_sql' target='right'>local_session_sql</a></dd>
|
||||
<dt class="folder-title"><img class="tree-icon" src="media/images/folder.png" alt=" ">Files</dt>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/RSCDSSession/_inc---RSCDSSession.php.html' target='right'>RSCDSSession.php</a></dd>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/RSCDSSession/_htdocs---tools.php.html' target='right'>tools.php</a></dd>
|
||||
</dl>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="sub-package"><img class="tree-icon" src="media/images/package.png" alt="Sub-package">RSCDSUser</dt>
|
||||
<dd>
|
||||
<dl class="tree">
|
||||
<dt class="folder-title"><img class="tree-icon" src="media/images/class_folder.png" alt=" ">Classes</dt>
|
||||
<dd><img class="tree-icon" src="media/images/Class.png" alt="Class"><a href='davical/RSCDSUser/RSCDSUser.html' target='right'>RSCDSUser</a></dd>
|
||||
<dt class="folder-title"><img class="tree-icon" src="media/images/folder.png" alt=" ">Files</dt>
|
||||
<dd><img class="tree-icon" src="media/images/Page.png" alt="File"><a href='davical/RSCDSUser/_inc---RSCDSUser.php.html' target='right'>RSCDSUser.php</a></dd>
|
||||
</dl>
|
||||
</dd>
|
||||
|
||||
|
||||
</dl>
|
||||
</div>
|
||||
<p class="notes"><a href="http://www.phpdoc.org" target="_blank">phpDocumentor v <span class="field">1.3.2</span></a></p>
|
||||
</BODY>
|
||||
</HTML>
|
||||
33
docs/api/media/banner.css
Normal file
33
docs/api/media/banner.css
Normal file
@ -0,0 +1,33 @@
|
||||
body
|
||||
{
|
||||
background-color: #EEEEEE;
|
||||
margin: 0px;
|
||||
padding: 0px;
|
||||
}
|
||||
|
||||
/* Banner (top bar) classes */
|
||||
|
||||
.banner { }
|
||||
|
||||
.banner-menu
|
||||
{
|
||||
text-align: right;
|
||||
clear: both;
|
||||
padding: .5em;
|
||||
border-top: 2px solid #AAAAAA;
|
||||
}
|
||||
|
||||
.banner-title
|
||||
{
|
||||
text-align: right;
|
||||
font-size: 20pt;
|
||||
font-weight: bold;
|
||||
margin: .2em;
|
||||
}
|
||||
|
||||
.package-selector
|
||||
{
|
||||
background-color: #DDDDDD;
|
||||
border: 1px solid #AAAAAA;
|
||||
color: #000090;
|
||||
}
|
||||
BIN
docs/api/media/images/AbstractClass.png
Normal file
BIN
docs/api/media/images/AbstractClass.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 620 B |
BIN
docs/api/media/images/AbstractClass_logo.png
Normal file
BIN
docs/api/media/images/AbstractClass_logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.2 KiB |
BIN
docs/api/media/images/AbstractMethod.png
Normal file
BIN
docs/api/media/images/AbstractMethod.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 696 B |
BIN
docs/api/media/images/AbstractPrivateClass.png
Normal file
BIN
docs/api/media/images/AbstractPrivateClass.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 848 B |
BIN
docs/api/media/images/AbstractPrivateClass_logo.png
Normal file
BIN
docs/api/media/images/AbstractPrivateClass_logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.6 KiB |
BIN
docs/api/media/images/AbstractPrivateMethod.png
Normal file
BIN
docs/api/media/images/AbstractPrivateMethod.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 874 B |
BIN
docs/api/media/images/Class.png
Normal file
BIN
docs/api/media/images/Class.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 570 B |
BIN
docs/api/media/images/Class_logo.png
Normal file
BIN
docs/api/media/images/Class_logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.6 KiB |
BIN
docs/api/media/images/Constant.png
Normal file
BIN
docs/api/media/images/Constant.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 752 B |
BIN
docs/api/media/images/Constructor.png
Normal file
BIN
docs/api/media/images/Constructor.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 865 B |
BIN
docs/api/media/images/Destructor.png
Normal file
BIN
docs/api/media/images/Destructor.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 956 B |
BIN
docs/api/media/images/Function.png
Normal file
BIN
docs/api/media/images/Function.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 596 B |
BIN
docs/api/media/images/Global.png
Normal file
BIN
docs/api/media/images/Global.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 712 B |
BIN
docs/api/media/images/I.png
Normal file
BIN
docs/api/media/images/I.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 148 B |
BIN
docs/api/media/images/Index.png
Normal file
BIN
docs/api/media/images/Index.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 584 B |
BIN
docs/api/media/images/Interface.png
Normal file
BIN
docs/api/media/images/Interface.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.1 KiB |
BIN
docs/api/media/images/Interface_logo.png
Normal file
BIN
docs/api/media/images/Interface_logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.6 KiB |
BIN
docs/api/media/images/L.png
Normal file
BIN
docs/api/media/images/L.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 153 B |
BIN
docs/api/media/images/Lminus.png
Normal file
BIN
docs/api/media/images/Lminus.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 219 B |
BIN
docs/api/media/images/Lplus.png
Normal file
BIN
docs/api/media/images/Lplus.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 224 B |
BIN
docs/api/media/images/Method.png
Normal file
BIN
docs/api/media/images/Method.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 661 B |
BIN
docs/api/media/images/Page.png
Normal file
BIN
docs/api/media/images/Page.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 592 B |
BIN
docs/api/media/images/Page_logo.png
Normal file
BIN
docs/api/media/images/Page_logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.3 KiB |
BIN
docs/api/media/images/PrivateClass.png
Normal file
BIN
docs/api/media/images/PrivateClass.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 790 B |
BIN
docs/api/media/images/PrivateClass_logo.png
Normal file
BIN
docs/api/media/images/PrivateClass_logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.8 KiB |
BIN
docs/api/media/images/PrivateMethod.png
Normal file
BIN
docs/api/media/images/PrivateMethod.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 918 B |
BIN
docs/api/media/images/PrivateVariable.png
Normal file
BIN
docs/api/media/images/PrivateVariable.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 772 B |
BIN
docs/api/media/images/StaticMethod.png
Normal file
BIN
docs/api/media/images/StaticMethod.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 661 B |
BIN
docs/api/media/images/StaticVariable.png
Normal file
BIN
docs/api/media/images/StaticVariable.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 688 B |
BIN
docs/api/media/images/T.png
Normal file
BIN
docs/api/media/images/T.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 152 B |
BIN
docs/api/media/images/Tminus.png
Normal file
BIN
docs/api/media/images/Tminus.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 207 B |
BIN
docs/api/media/images/Tplus.png
Normal file
BIN
docs/api/media/images/Tplus.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 222 B |
BIN
docs/api/media/images/Variable.png
Normal file
BIN
docs/api/media/images/Variable.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 688 B |
BIN
docs/api/media/images/blank.png
Normal file
BIN
docs/api/media/images/blank.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 144 B |
BIN
docs/api/media/images/class_folder.png
Normal file
BIN
docs/api/media/images/class_folder.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 633 B |
BIN
docs/api/media/images/empty.png
Normal file
BIN
docs/api/media/images/empty.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 90 B |
BIN
docs/api/media/images/file.png
Normal file
BIN
docs/api/media/images/file.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 462 B |
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user