docs/api/awl/iCalendar/_iCalendar.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 iCalendar.php</title>
   7                         <link rel="stylesheet" href="../../media/stylesheet.css" />
   8                                                 <script src="../../media/lib/classTree.js"></script>
   9                                                                                                 <script language="javascript" type="text/javascript">
  10                                 var imgPlus = new Image();
  11                                 var imgMinus = new Image();
  12                                 imgPlus.src = "../../media/images/plus.png";
  13                                 imgMinus.src = "../../media/images/minus.png";
  14
  15                                 function showNode(Node){
  16                                                         switch(navigator.family){
  17                                                                 case 'nn4':
  18                                                                         // Nav 4.x code fork...
  19                                                         var oTable = document.layers["span" + Node];
  20                                                         var oImg = document.layers["img" + Node];
  21                                                                         break;
  22                                                                 case 'ie4':
  23                                                                         // IE 4/5 code fork...
  24                                                         var oTable = document.all["span" + Node];
  25                                                         var oImg = document.all["img" + Node];
  26                                                                         break;
  27                                                                 case 'gecko':
  28                                                                         // Standards Compliant code fork...
  29                                                         var oTable = document.getElementById("span" + Node);
  30                                                         var oImg = document.getElementById("img" + Node);
  31                                                                         break;
  32                                                         }
  33                                         oImg.src = imgMinus.src;
  34                                         oTable.style.display = "block";
  35                                 }
  36
  37                                 function hideNode(Node){
  38                                                         switch(navigator.family){
  39                                                                 case 'nn4':
  40                                                                         // Nav 4.x code fork...
  41                                                         var oTable = document.layers["span" + Node];
  42                                                         var oImg = document.layers["img" + Node];
  43                                                                         break;
  44                                                                 case 'ie4':
  45                                                                         // IE 4/5 code fork...
  46                                                         var oTable = document.all["span" + Node];
  47                                                         var oImg = document.all["img" + Node];
  48                                                                         break;
  49                                                                 case 'gecko':
  50                                                                         // Standards Compliant code fork...
  51                                                         var oTable = document.getElementById("span" + Node);
  52                                                         var oImg = document.getElementById("img" + Node);
  53                                                                         break;
  54                                                         }
  55                                         oImg.src = imgPlus.src;
  56                                         oTable.style.display = "none";
  57                                 }
  58
  59                                 function nodeIsVisible(Node){
  60                                                         switch(navigator.family){
  61                                                                 case 'nn4':
  62                                                                         // Nav 4.x code fork...
  63                                                         var oTable = document.layers["span" + Node];
  64                                                                         break;
  65                                                                 case 'ie4':
  66                                                                         // IE 4/5 code fork...
  67                                                         var oTable = document.all["span" + Node];
  68                                                                         break;
  69                                                                 case 'gecko':
  70                                                                         // Standards Compliant code fork...
  71                                                         var oTable = document.getElementById("span" + Node);
  72                                                                         break;
  73                                                         }
  74                                         return (oTable && oTable.style.display == "block");
  75                                 }
  76
  77                                 function toggleNodeVisibility(Node){
  78                                         if (nodeIsVisible(Node)){
  79                                                 hideNode(Node);
  80                                         }else{
  81                                                 showNode(Node);
  82                                         }
  83                                 }
  84                         </script>
  85                                         </head>
  86                 <body>
  87                         <div class="page-body">
  88 <h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/iCalendar.php</h2>
  89
  90 <a name="sec-description"></a>
  91 <div class="info-box">
  92         <div class="info-box-title">Description</div>
  93         <div class="nav-bar">
  94                                         <span class="disabled">Description</span> |
  95                                                         <a href="#sec-classes">Classes</a>
  96                         |                                                       <a href="#sec-includes">Includes</a>
  97                         |                                                                                       <a href="#sec-functions">Functions</a>
  98                         </div>
  99         <div class="info-box-body">
 100                 <!-- ========== Info from phpDoc block ========= -->
 101 <p class="short-description">A Class for handling iCalendar data.</p>
 102 <p class="description"><p>When parsed the underlying structure is roughly as follows:</p><p>iCalendar( array(iCalComponent), array(iCalProp) )</p><p>each iCalComponent is similarly structured:</p><p>iCalComponent( array(iCalComponent), array(iCalProp) )</p><p>Once parsed, $ical-&gt;component will point to the wrapping VCALENDAR component of  the iCalendar.  This will be fine for simple iCalendar usage as sampled below,  but more complex iCalendar such as a VEVENT with RRULE which has repeat overrides  will need quite a bit more thought to process correctly.</p></p>
 103         <ul class="tags">
 104                                 <li><span class="field">author:</span> Andrew McMillan &lt;<a href="mailto:andrew@mcmillan.net.nz">andrew@mcmillan.net.nz</a>&gt;</li>
 105                                 <li><span class="field">copyright:</span> Catalyst IT Ltd, Morphoss Ltd &lt;http://www.morphoss.com/&gt;</li>
 106                                 <li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2 or later</a></li>
 107                                 <li><span class="field">example:</span> example not found</li>
 108                                 <li><span class="field">example:</span> example not found</li>
 109                                 <li><span class="field">example:</span> example not found</li>
 110                                 <li><span class="field">example:</span> example not found</li>
 111                                 <li><span class="field">example:</span> example not found</li>
 112                                 <li><span class="field">example:</span> example not found</li>
 113                         </ul>
 114
 115                         </div>
 116 </div>
 117
 118         <a name="sec-classes"></a>
 119         <div class="info-box">
 120                 <div class="info-box-title">Classes</div>
 121                 <div class="nav-bar">
 122                         <a href="#sec-description">Description</a> |
 123                         <span class="disabled">Classes</span>
 124                         |                                                       <a href="#sec-includes">Includes</a>
 125                                 |                                                                                                                               <a href="#sec-functions">Functions</a>
 126                                         </div>
 127                 <div class="info-box-body">
 128                         <table cellpadding="2" cellspacing="0" class="class-table">
 129                                 <tr>
 130                                         <th class="class-table-header">Class</th>
 131                                         <th class="class-table-header">Description</th>
 132                                 </tr>
 133                                                                 <tr>
 134                                         <td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
 135                                                 <img src="../../media/images/Class.png"
 136                                                                  alt=" class"
 137                                                                  title=" class"/>
 138                                                 <a href="../../awl/iCalendar/iCalProp.html">iCalProp</a>
 139                                         </td>
 140                                         <td>
 141                                                                                         A Class for representing properties within an iCalendar
 142                                                                                 </td>
 143                                 </tr>
 144                                                                 <tr>
 145                                         <td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
 146                                                 <img src="../../media/images/Class.png"
 147                                                                  alt=" class"
 148                                                                  title=" class"/>
 149                                                 <a href="../../awl/iCalendar/iCalComponent.html">iCalComponent</a>
 150                                         </td>
 151                                         <td>
 152                                                                                         A Class for representing components within an iCalendar
 153                                                                                 </td>
 154                                 </tr>
 155                                                                 <tr>
 156                                         <td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
 157                                                 <img src="../../media/images/Class.png"
 158                                                                  alt=" class"
 159                                                                  title=" class"/>
 160                                                 <a href="../../awl/iCalendar/iCalendar.html">iCalendar</a>
 161                                         </td>
 162                                         <td>
 163                                                                                         A Class for handling Events on a calendar (DEPRECATED)
 164                                                                                 </td>
 165                                 </tr>
 166                                                         </table>
 167                 </div>
 168         </div>
 169
 170         <a name="sec-includes"></a>
 171         <div class="info-box">
 172                 <div class="info-box-title">Includes</div>
 173                 <div class="nav-bar">
 174                         <a href="#sec-description">Description</a> |
 175                                                         <a href="#sec-classes">Classes</a>
 176                                 |                                               <span class="disabled">Includes</span>
 177                         |                                                                                                       <a href="#sec-functions">Functions</a>
 178                                         </div>
 179                 <div class="info-box-body">
 180                         <a name="_XMLElement_php"><!-- --></a>
 181 <div class="evenrow">
 182
 183         <div>
 184                 <img src="../../media/images/Page.png" alt=" " />
 185                 <span class="include-title">
 186                         <span class="include-type">require_once</span>
 187                         (<span class="include-name"><a href="../../awl/XMLElement/_XMLElement.php.html">'XMLElement.php'</a></span>)
 188                         (line <span class="line-number">49</span>)
 189                 </span>
 190         </div>
 191
 192         <!-- ========== Info from phpDoc block ========= -->
 193
 194 </div>
 195 <a name="_AwlQuery_php"><!-- --></a>
 196 <div class="oddrow">
 197
 198         <div>
 199                 <img src="../../media/images/Page.png" alt=" " />
 200                 <span class="include-title">
 201                         <span class="include-type">require_once</span>
 202                         (<span class="include-name"><a href="../../awl/AwlDatabase/_AwlQuery.php.html">'AwlQuery.php'</a></span>)
 203                         (line <span class="line-number">50</span>)
 204                 </span>
 205         </div>
 206
 207         <!-- ========== Info from phpDoc block ========= -->
 208
 209 </div>
 210                 </div>
 211         </div>
 212
 213
 214
 215         <a name="sec-functions"></a>
 216         <div class="info-box">
 217                 <div class="info-box-title">Functions</div>
 218                 <div class="nav-bar">
 219                         <a href="#sec-description">Description</a> |
 220                                                         <a href="#sec-classes">Classes</a>
 221                                 |                                                                               <a href="#sec-includes">Includes</a>
 222                                 |                                                                                               <span class="disabled">Functions</span>
 223                 </div>
 224                 <div class="info-box-body">
 225                         <a name="functiondeprecated" id="functiondeprecated"><!-- --></a>
 226 <div class="evenrow">
 227
 228         <div>
 229                 <img src="../../media/images/Function.png" />
 230                 <span class="method-title">deprecated</span> (line <span class="line-number">891</span>)
 231         </div>
 232
 233         <!-- ========== Info from phpDoc block ========= -->
 234 <p class="short-description">***********************************************************************************  Everything below here is deprecated and should be avoided in favour  of using, improving and enhancing the more sensible structures above.</p>
 235 <p class="description"><p>***********************************************************************************</p></p>
 236         <div class="method-signature">
 237                 <span class="method-result">void</span>
 238                 <span class="method-name">
 239                         deprecated
 240                 </span>
 241                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$method</span>)
 242                         </div>
 243
 244                         <ul class="parameters">
 245                                         <li>
 246                                 <span class="var-type"></span>
 247                                 <span class="var-name">$method</span>                   </li>
 248                                 </ul>
 249
 250
 251 </div>
 252                 </div>
 253         </div>
 254
 255         <p class="notes" id="credit">
 256                 Documentation generated on Tue, 28 Dec 2010 02:01:36 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
 257         </p>
 258         </div></body>
 259 </html>