nik/davical
1
0
Fork 0
mirror of https://gitlab.com/davical-project/davical.git synced 2026-02-18 04:13:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
davical/docs/api/awl/caldav/RepeatRule.html
Andrew McMillan 927a98482f Release 1.0.2
2012-01-14 10:46:56 +13:00

478 lines
17 KiB
HTML
Raw Blame History

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class RepeatRule</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"> RepeatRule</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">This class is an implementation of RRULE parsing and expansion, as per RFC5545. It should be reasonably complete, except that it does not handle changing the WKST - there may be a few errors in unusual rules also, but all of the common cases should be handled correctly.</p>
<ul class="tags">
<li><span class="field">author:</span> Andrew McMillan &lt;<a href="mailto:andrew@mcmillan.net.nz">andrew@mcmillan.net.nz</a>&gt;</li>
</ul>
<p class="notes">
Located in <a class="field" href="_inc---RRule-v2.php.html">/inc/RRule-v2.php</a> (line <span class="field">590</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/StaticMethod.png" alt=" "/>
static <span class="method-result">void</span>
<a href="#date_mask" title="details" class="method-name">date_mask</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$date</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$y</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$mo</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$d</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$h</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$mi</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$s</span>)
</div>
<div class="method-definition">
<img src="../../media/images/StaticMethod.png" alt=" "/>
static <span class="method-result">void</span>
<a href="#rrule_day_number" title="details" class="method-name">rrule_day_number</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$day</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Constructor.png" alt=" "/>
<span class="method-result">RepeatRule</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$basedate</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$rrule</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$is_date</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$return_floating_times</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#current" title="details" class="method-name">current</a>
([<span class="var-type"></span>&nbsp;<span class="var-name">$return_floating_times</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">boolean</span>
<a href="#hasLimitedOccurrences" title="details" class="method-name">hasLimitedOccurrences</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#key" title="details" class="method-name">key</a>
([<span class="var-type"></span>&nbsp;<span class="var-name">$return_floating_times</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">vComponent</span>
<a href="#next" title="details" class="method-name">next</a>
([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$return_floating_times</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#rewind" title="details" class="method-name">rewind</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#set_timezone" title="details" class="method-name">set_timezone</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$tzstring</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#Start" title="details" class="method-name">Start</a>
([<span class="var-type"></span>&nbsp;<span class="var-name">$return_floating_times</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#valid" title="details" class="method-name">valid</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="methoddate_mask" id="date_mask"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/StaticMethod.png" />
<span class="method-title">static date_mask</span> (line <span class="line-number">824</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
date_mask
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$date</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$y</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$mo</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$d</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$h</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$mi</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$s</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$date</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$y</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$mo</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$d</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$h</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$mi</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$s</span> </li>
</ul>
</div>
<a name="methodrrule_day_number" id="rrule_day_number"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/StaticMethod.png" />
<span class="method-title">static rrule_day_number</span> (line <span class="line-number">810</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
rrule_day_number
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$day</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$day</span> </li>
</ul>
</div>
<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">615</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">RepeatRule</span>
<span class="method-name">
__construct
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$basedate</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$rrule</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$is_date</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$return_floating_times</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$basedate</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$rrule</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$is_date</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$return_floating_times</span> </li>
</ul>
</div>
<a name="methodcurrent" id="current"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">current</span> (line <span class="line-number">702</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
current
</span>
([<span class="var-type"></span>&nbsp;<span class="var-name">$return_floating_times</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$return_floating_times</span> </li>
</ul>
</div>
<a name="methodhasLimitedOccurrences" id="hasLimitedOccurrences"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">hasLimitedOccurrences</span> (line <span class="line-number">668</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">If this repeat rule has an UNTIL= or COUNT= then we can know it will end. Eventually.</p>
<ul class="tags">
<li><span class="field">return:</span> Whether or not one of these properties is present.</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
hasLimitedOccurrences
</span>
()
</div>
</div>
<a name="methodkey" id="key"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">key</span> (line <span class="line-number">712</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
key
</span>
([<span class="var-type"></span>&nbsp;<span class="var-name">$return_floating_times</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$return_floating_times</span> </li>
</ul>
</div>
<a name="methodnext" id="next"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">next</span> (line <span class="line-number">696</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the next date in the repeating series.</p>
<ul class="tags">
<li><span class="field">return:</span> The next instance.</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">vComponent</span>
<span class="method-name">
next
</span>
([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$return_floating_times</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">boolean</span>
<span class="var-name">$return_floating_times</span><span class="var-description">: Whether to return dates as floating times.</span> </li>
</ul>
</div>
<a name="methodrewind" id="rewind"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">rewind</span> (line <span class="line-number">686</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
rewind
</span>
()
</div>
</div>
<a name="methodset_timezone" id="set_timezone"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">set_timezone</span> (line <span class="line-number">673</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
set_timezone
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$tzstring</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$tzstring</span> </li>
</ul>
</div>
<a name="methodStart" id="Start"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">Start</span> (line <span class="line-number">678</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
Start
</span>
([<span class="var-type"></span>&nbsp;<span class="var-name">$return_floating_times</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$return_floating_times</span> </li>
</ul>
</div>
<a name="methodvalid" id="valid"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">valid</span> (line <span class="line-number">722</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
valid
</span>
()
</div>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Fri, 13 Jan 2012 23:44:56 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>
Reference in New Issue View Git Blame Copy Permalink