mirror of
https://gitlab.com/davical-project/davical.git
synced 2026-02-16 03:53:40 +00:00
382 lines
18 KiB
HTML
382 lines
18 KiB
HTML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<!-- template designed by Marco Von Ballmoos -->
|
|
<title></title>
|
|
<link rel="stylesheet" href="media/stylesheet.css" />
|
|
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
|
</head>
|
|
<body>
|
|
|
|
<a name="top"></a>
|
|
<h2>[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>
|