Release 0.49
[awl.git] / docs / api / awl / iCalendar / _iCalendar.php.html
blob67db774a53d174b7eea8fe5dd04c2fbe4300c460
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";
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;
33 oImg.src = imgMinus.src;
34 oTable.style.display = "block";
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;
55 oImg.src = imgPlus.src;
56 oTable.style.display = "none";
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;
74 return (oTable && oTable.style.display == "block");
77 function toggleNodeVisibility(Node){
78 if (nodeIsVisible(Node)){
79 hideNode(Node);
80 }else{
81 showNode(Node);
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>
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 </div>
98 <div class="info-box-body">
99 <!-- ========== Info from phpDoc block ========= -->
100 <p class="short-description">A Class for handling iCalendar data.</p>
101 <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>
102 <ul class="tags">
103 <li><span class="field">author:</span> Andrew McMillan &lt;<a href="mailto:andrew@mcmillan.net.nz">andrew@mcmillan.net.nz</a>&gt;</li>
104 <li><span class="field">copyright:</span> Catalyst IT Ltd, Morphoss Ltd &lt;http://www.morphoss.com/&gt;</li>
105 <li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2 or later</a></li>
106 <li><span class="field">example:</span> example not found</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 </ul>
114 </div>
115 </div>
117 <a name="sec-classes"></a>
118 <div class="info-box">
119 <div class="info-box-title">Classes</div>
120 <div class="nav-bar">
121 <a href="#sec-description">Description</a> |
122 <span class="disabled">Classes</span>
123 | <a href="#sec-includes">Includes</a>
124 </div>
125 <div class="info-box-body">
126 <table cellpadding="2" cellspacing="0" class="class-table">
127 <tr>
128 <th class="class-table-header">Class</th>
129 <th class="class-table-header">Description</th>
130 </tr>
131 <tr>
132 <td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
133 <img src="../../media/images/Class.png"
134 alt=" class"
135 title=" class"/>
136 <a href="../../awl/iCalendar/iCalProp.html">iCalProp</a>
137 </td>
138 <td>
139 A Class for representing properties within an iCalendar
140 </td>
141 </tr>
142 <tr>
143 <td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
144 <img src="../../media/images/Class.png"
145 alt=" class"
146 title=" class"/>
147 <a href="../../awl/iCalendar/iCalComponent.html">iCalComponent</a>
148 </td>
149 <td>
150 A Class for representing components within an iCalendar
151 </td>
152 </tr>
153 <tr>
154 <td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
155 <img src="../../media/images/Class.png"
156 alt=" class"
157 title=" class"/>
158 <a href="../../awl/iCalendar/iCalendar.html">iCalendar</a>
159 </td>
160 <td>
161 A Class for handling Events on a calendar (DEPRECATED)
162 </td>
163 </tr>
164 </table>
165 </div>
166 </div>
168 <a name="sec-includes"></a>
169 <div class="info-box">
170 <div class="info-box-title">Includes</div>
171 <div class="nav-bar">
172 <a href="#sec-description">Description</a> |
173 <a href="#sec-classes">Classes</a>
174 | <span class="disabled">Includes</span>
175 </div>
176 <div class="info-box-body">
177 <a name="_XMLElement_php"><!-- --></a>
178 <div class="oddrow">
180 <div>
181 <img src="../../media/images/Page.png" alt=" " />
182 <span class="include-title">
183 <span class="include-type">require_once</span>
184 (<span class="include-name"><a href="../../awl/XMLElement/_XMLElement.php.html">'XMLElement.php'</a></span>)
185 (line <span class="line-number">49</span>)
186 </span>
187 </div>
189 <!-- ========== Info from phpDoc block ========= -->
191 </div>
192 <a name="_AwlQuery_php"><!-- --></a>
193 <div class="evenrow">
195 <div>
196 <img src="../../media/images/Page.png" alt=" " />
197 <span class="include-title">
198 <span class="include-type">require_once</span>
199 (<span class="include-name"><a href="../../awl/AwlDatabase/_AwlQuery.php.html">'AwlQuery.php'</a></span>)
200 (line <span class="line-number">50</span>)
201 </span>
202 </div>
204 <!-- ========== Info from phpDoc block ========= -->
206 </div>
207 </div>
208 </div>
213 <p class="notes" id="credit">
214 Documentation generated on Mon, 24 Oct 2011 20:10:13 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
215 </p>
216 </div></body>
217 </html>