?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Release 0.9.9.6
[davical.git] / docs / api / awl / caldav / iCalDate.html
blob8e227a1300c511df47de105642d9d010336744e3
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <!-- template designed by Marco Von Ballmoos -->
6 <title>Docs For Class iCalDate</title>
7 <link rel="stylesheet" href="../../media/stylesheet.css" />
8 <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
9 </head>
10 <body>
11 <div class="page-body">
12 <h2 class="class-name"><img src="../../media/images/Class_logo.png"
13 alt=" Class"
14 title=" Class"
15 style="vertical-align: middle"> iCalDate</h2>
16
17 <a name="sec-description"></a>
18 <div class="info-box">
19 <div class="info-box-title">Description</div>
20 <div class="nav-bar">
21 <span class="disabled">Description</span> |
22 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
23
24 </div>
25 <div class="info-box-body">
26 <!-- ========== Info from phpDoc block ========= -->
27 <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>
28 <p class="notes">
29 Located in <a class="field" href="_inc---RRule.php.html">/inc/RRule.php</a> (line <span class="field">21</span>)
30 </p>
31
32
33 <pre></pre>
34
35 </div>
36 </div>
37
38
39
40
41 <a name="sec-method-summary"></a>
42 <div class="info-box">
43 <div class="info-box-title">Method Summary</span></div>
44 <div class="nav-bar">
45 <a href="#sec-description">Description</a> |
46 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
47 </div>
48 <div class="info-box-body">
49 <div class="method-summary">
50 <div class="method-definition">
51 <img src="../../media/images/Constructor.png" alt=" "/>
52 <span class="method-result">iCalDate</span>
53 <a href="#iCalDate" title="details" class="method-name">iCalDate</a>
54 (<span class="var-type"></span>&nbsp;<span class="var-name">$input</span>)
55 </div>
56 <div class="method-definition">
57 <img src="../../media/images/Method.png" alt=" "/>
58 <span class="method-result">void</span>
59 <a href="#AddDays" title="details" class="method-name">AddDays</a>
60 (<span class="var-type"></span>&nbsp;<span class="var-name">$dd</span>)
61 </div>
62 <div class="method-definition">
63 <img src="../../media/images/Method.png" alt=" "/>
64 <span class="method-result">void</span>
65 <a href="#AddDuration" title="details" class="method-name">AddDuration</a>
66 (<span class="var-type"></span>&nbsp;<span class="var-name">$duration</span>)
67 </div>
68 <div class="method-definition">
69 <img src="../../media/images/Method.png" alt=" "/>
70 <span class="method-result">void</span>
71 <a href="#AddMonths" title="details" class="method-name">AddMonths</a>
72 (<span class="var-type"></span>&nbsp;<span class="var-name">$mo</span>)
73 </div>
74 <div class="method-definition">
75 <img src="../../media/images/Method.png" alt=" "/>
76 <span class="method-result">array</span>
77 <a href="#ApplyBySetPos" title="details" class="method-name">&amp;ApplyBySetPos</a>
78 (<span class="var-type">string</span>&nbsp;<span class="var-name">$bysplist</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$set</span>)
79 </div>
80 <div class="method-definition">
81 <img src="../../media/images/Method.png" alt=" "/>
82 <span class="method-result">string</span>
83 <a href="#DateDifference" title="details" class="method-name">DateDifference</a>
84 (<span class="var-type">date</span>&nbsp;<span class="var-name">$from</span>)
85 </div>
86 <div class="method-definition">
87 <img src="../../media/images/Method.png" alt=" "/>
88 <span class="method-result">void</span>
89 <a href="#DaysInMonth" title="details" class="method-name">DaysInMonth</a>
90 ([<span class="var-type"></span>&nbsp;<span class="var-name">$mo</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$yy</span> = <span class="var-default">false</span>])
91 </div>
92 <div class="method-definition">
93 <img src="../../media/images/Method.png" alt=" "/>
94 <span class="method-result">array</span>
95 <a href="#GetMonthByDay" title="details" class="method-name">GetMonthByDay</a>
96 (<span class="var-type">string</span>&nbsp;<span class="var-name">$byday</span>)
97 </div>
98 <div class="method-definition">
99 <img src="../../media/images/Method.png" alt=" "/>
100 <span class="method-result">array</span>
101 <a href="#GetMonthByMonthDay" title="details" class="method-name">GetMonthByMonthDay</a>
102 (<span class="var-type">string</span>&nbsp;<span class="var-name">$bymonthday</span>)
103 </div>
104 <div class="method-definition">
105 <img src="../../media/images/Method.png" alt=" "/>
106 <span class="method-result">array</span>
107 <a href="#GetWeekByDay" title="details" class="method-name">GetWeekByDay</a>
108 (<span class="var-type">string</span>&nbsp;<span class="var-name">$byday</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$increasing</span> = <span class="var-default">false</span>])
109 </div>
110 <div class="method-definition">
111 <img src="../../media/images/Method.png" alt=" "/>
112 <span class="method-result">boolean</span>
113 <a href="#GreaterThan" title="details" class="method-name">GreaterThan</a>
114 (<span class="var-type">string</span>&nbsp;<span class="var-name">$lesser</span>)
115 </div>
116 <div class="method-definition">
117 <img src="../../media/images/Method.png" alt=" "/>
118 <span class="method-result">boolean</span>
119 <a href="#LessThan" title="details" class="method-name">LessThan</a>
120 (<span class="var-type">string</span>&nbsp;<span class="var-name">$greater</span>)
121 </div>
122 <div class="method-definition">
123 <img src="../../media/images/Method.png" alt=" "/>
124 <span class="method-result">array</span>
125 <a href="#MonthDays" title="details" class="method-name">&amp;MonthDays</a>
126 (<span class="var-type">string</span>&nbsp;<span class="var-name">$dow_first</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$days_in_month</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$dayspec</span>)
127 </div>
128 <div class="method-definition">
129 <img src="../../media/images/Method.png" alt=" "/>
130 <span class="method-result">void</span>
131 <a href="#Render" title="details" class="method-name">Render</a>
132 ([<span class="var-type"></span>&nbsp;<span class="var-name">$fmt</span> = <span class="var-default">'Y-m-d H:i:s'</span>])
133 </div>
134 <div class="method-definition">
135 <img src="../../media/images/Method.png" alt=" "/>
136 <span class="method-result">void</span>
137 <a href="#RenderGMT" title="details" class="method-name">RenderGMT</a>
138 ([<span class="var-type"></span>&nbsp;<span class="var-name">$fmt</span> = <span class="var-default">'Ymd\THis\Z'</span>])
139 </div>
140 <div class="method-definition">
141 <img src="../../media/images/Method.png" alt=" "/>
142 <span class="method-result">void</span>
143 <a href="#SetEpochDate" title="details" class="method-name">SetEpochDate</a>
144 (<span class="var-type"></span>&nbsp;<span class="var-name">$input</span>)
145 </div>
146 <div class="method-definition">
147 <img src="../../media/images/Method.png" alt=" "/>
148 <span class="method-result">void</span>
149 <a href="#SetGMTDate" title="details" class="method-name">SetGMTDate</a>
150 (<span class="var-type"></span>&nbsp;<span class="var-name">$input</span>)
151 </div>
152 <div class="method-definition">
153 <img src="../../media/images/Method.png" alt=" "/>
154 <span class="method-result">void</span>
155 <a href="#SetLocalDate" title="details" class="method-name">SetLocalDate</a>
156 (<span class="var-type"></span>&nbsp;<span class="var-name">$input</span>)
157 </div>
158 <div class="method-definition">
159 <img src="../../media/images/Method.png" alt=" "/>
160 <span class="method-result">void</span>
161 <a href="#SetMonthDay" title="details" class="method-name">SetMonthDay</a>
162 (<span class="var-type"></span>&nbsp;<span class="var-name">$dd</span>)
163 </div>
164 <div class="method-definition">
165 <img src="../../media/images/Method.png" alt=" "/>
166 <span class="method-result">void</span>
167 <a href="#SetWeekStart" title="details" class="method-name">SetWeekStart</a>
168 (<span class="var-type">string</span>&nbsp;<span class="var-name">$weekstart</span>)
169 </div>
170 <div class="method-definition">
171 <img src="../../media/images/Method.png" alt=" "/>
172 <span class="method-result">boolean</span>
173 <a href="#TestByMonth" title="details" class="method-name">TestByMonth</a>
174 (<span class="var-type">string</span>&nbsp;<span class="var-name">$monthlist</span>)
175 </div>
176 <div class="method-definition">
177 <img src="../../media/images/Method.png" alt=" "/>
178 <span class="method-result">void</span>
179 <a href="#_EpochFromParts" title="details" class="method-name">_EpochFromParts</a>
180 ()
181 </div>
182 <div class="method-definition">
183 <img src="../../media/images/Method.png" alt=" "/>
184 <span class="method-result">void</span>
185 <a href="#_GMTEpochFromParts" title="details" class="method-name">_GMTEpochFromParts</a>
186 ()
187 </div>
188 <div class="method-definition">
189 <img src="../../media/images/Method.png" alt=" "/>
190 <span class="method-result">void</span>
191 <a href="#_GMTTextFromEpoch" title="details" class="method-name">_GMTTextFromEpoch</a>
192 ()
193 </div>
194 <div class="method-definition">
195 <img src="../../media/images/Method.png" alt=" "/>
196 <span class="method-result">void</span>
197 <a href="#_PartsFromText" title="details" class="method-name">_PartsFromText</a>
198 ()
199 </div>
200 <div class="method-definition">
201 <img src="../../media/images/Method.png" alt=" "/>
202 <span class="method-result">void</span>
203 <a href="#_TextFromEpoch" title="details" class="method-name">_TextFromEpoch</a>
204 ()
205 </div>
206 </div>
207 </div>
208 </div>
209
210
211 <a name="sec-methods"></a>
212 <div class="info-box">
213 <div class="info-box-title">Methods</div>
214 <div class="nav-bar">
215 <a href="#sec-description">Description</a> |
216 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
217
218 </div>
219 <div class="info-box-body">
220 <A NAME='method_detail'></A>
221 <a name="methodiCalDate" id="iCalDate"><!-- --></a>
222 <div class="oddrow">
223
224 <div class="method-header">
225 <img src="../../media/images/Constructor.png" />
226 <span class="method-title">Constructor iCalDate</span> (line <span class="line-number">50</span>)
227 </div>
228
229 <!-- ========== Info from phpDoc block ========= -->
230 <p class="short-description">The constructor takes either an iCalendar date, a text string formatted as an iCalendar date, or epoch seconds.</p>
231
232 <div class="method-signature">
233 <span class="method-result">iCalDate</span>
234 <span class="method-name">
235 iCalDate
236 </span>
237 (<span class="var-type"></span>&nbsp;<span class="var-name">$input</span>)
238 </div>
239
240 <ul class="parameters">
241 <li>
242 <span class="var-type"></span>
243 <span class="var-name">$input</span> </li>
244 </ul>
245
246
247 </div>
248 <a name="methodAddDays" id="AddDays"><!-- --></a>
249 <div class="evenrow">
250
251 <div class="method-header">
252 <img src="../../media/images/Method.png" />
253 <span class="method-title">AddDays</span> (line <span class="line-number">265</span>)
254 </div>
255
256 <!-- ========== Info from phpDoc block ========= -->
257 <p class="short-description">Add some integer number of days to a date</p>
258
259 <div class="method-signature">
260 <span class="method-result">void</span>
261 <span class="method-name">
262 AddDays
263 </span>
264 (<span class="var-type"></span>&nbsp;<span class="var-name">$dd</span>)
265 </div>
266
267 <ul class="parameters">
268 <li>
269 <span class="var-type"></span>
270 <span class="var-name">$dd</span> </li>
271 </ul>
272
273
274 </div>
275 <a name="methodAddDuration" id="AddDuration"><!-- --></a>
276 <div class="oddrow">
277
278 <div class="method-header">
279 <img src="../../media/images/Method.png" />
280 <span class="method-title">AddDuration</span> (line <span class="line-number">293</span>)
281 </div>
282
283 <!-- ========== Info from phpDoc block ========= -->
284 <p class="short-description">Add duration</p>
285
286 <div class="method-signature">
287 <span class="method-result">void</span>
288 <span class="method-name">
289 AddDuration
290 </span>
291 (<span class="var-type"></span>&nbsp;<span class="var-name">$duration</span>)
292 </div>
293
294 <ul class="parameters">
295 <li>
296 <span class="var-type"></span>
297 <span class="var-name">$duration</span> </li>
298 </ul>
299
300
301 </div>
302 <a name="methodAddMonths" id="AddMonths"><!-- --></a>
303 <div class="evenrow">
304
305 <div class="method-header">
306 <img src="../../media/images/Method.png" />
307 <span class="method-title">AddMonths</span> (line <span class="line-number">237</span>)
308 </div>
309
310 <!-- ========== Info from phpDoc block ========= -->
311 <p class="short-description">Add some number of months to a date</p>
312
313 <div class="method-signature">
314 <span class="method-result">void</span>
315 <span class="method-name">
316 AddMonths
317 </span>
318 (<span class="var-type"></span>&nbsp;<span class="var-name">$mo</span>)
319 </div>
320
321 <ul class="parameters">
322 <li>
323 <span class="var-type"></span>
324 <span class="var-name">$mo</span> </li>
325 </ul>
326
327
328 </div>
329 <a name="methodApplyBySetPos" id="ApplyBySetPos"><!-- --></a>
330 <div class="oddrow">
331
332 <div class="method-header">
333 <img src="../../media/images/Method.png" />
334 <span class="method-title">ApplyBySetPos</span> (line <span class="line-number">563</span>)
335 </div>
336
337 <!-- ========== Info from phpDoc block ========= -->
338 <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>
339 <ul class="tags">
340 <li><span class="field">return:</span> The subset which matches.</li>
341 </ul>
342
343 <div class="method-signature">
344 <span class="method-result">array</span>
345 <span class="method-name">
346 &amp;ApplyBySetPos
347 </span>
348 (<span class="var-type">string</span>&nbsp;<span class="var-name">$bysplist</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$set</span>)
349 </div>
350
351 <ul class="parameters">
352 <li>
353 <span class="var-type">string</span>
354 <span class="var-name">$bysplist</span><span class="var-description">: The list of set positions.</span> </li>
355 <li>
356 <span class="var-type">string</span>
357 <span class="var-name">$set</span><span class="var-description">: The set of days that we will apply the positions to.</span> </li>
358 </ul>
359
360
361 </div>
362 <a name="methodDateDifference" id="DateDifference"><!-- --></a>
363 <div class="evenrow">
364
365 <div class="method-header">
366 <img src="../../media/images/Method.png" />
367 <span class="method-title">DateDifference</span> (line <span class="line-number">331</span>)
368 </div>
369
370 <!-- ========== Info from phpDoc block ========= -->
371 <p class="short-description">Produce an iCalendar format DURATION for the difference between this an another iCalDate</p>
372 <ul class="tags">
373 <li><span class="field">return:</span> The date difference, as an iCalendar duration format</li>
374 </ul>
375
376 <div class="method-signature">
377 <span class="method-result">string</span>
378 <span class="method-name">
379 DateDifference
380 </span>
381 (<span class="var-type">date</span>&nbsp;<span class="var-name">$from</span>)
382 </div>
383
384 <ul class="parameters">
385 <li>
386 <span class="var-type">date</span>
387 <span class="var-name">$from</span><span class="var-description">: The start of the period</span> </li>
388 </ul>
389
390
391 </div>
392 <a name="methodDaysInMonth" id="DaysInMonth"><!-- --></a>
393 <div class="oddrow">
394
395 <div class="method-header">
396 <img src="../../media/images/Method.png" />
397 <span class="method-title">DaysInMonth</span> (line <span class="line-number">188</span>)
398 </div>
399
400 <!-- ========== Info from phpDoc block ========= -->
401 <p class="short-description">No of days in a month 1(Jan) - 12(Dec)</p>
402
403 <div class="method-signature">
404 <span class="method-result">void</span>
405 <span class="method-name">
406 DaysInMonth
407 </span>
408 ([<span class="var-type"></span>&nbsp;<span class="var-name">$mo</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$yy</span> = <span class="var-default">false</span>])
409 </div>
410
411 <ul class="parameters">
412 <li>
413 <span class="var-type"></span>
414 <span class="var-name">$mo</span> </li>
415 <li>
416 <span class="var-type"></span>
417 <span class="var-name">$yy</span> </li>
418 </ul>
419
420
421 </div>
422 <a name="methodGetMonthByDay" id="GetMonthByDay"><!-- --></a>
423 <div class="evenrow">
424
425 <div class="method-header">
426 <img src="../../media/images/Method.png" />
427 <span class="method-title">GetMonthByDay</span> (line <span class="line-number">414</span>)
428 </div>
429
430 <!-- ========== Info from phpDoc block ========= -->
431 <p class="short-description">Applies any BYDAY to the month to return a set of days</p>
432 <ul class="tags">
433 <li><span class="field">return:</span> An array of the day numbers for the month which meet the rule.</li>
434 </ul>
435
436 <div class="method-signature">
437 <span class="method-result">array</span>
438 <span class="method-name">
439 GetMonthByDay
440 </span>
441 (<span class="var-type">string</span>&nbsp;<span class="var-name">$byday</span>)
442 </div>
443
444 <ul class="parameters">
445 <li>
446 <span class="var-type">string</span>
447 <span class="var-name">$byday</span><span class="var-description">: The BYDAY rule</span> </li>
448 </ul>
449
450
451 </div>
452 <a name="methodGetMonthByMonthDay" id="GetMonthByMonthDay"><!-- --></a>
453 <div class="oddrow">
454
455 <div class="method-header">
456 <img src="../../media/images/Method.png" />
457 <span class="method-title">GetMonthByMonthDay</span> (line <span class="line-number">435</span>)
458 </div>
459
460 <!-- ========== Info from phpDoc block ========= -->
461 <p class="short-description">Applies any BYMONTHDAY to the month to return a set of days</p>
462 <ul class="tags">
463 <li><span class="field">return:</span> An array of the day numbers for the month which meet the rule.</li>
464 </ul>
465
466 <div class="method-signature">
467 <span class="method-result">array</span>
468 <span class="method-name">
469 GetMonthByMonthDay
470 </span>
471 (<span class="var-type">string</span>&nbsp;<span class="var-name">$bymonthday</span>)
472 </div>
473
474 <ul class="parameters">
475 <li>
476 <span class="var-type">string</span>
477 <span class="var-name">$bymonthday</span><span class="var-description">: The BYMONTHDAY rule</span> </li>
478 </ul>
479
480
481 </div>
482 <a name="methodGetWeekByDay" id="GetWeekByDay"><!-- --></a>
483 <div class="evenrow">
484
485 <div class="method-header">
486 <img src="../../media/images/Method.png" />
487 <span class="method-title">GetWeekByDay</span> (line <span class="line-number">455</span>)
488 </div>
489
490 <!-- ========== Info from phpDoc block ========= -->
491 <p class="short-description">Applies any BYDAY to the week to return a set of days</p>
492 <ul class="tags">
493 <li><span class="field">return:</span> An array of the day numbers for the week which meet the rule.</li>
494 </ul>
495
496 <div class="method-signature">
497 <span class="method-result">array</span>
498 <span class="method-name">
499 GetWeekByDay
500 </span>
501 (<span class="var-type">string</span>&nbsp;<span class="var-name">$byday</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$increasing</span> = <span class="var-default">false</span>])
502 </div>
503
504 <ul class="parameters">
505 <li>
506 <span class="var-type">string</span>
507 <span class="var-name">$byday</span><span class="var-description">: The BYDAY rule</span> </li>
508 <li>
509 <span class="var-type">string</span>
510 <span class="var-name">$increasing</span><span class="var-description">: When we are moving by months, we want any day of the week, but when by day we only want to increase. Default false.</span> </li>
511 </ul>
512
513
514 </div>
515 <a name="methodGreaterThan" id="GreaterThan"><!-- --></a>
516 <div class="oddrow">
517
518 <div class="method-header">
519 <img src="../../media/images/Method.png" />
520 <span class="method-title">GreaterThan</span> (line <span class="line-number">478</span>)
521 </div>
522
523 <!-- ========== Info from phpDoc block ========= -->
524 <p class="short-description">Test if $this is greater than the date parameter</p>
525 <ul class="tags">
526 <li><span class="field">return:</span> True if $this &gt; $lesser</li>
527 </ul>
528
529 <div class="method-signature">
530 <span class="method-result">boolean</span>
531 <span class="method-name">
532 GreaterThan
533 </span>
534 (<span class="var-type">string</span>&nbsp;<span class="var-name">$lesser</span>)
535 </div>
536
537 <ul class="parameters">
538 <li>
539 <span class="var-type">string</span>
540 <span class="var-name">$lesser</span><span class="var-description">: The other date, as a local time string</span> </li>
541 </ul>
542
543
544 </div>
545 <a name="methodLessThan" id="LessThan"><!-- --></a>
546 <div class="evenrow">
547
548 <div class="method-header">
549 <img src="../../media/images/Method.png" />
550 <span class="method-title">LessThan</span> (line <span class="line-number">493</span>)
551 </div>
552
553 <!-- ========== Info from phpDoc block ========= -->
554 <p class="short-description">Test if $this is less than the date parameter</p>
555 <ul class="tags">
556 <li><span class="field">return:</span> True if $this &lt; $greater</li>
557 </ul>
558
559 <div class="method-signature">
560 <span class="method-result">boolean</span>
561 <span class="method-name">
562 LessThan
563 </span>
564 (<span class="var-type">string</span>&nbsp;<span class="var-name">$greater</span>)
565 </div>
566
567 <ul class="parameters">
568 <li>
569 <span class="var-type">string</span>
570 <span class="var-name">$greater</span><span class="var-description">: The other date, as a local time string</span> </li>
571 </ul>
572
573
574 </div>
575 <a name="methodMonthDays" id="MonthDays"><!-- --></a>
576 <div class="oddrow">
577
578 <div class="method-header">
579 <img src="../../media/images/Method.png" />
580 <span class="method-title">MonthDays</span> (line <span class="line-number">512</span>)
581 </div>
582
583 <!-- ========== Info from phpDoc block ========= -->
584 <p class="short-description">Given a MonthDays string like &quot;1MO&quot;, &quot;-2WE&quot; return an integer day of the month.</p>
585 <ul class="tags">
586 <li><span class="field">return:</span> An array of the day numbers for the month which meet the rule.</li>
587 </ul>
588
589 <div class="method-signature">
590 <span class="method-result">array</span>
591 <span class="method-name">
592 &amp;MonthDays
593 </span>
594 (<span class="var-type">string</span>&nbsp;<span class="var-name">$dow_first</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$days_in_month</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$dayspec</span>)
595 </div>
596
597 <ul class="parameters">
598 <li>
599 <span class="var-type">string</span>
600 <span class="var-name">$dow_first</span><span class="var-description">: The day of week of the first of the month.</span> </li>
601 <li>
602 <span class="var-type">string</span>
603 <span class="var-name">$days_in_month</span><span class="var-description">: The number of days in the month.</span> </li>
604 <li>
605 <span class="var-type">string</span>
606 <span class="var-name">$dayspec</span><span class="var-description">: The specification for a month day (or days) which we parse.</span> </li>
607 </ul>
608
609
610 </div>
611 <a name="methodRender" id="Render"><!-- --></a>
612 <div class="evenrow">
613
614 <div class="method-header">
615 <img src="../../media/images/Method.png" />
616 <span class="method-title">Render</span> (line <span class="line-number">172</span>)
617 </div>
618
619 <!-- ========== Info from phpDoc block ========= -->
620 <p class="short-description">Set the day of week used for calculation of week starts</p>
621
622 <div class="method-signature">
623 <span class="method-result">void</span>
624 <span class="method-name">
625 Render
626 </span>
627 ([<span class="var-type"></span>&nbsp;<span class="var-name">$fmt</span> = <span class="var-default">'Y-m-d H:i:s'</span>])
628 </div>
629
630 <ul class="parameters">
631 <li>
632 <span class="var-type"></span>
633 <span class="var-name">$fmt</span> </li>
634 </ul>
635
636
637 </div>
638 <a name="methodRenderGMT" id="RenderGMT"><!-- --></a>
639 <div class="oddrow">
640
641 <div class="method-header">
642 <img src="../../media/images/Method.png" />
643 <span class="method-title">RenderGMT</span> (line <span class="line-number">180</span>)
644 </div>
645
646 <!-- ========== Info from phpDoc block ========= -->
647 <p class="short-description">Render the date as GMT</p>
648
649 <div class="method-signature">
650 <span class="method-result">void</span>
651 <span class="method-name">
652 RenderGMT
653 </span>
654 ([<span class="var-type"></span>&nbsp;<span class="var-name">$fmt</span> = <span class="var-default">'Ymd\THis\Z'</span>])
655 </div>
656
657 <ul class="parameters">
658 <li>
659 <span class="var-type"></span>
660 <span class="var-name">$fmt</span> </li>
661 </ul>
662
663
664 </div>
665 <a name="methodSetEpochDate" id="SetEpochDate"><!-- --></a>
666 <div class="evenrow">
667
668 <div class="method-header">
669 <img src="../../media/images/Method.png" />
670 <span class="method-title">SetEpochDate</span> (line <span class="line-number">104</span>)
671 </div>
672
673 <!-- ========== Info from phpDoc block ========= -->
674 <p class="short-description">Set the date from an epoch</p>
675
676 <div class="method-signature">
677 <span class="method-result">void</span>
678 <span class="method-name">
679 SetEpochDate
680 </span>
681 (<span class="var-type"></span>&nbsp;<span class="var-name">$input</span>)
682 </div>
683
684 <ul class="parameters">
685 <li>
686 <span class="var-type"></span>
687 <span class="var-name">$input</span> </li>
688 </ul>
689
690
691 </div>
692 <a name="methodSetGMTDate" id="SetGMTDate"><!-- --></a>
693 <div class="oddrow">
694
695 <div class="method-header">
696 <img src="../../media/images/Method.png" />
697 <span class="method-title">SetGMTDate</span> (line <span class="line-number">84</span>)
698 </div>
699
700 <!-- ========== Info from phpDoc block ========= -->
701 <p class="short-description">Set the date from a text string</p>
702
703 <div class="method-signature">
704 <span class="method-result">void</span>
705 <span class="method-name">
706 SetGMTDate
707 </span>
708 (<span class="var-type"></span>&nbsp;<span class="var-name">$input</span>)
709 </div>
710
711 <ul class="parameters">
712 <li>
713 <span class="var-type"></span>
714 <span class="var-name">$input</span> </li>
715 </ul>
716
717
718 </div>
719 <a name="methodSetLocalDate" id="SetLocalDate"><!-- --></a>
720 <div class="evenrow">
721
722 <div class="method-header">
723 <img src="../../media/images/Method.png" />
724 <span class="method-title">SetLocalDate</span> (line <span class="line-number">94</span>)
725 </div>
726
727 <!-- ========== Info from phpDoc block ========= -->
728 <p class="short-description">Set the date from a text string</p>
729
730 <div class="method-signature">
731 <span class="method-result">void</span>
732 <span class="method-name">
733 SetLocalDate
734 </span>
735 (<span class="var-type"></span>&nbsp;<span class="var-name">$input</span>)
736 </div>
737
738 <ul class="parameters">
739 <li>
740 <span class="var-type"></span>
741 <span class="var-name">$input</span> </li>
742 </ul>
743
744
745 </div>
746 <a name="methodSetMonthDay" id="SetMonthDay"><!-- --></a>
747 <div class="oddrow">
748
749 <div class="method-header">
750 <img src="../../media/images/Method.png" />
751 <span class="method-title">SetMonthDay</span> (line <span class="line-number">225</span>)
752 </div>
753
754 <!-- ========== Info from phpDoc block ========= -->
755 <p class="short-description">Set the day in the month to what we have been given</p>
756
757 <div class="method-signature">
758 <span class="method-result">void</span>
759 <span class="method-name">
760 SetMonthDay
761 </span>
762 (<span class="var-type"></span>&nbsp;<span class="var-name">$dd</span>)
763 </div>
764
765 <ul class="parameters">
766 <li>
767 <span class="var-type"></span>
768 <span class="var-name">$dd</span> </li>
769 </ul>
770
771
772 </div>
773 <a name="methodSetWeekStart" id="SetWeekStart"><!-- --></a>
774 <div class="evenrow">
775
776 <div class="method-header">
777 <img src="../../media/images/Method.png" />
778 <span class="method-title">SetWeekStart</span> (line <span class="line-number">163</span>)
779 </div>
780
781 <!-- ========== Info from phpDoc block ========= -->
782 <p class="short-description">Set the day of week used for calculation of week starts</p>
783
784 <div class="method-signature">
785 <span class="method-result">void</span>
786 <span class="method-name">
787 SetWeekStart
788 </span>
789 (<span class="var-type">string</span>&nbsp;<span class="var-name">$weekstart</span>)
790 </div>
791
792 <ul class="parameters">
793 <li>
794 <span class="var-type">string</span>
795 <span class="var-name">$weekstart</span><span class="var-description">: The day of the week which is the first business day.</span> </li>
796 </ul>
797
798
799 </div>
800 <a name="methodTestByMonth" id="TestByMonth"><!-- --></a>
801 <div class="oddrow">
802
803 <div class="method-header">
804 <img src="../../media/images/Method.png" />
805 <span class="method-title">TestByMonth</span> (line <span class="line-number">402</span>)
806 </div>
807
808 <!-- ========== Info from phpDoc block ========= -->
809 <p class="short-description">Test to see if our _mo matches something in the list of months we have received.</p>
810 <ul class="tags">
811 <li><span class="field">return:</span> Whether this date falls within one of those months.</li>
812 </ul>
813
814 <div class="method-signature">
815 <span class="method-result">boolean</span>
816 <span class="method-name">
817 TestByMonth
818 </span>
819 (<span class="var-type">string</span>&nbsp;<span class="var-name">$monthlist</span>)
820 </div>
821
822 <ul class="parameters">
823 <li>
824 <span class="var-type">string</span>
825 <span class="var-name">$monthlist</span><span class="var-description">: A comma-separated list of months.</span> </li>
826 </ul>
827
828
829 </div>
830 <a name="method_EpochFromParts" id="_EpochFromParts"><!-- --></a>
831 <div class="evenrow">
832
833 <div class="method-header">
834 <img src="../../media/images/Method.png" />
835 <span class="method-title">_EpochFromParts</span> (line <span class="line-number">152</span>)
836 </div>
837
838 <!-- ========== Info from phpDoc block ========= -->
839 <p class="short-description">Given a local text date, convert it to an epoch</p>
840
841 <div class="method-signature">
842 <span class="method-result">void</span>
843 <span class="method-name">
844 _EpochFromParts
845 </span>
846 ()
847 </div>
848
849
850
851 </div>
852 <a name="method_GMTEpochFromParts" id="_GMTEpochFromParts"><!-- --></a>
853 <div class="oddrow">
854
855 <div class="method-header">
856 <img src="../../media/images/Method.png" />
857 <span class="method-title">_GMTEpochFromParts</span> (line <span class="line-number">143</span>)
858 </div>
859
860 <!-- ========== Info from phpDoc block ========= -->
861 <p class="short-description">Given a GMT text date, convert it to an epoch</p>
862
863 <div class="method-signature">
864 <span class="method-result">void</span>
865 <span class="method-name">
866 _GMTEpochFromParts
867 </span>
868 ()
869 </div>
870
871
872
873 </div>
874 <a name="method_GMTTextFromEpoch" id="_GMTTextFromEpoch"><!-- --></a>
875 <div class="evenrow">
876
877 <div class="method-header">
878 <img src="../../media/images/Method.png" />
879 <span class="method-title">_GMTTextFromEpoch</span> (line <span class="line-number">122</span>)
880 </div>
881
882 <!-- ========== Info from phpDoc block ========= -->
883 <p class="short-description">Given a GMT epoch date, convert it to text</p>
884
885 <div class="method-signature">
886 <span class="method-result">void</span>
887 <span class="method-name">
888 _GMTTextFromEpoch
889 </span>
890 ()
891 </div>
892
893
894
895 </div>
896 <a name="method_PartsFromText" id="_PartsFromText"><!-- --></a>
897 <div class="oddrow">
898
899 <div class="method-header">
900 <img src="../../media/images/Method.png" />
901 <span class="method-title">_PartsFromText</span> (line <span class="line-number">130</span>)
902 </div>
903
904 <!-- ========== Info from phpDoc block ========= -->
905 <p class="short-description">Given a text date, convert it to parts</p>
906
907 <div class="method-signature">
908 <span class="method-result">void</span>
909 <span class="method-name">
910 _PartsFromText
911 </span>
912 ()
913 </div>
914
915
916
917 </div>
918 <a name="method_TextFromEpoch" id="_TextFromEpoch"><!-- --></a>
919 <div class="evenrow">
920
921 <div class="method-header">
922 <img src="../../media/images/Method.png" />
923 <span class="method-title">_TextFromEpoch</span> (line <span class="line-number">114</span>)
924 </div>
925
926 <!-- ========== Info from phpDoc block ========= -->
927 <p class="short-description">Given an epoch date, convert it to text</p>
928
929 <div class="method-signature">
930 <span class="method-result">void</span>
931 <span class="method-name">
932 _TextFromEpoch
933 </span>
934 ()
935 </div>
936
937
938
939 </div>
940
941 </div>
942 </div>
943
944
945 <p class="notes" id="credit">
946 Documentation generated on Tue, 27 Sep 2011 11:30:48 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
947 </p>
948 </div></body>
949 </html>
DAViCal CalDAV & CardDAV Server