davical/docs/api/awl/caldav/RepeatRuleDateTime.html
2010-02-25 12:35:02 +13:00

621 lines
21 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>Docs For Class RepeatRuleDateTime</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"> RepeatRuleDateTime</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>)
<a href="#sec-consts">Constants</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 &lt;<a href="mailto:andrew@mcmillan.net.nz">andrew@mcmillan.net.nz</a>&gt;</li>
<li><span class="field">copyright:</span> Morphoss Ltd</li>
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2 or later</a></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">37</span>)
</p>
<pre>DateTime
|
--RepeatRuleDateTime</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>)
<a href="#sec-consts">Constants</a>
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<img src="../../media/images/StaticVariable.png" alt=" " />
static <span class="var-type">mixed</span>
<a href="#$Format" title="details" class="var-name">$Format</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-consts">Constants</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">RepeatRuleDateTime</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
([<span class="var-type"></span>&nbsp;<span class="var-name">$date</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$dtz</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="#day" title="details" class="method-name">day</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#hour" title="details" class="method-name">hour</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#minute" title="details" class="method-name">minute</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#month" title="details" class="method-name">month</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#RFC5545" title="details" class="method-name">RFC5545</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#second" title="details" class="method-name">second</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#setDate" title="details" class="method-name">setDate</a>
([<span class="var-type"></span>&nbsp;<span class="var-name">$year</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$month</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$day</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="#setTimeZone" title="details" class="method-name">setTimeZone</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$tz</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#UTC" title="details" class="method-name">UTC</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#year" title="details" class="method-name">year</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#__toString" title="details" class="method-name">__toString</a>
()
</div>
</div>
</div>
</div>
<a name="sec-vars"></a>
<div class="info-box">
<div class="info-box-title">Variables</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
<a href="#sec-consts">Constants</a>
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<a name="var$Format" id="$Format"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<img src="../../media/images/Variable.png" />
<span class="var-title">
static <span class="var-type">mixed</span>
<span class="var-name">$Format</span>
= <span class="var-default"> 'c'</span> (line <span class="line-number">39</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Constructor.png" />
<span class="method-title">Constructor __construct</span> (line <span class="line-number">42</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">RepeatRuleDateTime</span>
<span class="method-name">
__construct
</span>
([<span class="var-type"></span>&nbsp;<span class="var-name">$date</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$dtz</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$date</span> </li>
<li>
<span class="var-type">DateTimeZone</span>
<span class="var-name">$dtz</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt>DateTime::constructor __construct ( )</dt>
</dl>
</div>
<a name="methodday" id="day"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">day</span> (line <span class="line-number">133</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
day
</span>
()
</div>
</div>
<a name="methodhour" id="hour"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">hour</span> (line <span class="line-number">137</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
hour
</span>
()
</div>
</div>
<a name="methodminute" id="minute"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">minute</span> (line <span class="line-number">141</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
minute
</span>
()
</div>
</div>
<a name="methodmonth" id="month"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">month</span> (line <span class="line-number">129</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
month
</span>
()
</div>
</div>
<a name="methodRFC5545" id="RFC5545"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">RFC5545</span> (line <span class="line-number">98</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">
RFC5545
</span>
()
</div>
</div>
<a name="methodsecond" id="second"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">second</span> (line <span class="line-number">145</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
second
</span>
()
</div>
</div>
<a name="methodsetDate" id="setDate"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">setDate</span> (line <span class="line-number">117</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setDate
</span>
([<span class="var-type"></span>&nbsp;<span class="var-name">$year</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$month</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$day</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$year</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$month</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$day</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt>DateTime::setDate ( )</dt>
</dl>
</div>
<a name="methodsetTimeZone" id="setTimeZone"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">setTimeZone</span> (line <span class="line-number">111</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">
setTimeZone
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$tz</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$tz</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt>DateTime::setTimezone ( )</dt>
</dl>
</div>
<a name="methodUTC" id="UTC"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">UTC</span> (line <span class="line-number">87</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">
UTC
</span>
()
</div>
</div>
<a name="methodyear" id="year"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">year</span> (line <span class="line-number">125</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
year
</span>
()
</div>
</div>
<a name="method__toString" id="__toString"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">__toString</span> (line <span class="line-number">82</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">
__toString
</span>
()
</div>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname">DateTime (Internal Class)</span></p>
<blockquote>
<img src="../../media/images/Constructor.png" alt=" "/>
<span class="method-name">constructor __construct ( )</span><br />
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name">format ( )</span><br />
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name">getOffset ( )</span><br />
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name">getTimezone ( )</span><br />
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name">modify ( )</span><br />
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name">setDate ( )</span><br />
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name">setISODate ( )</span><br />
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name">setTime ( )</span><br />
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name">setTimezone ( )</span><br />
</blockquote>
</div>
</div>
<a name="sec-consts"></a>
<div class="info-box">
<div class="info-box-title">Class Constants</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</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">
<h4>Inherited Constants</h4>
<A NAME='inherited_consts'><!-- --></A>
<p>Inherited from <span class="classname">DateTime (Internal Class)</span></p>
<blockquote>
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">ATOM = 'Y-m-d\\TH:i:sP'</span><br />
</span>
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">COOKIE = 'l, d-M-y H:i:s T'</span><br />
</span>
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">ISO8601 = 'Y-m-d\\TH:i:sO'</span><br />
</span>
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">RFC822 = 'D, d M y H:i:s O'</span><br />
</span>
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">RFC850 = 'l, d-M-y H:i:s T'</span><br />
</span>
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">RFC1036 = 'D, d M y H:i:s O'</span><br />
</span>
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">RFC1123 = 'D, d M Y H:i:s O'</span><br />
</span>
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">RFC2822 = 'D, d M Y H:i:s O'</span><br />
</span>
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">RFC3339 = 'Y-m-d\\TH:i:sP'</span><br />
</span>
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">RSS = 'D, d M Y H:i:s O'</span><br />
</span>
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">W3C = 'Y-m-d\\TH:i:sP'</span><br />
</span>
</blockquote>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Thu, 25 Feb 2010 11:39:21 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
</p>
</div></body>
</html>