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/RepeatRuleDateTime.html
Andrew McMillan 927a98482f Release 1.0.2
2012-01-14 10:46:56 +13:00

1049 lines
35 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 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">Wrap the DateTime class to make it friendlier to passing in random strings from iCalendar objects, and especially the random stuff used to identify timezones. We also add some utility methods and stuff too, in order to simplify some of the operations we need to do with dates.</p>
<p class="notes">
Located in <a class="field" href="_inc---RRule-v2.php.html">/inc/RRule-v2.php</a> (line <span class="field">204</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/StaticMethod.png" alt=" "/>
static <span class="method-result">int</span>
<a href="#daysInMonth" title="details" class="method-name">daysInMonth</a>
(<span class="var-type">int</span>&nbsp;<span class="var-name">$year</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$month</span>)
</div>
<div class="method-definition">
<img src="../../media/images/StaticMethod.png" alt=" "/>
static <span class="method-result">1</span>
<a href="#hasLeapDay" title="details" class="method-name">hasLeapDay</a>
(<span class="var-type">int</span>&nbsp;<span class="var-name">$year</span>)
</div>
<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>], [<span class="var-type"></span>&nbsp;<span class="var-name">$is_date</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="#AsDate" title="details" class="method-name">AsDate</a>
()
</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="#epoch" title="details" class="method-name">epoch</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#FloatOrUTC" title="details" class="method-name">FloatOrUTC</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="#getTimeZone" title="details" class="method-name">getTimeZone</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="#isDate" title="details" class="method-name">isDate</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#isFloating" title="details" class="method-name">isFloating</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="#modify" title="details" class="method-name">modify</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$interval</span>)
</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>
([<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="#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="#setAsDate" title="details" class="method-name">setAsDate</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#setAsFloat" title="details" class="method-name">setAsFloat</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="#setYearDay" title="details" class="method-name">setYearDay</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$yearday</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>
([<span class="var-type"></span>&nbsp;<span class="var-name">$fmt</span> = <span class="var-default">'Ymd\THis\Z'</span>])
</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="evenrow">
<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">206</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="methoddaysInMonth" id="daysInMonth"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/StaticMethod.png" />
<span class="method-title">static daysInMonth</span> (line <span class="line-number">453</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the number of days in a year/month pair</p>
<ul class="tags">
<li><span class="field">return:</span> the number of days in the month</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">int</span>
<span class="method-name">
daysInMonth
</span>
(<span class="var-type">int</span>&nbsp;<span class="var-name">$year</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$month</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">int</span>
<span class="var-name">$year</span> </li>
<li>
<span class="var-type">int</span>
<span class="var-name">$month</span> </li>
</ul>
</div>
<a name="methodhasLeapDay" id="hasLeapDay"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/StaticMethod.png" />
<span class="method-title">static hasLeapDay</span> (line <span class="line-number">442</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns a 1 if this year is a leap year, otherwise a 0</p>
<ul class="tags">
<li><span class="field">return:</span> if this is a leap year, 0 otherwise</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">1</span>
<span class="method-name">
hasLeapDay
</span>
(<span class="var-type">int</span>&nbsp;<span class="var-name">$year</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">int</span>
<span class="var-name">$year</span><span class="var-description">: The year we are quizzical about.</span> </li>
</ul>
</div>
<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">211</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>], [<span class="var-type"></span>&nbsp;<span class="var-name">$is_date</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"></span>
<span class="var-name">$dtz</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$is_date</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt>DateTime::constructor __construct ( [$time = ], [$object = ] )</dt>
</dl>
</div>
<a name="methodAsDate" id="AsDate"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">AsDate</span> (line <span class="line-number">308</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">
AsDate
</span>
()
</div>
</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">494</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="methodepoch" id="epoch"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">epoch</span> (line <span class="line-number">510</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
epoch
</span>
()
</div>
</div>
<a name="methodFloatOrUTC" id="FloatOrUTC"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">FloatOrUTC</span> (line <span class="line-number">388</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">If this is a localised time then this will return the UTC equivalent. If it is a floating time, then you will just get the floating time. If it is a date then it will be returned as a date. Note that if it is a *localised* date then the answer will still be the UTC equivalent but only the date itself will be returned.</p>
<p class="description"><p>If return_floating_times is true then all dates will be returned as floating times and UTC will not be returned.</p></p>
<ul class="tags">
<li><span class="field">see:</span> <a href="../../awl/caldav/RepeatRuleDateTime.html#methodUTC">RepeatRuleDateTime::UTC()</a></li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
FloatOrUTC
</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="methodgetTimeZone" id="getTimeZone"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">getTimeZone</span> (line <span class="line-number">432</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">
getTimeZone
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt>DateTime::getTimezone ( )</dt>
</dl>
</div>
<a name="methodhour" id="hour"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">hour</span> (line <span class="line-number">498</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="methodisDate" id="isDate"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">isDate</span> (line <span class="line-number">322</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">
isDate
</span>
()
</div>
</div>
<a name="methodisFloating" id="isFloating"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">isFloating</span> (line <span class="line-number">318</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">
isFloating
</span>
()
</div>
</div>
<a name="methodminute" id="minute"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">minute</span> (line <span class="line-number">502</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="methodmodify" id="modify"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">modify</span> (line <span class="line-number">332</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">
modify
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$interval</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$interval</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt>DateTime::modify ( $modify )</dt>
</dl>
</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">490</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">404</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the string following a property name for an RFC5545 DATE-TIME value.</p>
<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>
([<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="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">506</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="methodsetAsDate" id="setAsDate"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">setAsDate</span> (line <span class="line-number">327</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">
setAsDate
</span>
()
</div>
</div>
<a name="methodsetAsFloat" id="setAsFloat"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">setAsFloat</span> (line <span class="line-number">313</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">
setAsFloat
</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">460</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 ( $year, $month, $day )</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">422</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 ( $timezone )</dt>
</dl>
</div>
<a name="methodsetYearDay" id="setYearDay"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">setYearDay</span> (line <span class="line-number">471</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setYearDay
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$yearday</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$yearday</span> </li>
</ul>
</div>
<a name="methodUTC" id="UTC"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">UTC</span> (line <span class="line-number">361</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Always returns a time localised to UTC. Even floating times are converted to UTC using the server's currently configured PHP timezone. Even dates will include a time, which will be non-zero if they were localised dates.</p>
<ul class="tags">
<li><span class="field">see:</span> <a href="../../awl/caldav/RepeatRuleDateTime.html#methodFloatOrUTC">RepeatRuleDateTime::FloatOrUTC()</a></li>
<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>
([<span class="var-type"></span>&nbsp;<span class="var-name">$fmt</span> = <span class="var-default">'Ymd\THis\Z'</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$fmt</span> </li>
</ul>
</div>
<a name="methodyear" id="year"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">year</span> (line <span class="line-number">486</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="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">__toString</span> (line <span class="line-number">303</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 ( [$time = ], [$object = ] )</span><br>
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name">add ( $interval )</span><br>
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name">createFromFormat ( $format, $time, [$object = ] )</span><br>
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name">diff ( $object, [$absolute = ] )</span><br>
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name">format ( $format )</span><br>
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name">getLastErrors ( )</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">getTimestamp ( )</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 ( $modify )</span><br>
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name">setDate ( $year, $month, $day )</span><br>
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name">setISODate ( $year, $week, [$day = ] )</span><br>
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name">setTime ( $hour, $minute, [$second = ] )</span><br>
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name">setTimestamp ( $unixtimestamp )</span><br>
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name">setTimezone ( $timezone )</span><br>
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name">sub ( $interval )</span><br>
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name">__set_state ( )</span><br>
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-name">__wakeup ( )</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 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