docs/api/davical/tzservice/_inc---tz---expand.php.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 page expand.php</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="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/tz/expand.php</h2>
  13
  14 <a name="sec-description"></a>
  15 <div class="info-box">
  16         <div class="info-box-title">Description</div>
  17         <div class="nav-bar">
  18                                         <span class="disabled">Description</span> |
  19                                                                         <a href="#sec-includes">Includes</a>
  20                         |                                                       <a href="#sec-constants">Constants</a>
  21                         |                                                                       <a href="#sec-functions">Functions</a>
  22                         </div>
  23         <div class="info-box-body">
  24                 <!-- ========== Info from phpDoc block ========= -->
  25 <p class="short-description">DAViCal Timezone Service handler - capabilitis</p>
  26         <ul class="tags">
  27                                 <li><span class="field">author:</span> Andrew McMillan &lt;<a href="mailto:andrew@morphoss.com">andrew@morphoss.com</a>&gt;</li>
  28                                 <li><span class="field">copyright:</span> Morphoss Ltd</li>
  29                                 <li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v3 or later</a></li>
  30                         </ul>
  31
  32                         </div>
  33 </div>
  34
  35
  36         <a name="sec-includes"></a>
  37         <div class="info-box">
  38                 <div class="info-box-title">Includes</div>
  39                 <div class="nav-bar">
  40                         <a href="#sec-description">Description</a> |
  41                                                 <span class="disabled">Includes</span>
  42                         |                                                       <a href="#sec-constants">Constants</a>
  43                                 |                                                                                                       <a href="#sec-functions">Functions</a>
  44                                         </div>
  45                 <div class="info-box-body">
  46                         <a name="_vCalendar_php"><!-- --></a>
  47 <div class="oddrow">
  48
  49         <div>
  50                 <img src="../../media/images/Page.png" alt=" " />
  51                 <span class="include-title">
  52                         <span class="include-type">require_once</span>
  53                         (<span class="include-name">'vCalendar.php'</span>)
  54                         (line <span class="line-number">12</span>)
  55                 </span>
  56         </div>
  57
  58         <!-- ========== Info from phpDoc block ========= -->
  59 <p class="short-description">DAViCal Timezone Service handler - capabilitis</p>
  60         <ul class="tags">
  61                                 <li><span class="field">author:</span> Andrew McMillan &lt;<a href="mailto:andrew@morphoss.com">andrew@morphoss.com</a>&gt;</li>
  62                                 <li><span class="field">copyright:</span> Morphoss Ltd</li>
  63                                 <li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v3 or later</a></li>
  64                         </ul>
  65
  66 </div>
  67 <a name="_RRule-v2_php"><!-- --></a>
  68 <div class="evenrow">
  69
  70         <div>
  71                 <img src="../../media/images/Page.png" alt=" " />
  72                 <span class="include-title">
  73                         <span class="include-type">require_once</span>
  74                         (<span class="include-name"><a href="../../awl/caldav/_inc---RRule-v2.php.html">RRule-v2.php</a></span>)
  75                         (line <span class="line-number">13</span>)
  76                 </span>
  77         </div>
  78
  79         <!-- ========== Info from phpDoc block ========= -->
  80
  81 </div>
  82                 </div>
  83         </div>
  84
  85         <a name="sec-constants"></a>
  86         <div class="info-box">
  87                 <div class="info-box-title">Constants</div>
  88                 <div class="nav-bar">
  89                         <a href="#sec-description">Description</a> |
  90                                                                                 <a href="#sec-includes">Includes</a>
  91                                 |                                               <span class="disabled">Constants</span>
  92                         |                                                                               <a href="#sec-functions">Functions</a>
  93                                         </div>
  94                 <div class="info-box-body">
  95                         <a name="defineDEBUG_EXPAND"><!-- --></a>
  96 <div class="oddrow">
  97
  98         <div>
  99                 <img src="../../media/images/Constant.png" />
 100                 <span class="const-title">
 101                         <span class="const-name">DEBUG_EXPAND</span> = false
 102                         (line <span class="line-number">40</span>)
 103                 </span>
 104         </div>
 105
 106         <!-- ========== Info from phpDoc block ========= -->
 107
 108
 109 </div>
 110                 </div>
 111         </div>
 112
 113
 114         <a name="sec-functions"></a>
 115         <div class="info-box">
 116                 <div class="info-box-title">Functions</div>
 117                 <div class="nav-bar">
 118                         <a href="#sec-description">Description</a> |
 119                                                                                 <a href="#sec-includes">Includes</a>
 120                                 |                                                                               <a href="#sec-constants">Constants</a>
 121                                 |                                                                       <span class="disabled">Functions</span>
 122                 </div>
 123                 <div class="info-box-body">
 124                         <a name="functionexpand_timezone_onsets" id="functionexpand_timezone_onsets"><!-- --></a>
 125 <div class="evenrow">
 126
 127         <div>
 128                 <img src="../../media/images/Function.png" />
 129                 <span class="method-title">expand_timezone_onsets</span> (line <span class="line-number">53</span>)
 130         </div>
 131
 132         <!-- ========== Info from phpDoc block ========= -->
 133 <p class="short-description">Expand the instances for a STANDARD or DAYLIGHT component of a VTIMEZONE</p>
 134         <ul class="tags">
 135                                 <li><span class="field">return:</span> of onset datetimes with UTC from/to offsets</li>
 136                         </ul>
 137         <div class="method-signature">
 138                 <span class="method-result">array</span>
 139                 <span class="method-name">
 140                         expand_timezone_onsets
 141                 </span>
 142                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$vResource</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$range_start</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$range_end</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$offset_from</span>)
 143                         </div>
 144
 145                         <ul class="parameters">
 146                                         <li>
 147                                 <span class="var-type">object</span>
 148                                 <span class="var-name">$vResource</span><span class="var-description">: is a VCALENDAR with a VTIMEZONE containing components needing expansion</span>                  </li>
 149                                         <li>
 150                                 <span class="var-type">object</span>
 151                                 <span class="var-name">$range_start</span><span class="var-description">: A RepeatRuleDateTime which is the beginning of the range for events.</span>                   </li>
 152                                         <li>
 153                                 <span class="var-type">object</span>
 154                                 <span class="var-name">$range_end</span><span class="var-description">: A RepeatRuleDateTime which is the end of the range for events.</span>                   </li>
 155                                         <li>
 156                                 <span class="var-type">int</span>
 157                                 <span class="var-name">$offset_from</span><span class="var-description">: The offset from UTC in seconds at the onset time.</span>                      </li>
 158                                 </ul>
 159
 160
 161 </div>
 162                 </div>
 163         </div>
 164
 165         <p class="notes" id="credit">
 166                 Documentation generated on Fri, 13 Jan 2012 23:44:55 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
 167         </p>
 168         </div></body>
 169 </html>