docs/api/awl/caldav/Rfc5545Duration.html

   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 Rfc5545Duration</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"> Rfc5545Duration</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">Provide a useful way of dealing with RFC5545 duration strings of the form</p>
  28 <p class="description"><p>^-?P(\dW)|((\dD)?(T(\dH)?(\dM)?(\dS)?)?)$</p></p>
  29                 <p class="notes">
  30                         Located in <a class="field" href="_inc---RRule-v2.php.html">/inc/RRule-v2.php</a> (line <span class="field">77</span>)
  31                 </p>
  32
  33
  34                 <pre></pre>
  35
  36                         </div>
  37 </div>
  38
  39
  40
  41
  42         <a name="sec-method-summary"></a>
  43         <div class="info-box">
  44                 <div class="info-box-title">Method Summary</span></div>
  45                 <div class="nav-bar">
  46                         <a href="#sec-description">Description</a> |
  47                                                                                                 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  48                 </div>
  49                 <div class="info-box-body">
  50                         <div class="method-summary">
  51                                                                                                                                                                                                                                                                                                 <div class="method-definition">
  52                                         <img src="../../media/images/StaticMethod.png" alt=" "/>
  53                                                                                         static <span class="method-result"><a href="../../awl/caldav/Rfc5545Duration.html">Rfc5545Duration</a></span>
  54                                                                                 <a href="#fromTwoDates" title="details" class="method-name">fromTwoDates</a>
  55                                                                                         (<span class="var-type"><a href="../../awl/caldav/RepeatRuleDateTime.html">RepeatRuleDateTime</a></span>&nbsp;<span class="var-name">$d1</span>, <span class="var-type"><a href="../../awl/caldav/RepeatRuleDateTime.html">RepeatRuleDateTime</a></span>&nbsp;<span class="var-name">$d2</span>)
  56                                                                         </div>
  57                                                                                                                                                                                                                                 <div class="method-definition">
  58                                         <img src="../../media/images/Constructor.png" alt=" "/>
  59                                                                                         <span class="method-result">Rfc5545Duration</span>
  60                                                                                 <a href="#__construct" title="details" class="method-name">__construct</a>
  61                                                                                         (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_duration</span>)
  62                                                                         </div>
  63                                                                                                                                 <div class="method-definition">
  64                                         <img src="../../media/images/Method.png" alt=" "/>
  65                                                                                         <span class="method-result">void</span>
  66                                                                                 <a href="#asSeconds" title="details" class="method-name">asSeconds</a>
  67                                                                                 ()
  68                                                                         </div>
  69                                                                                                                                 <div class="method-definition">
  70                                         <img src="../../media/images/Method.png" alt=" "/>
  71                                                                                         <span class="method-result">boolean</span>
  72                                                                                 <a href="#equals" title="details" class="method-name">equals</a>
  73                                                                                         (<span class="var-type"><a href="../../awl/caldav/Rfc5545Duration.html">Rfc5545Duration</a></span>&nbsp;<span class="var-name">$other</span>)
  74                                                                         </div>
  75                                                                                                                                                                                                 <div class="method-definition">
  76                                         <img src="../../media/images/Method.png" alt=" "/>
  77                                                                                         <span class="method-result">string</span>
  78                                                                                 <a href="#__toString" title="details" class="method-name">__toString</a>
  79                                                                                 ()
  80                                                                         </div>
  81                                                                                         </div>
  82                 </div>
  83         </div>
  84
  85
  86         <a name="sec-methods"></a>
  87         <div class="info-box">
  88                 <div class="info-box-title">Methods</div>
  89                 <div class="nav-bar">
  90                         <a href="#sec-description">Description</a> |
  91                                                                                                         <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  92
  93                 </div>
  94                 <div class="info-box-body">
  95                         <A NAME='method_detail'></A>
  96 <a name="methodfromTwoDates" id="fromTwoDates"><!-- --></a>
  97 <div class="oddrow">
  98
  99         <div class="method-header">
 100                 <img src="../../media/images/StaticMethod.png" />
 101                 <span class="method-title">static fromTwoDates</span> (line <span class="line-number">192</span>)
 102         </div>
 103
 104         <!-- ========== Info from phpDoc block ========= -->
 105 <p class="short-description">Factory method to return an Rfc5545Duration object from the difference  between two dates.</p>
 106 <p class="description"><p>This is flawed, at present: we should really localise both dates and work  out the difference in days, then localise the times and work out the difference  between the clock times.  On the other hand we're replacing a quick and dirty  hack that did it exactly the same way in the past, so we're not making things  any *worse* and at least we're making it clear that it could be improved...</p><p>The problem strikes (as they all do) across DST boundaries.</p></p>
 107         <ul class="tags">
 108                                 <li><span class="field">todo:</span> Improve this to calculate the days difference and then the clock time diff  and work from there.</li>
 109                         </ul>
 110
 111         <div class="method-signature">
 112                 <span class="method-result"><a href="../../awl/caldav/Rfc5545Duration.html">Rfc5545Duration</a></span>
 113                 <span class="method-name">
 114                         fromTwoDates
 115                 </span>
 116                                         (<span class="var-type"><a href="../../awl/caldav/RepeatRuleDateTime.html">RepeatRuleDateTime</a></span>&nbsp;<span class="var-name">$d1</span>, <span class="var-type"><a href="../../awl/caldav/RepeatRuleDateTime.html">RepeatRuleDateTime</a></span>&nbsp;<span class="var-name">$d2</span>)
 117                         </div>
 118
 119                         <ul class="parameters">
 120                                         <li>
 121                                 <span class="var-type"><a href="../../awl/caldav/RepeatRuleDateTime.html">RepeatRuleDateTime</a></span>
 122                                 <span class="var-name">$d1</span>                       </li>
 123                                         <li>
 124                                 <span class="var-type"><a href="../../awl/caldav/RepeatRuleDateTime.html">RepeatRuleDateTime</a></span>
 125                                 <span class="var-name">$d2</span>                       </li>
 126                                 </ul>
 127
 128
 129         </div>
 130 <a name="method__construct" id="__construct"><!-- --></a>
 131 <div class="evenrow">
 132
 133         <div class="method-header">
 134                 <img src="../../media/images/Constructor.png" />
 135                 <span class="method-title">Constructor __construct</span> (line <span class="line-number">87</span>)
 136         </div>
 137
 138         <!-- ========== Info from phpDoc block ========= -->
 139 <p class="short-description">Construct a new Rfc5545Duration either from incoming seconds or a text string.</p>
 140
 141         <div class="method-signature">
 142                 <span class="method-result">Rfc5545Duration</span>
 143                 <span class="method-name">
 144                         __construct
 145                 </span>
 146                                         (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$in_duration</span>)
 147                         </div>
 148
 149                         <ul class="parameters">
 150                                         <li>
 151                                 <span class="var-type">mixed</span>
 152                                 <span class="var-name">$in_duration</span>                      </li>
 153                                 </ul>
 154
 155
 156         </div>
 157 <a name="methodasSeconds" id="asSeconds"><!-- --></a>
 158 <div class="oddrow">
 159
 160         <div class="method-header">
 161                 <img src="../../media/images/Method.png" />
 162                 <span class="method-title">asSeconds</span> (line <span class="line-number">116</span>)
 163         </div>
 164
 165         <!-- ========== Info from phpDoc block ========= -->
 166 <p class="short-description">Returns the duration as epoch seconds.</p>
 167
 168         <div class="method-signature">
 169                 <span class="method-result">void</span>
 170                 <span class="method-name">
 171                         asSeconds
 172                 </span>
 173                                 ()
 174                         </div>
 175
 176
 177
 178         </div>
 179 <a name="methodequals" id="equals"><!-- --></a>
 180 <div class="evenrow">
 181
 182         <div class="method-header">
 183                 <img src="../../media/images/Method.png" />
 184                 <span class="method-title">equals</span> (line <span class="line-number">107</span>)
 185         </div>
 186
 187         <!-- ========== Info from phpDoc block ========= -->
 188 <p class="short-description">Return true if $this and $other are equal, false otherwise.</p>
 189
 190         <div class="method-signature">
 191                 <span class="method-result">boolean</span>
 192                 <span class="method-name">
 193                         equals
 194                 </span>
 195                                         (<span class="var-type"><a href="../../awl/caldav/Rfc5545Duration.html">Rfc5545Duration</a></span>&nbsp;<span class="var-name">$other</span>)
 196                         </div>
 197
 198                         <ul class="parameters">
 199                                         <li>
 200                                 <span class="var-type"><a href="../../awl/caldav/Rfc5545Duration.html">Rfc5545Duration</a></span>
 201                                 <span class="var-name">$other</span>                    </li>
 202                                 </ul>
 203
 204
 205         </div>
 206 <a name="method__toString" id="__toString"><!-- --></a>
 207 <div class="oddrow">
 208
 209         <div class="method-header">
 210                 <img src="../../media/images/Method.png" />
 211                 <span class="method-title">__toString</span> (line <span class="line-number">145</span>)
 212         </div>
 213
 214         <!-- ========== Info from phpDoc block ========= -->
 215 <p class="short-description">Returns the duration as a text string of the form ^(-?)P(\d+W)|((\d+D)?(T(\d+H)?(\d+M)?(\d+S)?)?)$</p>
 216         <ul class="tags">
 217                                 <li><span class="field">return:</span> The stringified stuff.</li>
 218                         </ul>
 219
 220         <div class="method-signature">
 221                 <span class="method-result">string</span>
 222                 <span class="method-name">
 223                         __toString
 224                 </span>
 225                                 ()
 226                         </div>
 227
 228
 229
 230         </div>
 231
 232                 </div>
 233         </div>
 234
 235
 236         <p class="notes" id="credit">
 237                 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>
 238         </p>
 239         </div></body>
 240 </html>