|
1
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">
|
|
2
|
<html>
|
|
3
|
<head>
|
|
4
|
<title>iCalcreator 2.22 summary</title>
|
|
5
|
<meta http-equiv="Content-Type" content="text/html;charset=utf-8">
|
|
6
|
<meta name="author" content="Kjell-Inge Gustafsson, kigkonsult, All rights reserved">
|
|
7
|
<meta name="copyright" content="2007-2015 Kjell-Inge Gustafsson, kigkonsult">
|
|
8
|
<meta name="keywords" content="ical, calendar, calender, xcal, xml, icalender, rfc2445, rfc5545, vcalender, php, create">
|
|
9
|
<meta name="description" content="iCalcreator summary" />
|
|
10
|
<style type="text/css">
|
|
11
|
body {
|
|
12
|
FONT-FAMILY : "Lucida Grande","Lucida Sans Unicode", "Bitstream Vera Sans", Lucida, Arial, Geneva, Helvetica, sans-serif;
|
|
13
|
FONT-SIZE : small;
|
|
14
|
MARGIN : 10px;
|
|
15
|
WIDTH : 800px;
|
|
16
|
}
|
|
17
|
h1 {
|
|
18
|
FONT-SIZE : large;
|
|
19
|
FONT-WEIGHT : bold;
|
|
20
|
}
|
|
21
|
h2 {
|
|
22
|
FONT-SIZE : large;
|
|
23
|
}
|
|
24
|
h3 {
|
|
25
|
FONT-SIZE : medium;
|
|
26
|
}
|
|
27
|
h4 {
|
|
28
|
FONT-SIZE : small;
|
|
29
|
FONT-WEIGHT : bold;
|
|
30
|
}
|
|
31
|
h5 {
|
|
32
|
FONT-SIZE : small;
|
|
33
|
FONT-WEIGHT : normal;
|
|
34
|
TEXT-DECORATION : underline;
|
|
35
|
}
|
|
36
|
pre {
|
|
37
|
BACKGROUND-COLOR: #DCDCDC;
|
|
38
|
FONT-FAMILY : monospace;
|
|
39
|
FONT-SIZE : medium;
|
|
40
|
LETTER-SPACING : 0.1em;
|
|
41
|
LINE-HEIGHT : 1.5em;
|
|
42
|
WHITE-SPACE : pre-wrap;
|
|
43
|
WHITE-SPACE : -moz-pre-wrap;
|
|
44
|
WHITE-SPACE : -pre-wrap;
|
|
45
|
WHITE-SPACE : -o-pre-wrap;
|
|
46
|
WORD-WRAP : break-word;
|
|
47
|
}
|
|
48
|
.comment {
|
|
49
|
FONT-FAMILY : arial;
|
|
50
|
FONT-SIZE : small;
|
|
51
|
FONT-STYLE : italic;
|
|
52
|
}
|
|
53
|
</style>
|
|
54
|
</head>
|
|
55
|
<body>
|
|
56
|
|
|
57
|
<h1>iCalcreator v2.22</h1>
|
|
58
|
<p>
|
|
59
|
iCalcreator v2.22<br>
|
|
60
|
Copyright (c) 2007-2015 Kjell-Inge Gustafsson, kigkonsult, All rights reserved.<br>
|
|
61
|
<a href="http://kigkonsult.se/iCalcreator/index.php" title="kigkonsult.se/iCalcreator" target="_blank">kigkonsult.se iCalcreator</a><br>
|
|
62
|
<a href="http://kigkonsult.se/contact/index.php" title="kigkonsult.se contact" target="_blank">kigkonsult.se contact</a>
|
|
63
|
</p>
|
|
64
|
<h4>Preface</h2>
|
|
65
|
<p>
|
|
66
|
This document is provided by kigkonsult for informational purposes
|
|
67
|
and is provided on an "as is" basis without any warranties expressed or implied.
|
|
68
|
</p>
|
|
69
|
<p>
|
|
70
|
Information in this document is subject to change without notice and does
|
|
71
|
not represent a commitment on the part of kigkonsult.
|
|
72
|
The software described in this document is provided under a license agreement, <a href="http://kigkonsult.se/downloads/dl.php?f=GPL">GNU Lesser General Public License</a>.
|
|
73
|
The software may be used only in accordance with the terms of that license agreement.
|
|
74
|
It is against the law to copy or use the software except as specifically allowed in the license agreement.
|
|
75
|
</p>
|
|
76
|
<p>
|
|
77
|
It is the users responsibility to ensure the suitability of the software before using it.
|
|
78
|
In no circumstances will kigkonsult be responsible for
|
|
79
|
the use of the software's outcomes or results or any loss
|
|
80
|
or damage of data or programs as a result of using the software.
|
|
81
|
The use of the software implies acceptance of these terms.
|
|
82
|
</p>
|
|
83
|
<p>
|
|
84
|
This document makes previous versions obsolete.
|
|
85
|
</p>
|
|
86
|
<h4>The software</h2>
|
|
87
|
<p>
|
|
88
|
This document describes a <b>short summary</b> usage of iCalcreator, a <em>PHP</em> software implementation of standards rfc5545/rfc5546 (rfc2445/rfc2446) to manage iCal formatted files.
|
|
89
|
</p>
|
|
90
|
<p>
|
|
91
|
iCalcreator is a <em>PHP</em> class package managing iCal files, supporting (non-)<strong>calendar</strong>
|
|
92
|
systems and applications to process and communicate <strong>calendar</strong> information like
|
|
93
|
events, agendas, tasks, reports, totos and journaling information.
|
|
94
|
</p>
|
|
95
|
<p>
|
|
96
|
The iCalcreator package, built of a <strong>calendar</strong> class with support of a function class and helper functions, are <strong>calendar</strong>
|
|
97
|
component property oriented. iCalcreator requires <em>PHP</em> >= 5.3.
|
|
98
|
</p>
|
|
99
|
<p>
|
|
100
|
More iCalcreator supplementary, usage and "howto" information will be found at kigkonsult.se iCalcreator
|
|
101
|
<a href="http://kigkonsult.se/test/index.php" title="kigkonsult.se iCalcreator implement and test examples" target="_blank">coding and test</a> pages.
|
|
102
|
A strong recommendation is to have the document
|
|
103
|
<a href="http://kigkonsult.se/iCalcreator/docs/using.html" title="iCalcreator user's Manual" target="_blank">user's manual</a>
|
|
104
|
open in parallel when exploiting the link.
|
|
105
|
</p>
|
|
106
|
|
|
107
|
<h4>iCal</h4>
|
|
108
|
<p>
|
|
109
|
A short iCal description is found at <a href="http://en.wikipedia.org/wiki/ICalendar#Core_object" title="iCalendar From Wikipedia, the free encyclopedia" target="_blank">Wikipedia</a>.
|
|
110
|
If You are not familiar with iCal, read this first!
|
|
111
|
</p>
|
|
112
|
<p>
|
|
113
|
Knowledge of <strong>calendar</strong> protocol rfc5545/rfc5546 is to recommend;
|
|
114
|
</p>
|
|
115
|
<dl>
|
|
116
|
<dt><a href="http://kigkonsult.se/downloads/dl.php?f=rfc5545" title="Download RFC5545 in text format" target="_blank">rfc5545</a>
|
|
117
|
<dd>Internet Calendaring and Scheduling Core Object Specification (iCalendar)
|
|
118
|
<dd>obsoletes <a href="http://kigkonsult.se/downloads/dl.php?f=rfc2445" title="Download RFC2445 in text format">rfc2445</a>
|
|
119
|
<dt><a href="http://kigkonsult.se/downloads/dl.php?f=rfc5546" title="Download RFC5546 in text format" target="_blank">rfc5546</a>
|
|
120
|
<dd>iCalendar Transport-Independent Interoperability Protocol (iTIP) Scheduling Events, BusyTime, To-dos and Journal Entries
|
|
121
|
<dd>obsoletes <a href="http://kigkonsult.se/downloads/dl.php?f=rfc2446" title="Download RFC2446 in text format">rfc2446</a>.
|
|
122
|
</dl>
|
|
123
|
|
|
124
|
<h4>xCal</h4>
|
|
125
|
<p>
|
|
126
|
iCalcreator also supports xCal (iCal xml).
|
|
127
|
</p>
|
|
128
|
<dl>
|
|
129
|
<dt>
|
|
130
|
<dt><a href="http://kigkonsult.se/downloads/dl.php?f=rfc6321" title="Download RFC6321 in text format" target="_blank">rfc6321</a>
|
|
131
|
<dd>xCal: The XML Format for <strong>iCalendar</strong>
|
|
132
|
</dl>
|
|
133
|
|
|
134
|
<h4>SUPPORT</h4>
|
|
135
|
<p>
|
|
136
|
The main support channel is using iCalcreator
|
|
137
|
<a title="Sourceforge" href="http://sourceforge.net/projects/icalcreator/forums/" target="_blank">Sourceforge</a> forum.
|
|
138
|
</p>
|
|
139
|
<p>
|
|
140
|
Support and development is now focused on iCalcreator (Pro) 3.x versions, which, in turn, will affect future releases
|
|
141
|
of iCalcreator 2.x.
|
|
142
|
</p>
|
|
143
|
<p>
|
|
144
|
kigkonsult offer professional services for software support, design and new/re-development, customizations and adaptations
|
|
145
|
of <em>PHP</em>/<em>MySQL</em> solutions with focus on software lifecycle management, including long term utility, reliability and maintainability.
|
|
146
|
</p>
|
|
147
|
|
|
148
|
<h4>DONATE</h4>
|
|
149
|
<p>
|
|
150
|
You can show your appreciation for our free software,
|
|
151
|
and can support future development by making a donation to the kigkonsult GPL/LGPL projects.
|
|
152
|
</p>
|
|
153
|
<p>
|
|
154
|
Make a donation of any size by clicking <a href="http://kigkonsult.se/contact/index.php#Donate" title="Donate" target="_blank">here</a>.
|
|
155
|
Thanks in advance!
|
|
156
|
</p>
|
|
157
|
|
|
158
|
<h4>Contact</h4>
|
|
159
|
<p>
|
|
160
|
Use the <a href="http://kigkonsult.se/contact/index.php" title="kigkonsult.se/contact" target="_blank">contact page</a>
|
|
161
|
for queries, improvement/development issues or professional support and development.
|
|
162
|
Please note that paid support or consulting service has the highest priority.
|
|
163
|
</p>
|
|
164
|
|
|
165
|
<h4>Downloads and usage examples</h4>
|
|
166
|
<p>
|
|
167
|
At <a href="http://kigkonsult.se/iCalcreator/index.php" title="kigkonsult iCalcreator" target="_blank">kigkonsult.se</a> you can download the
|
|
168
|
<a href="http://kigkonsult.se/downloads/index.php#iCalcreator" title="iCalcreator complete manual" target="_blank">complete manual</a>
|
|
169
|
and review and explore iCalcreator usage at the
|
|
170
|
<a href="http://kigkonsult.se/test/index.php" title="kigkonsult.se iCalcreator implement and test examples" target="_blank">coding and test</a> pages.
|
|
171
|
</p>
|
|
172
|
|
|
173
|
<h4>INSTALL</h4>
|
|
174
|
<dl>
|
|
175
|
<dt>Unpack to any folder
|
|
176
|
<dd>add iCalcreator folder to your include-path
|
|
177
|
<dd>or unpack to your application-(include)-folder<br>
|
|
178
|
</dl>
|
|
179
|
<p>
|
|
180
|
Add
|
|
181
|
</p>
|
|
182
|
<pre><?php
|
|
183
|
.. .
|
|
184
|
require_once "[path/]iCalcreator-<version>/iCalcreator.php";
|
|
185
|
.. .
|
|
186
|
?>
|
|
187
|
</pre>
|
|
188
|
<p>
|
|
189
|
to your php-script.
|
|
190
|
The iCalcreator invoke has changed since previous version!
|
|
191
|
You may also need to set the default timezone.</p>
|
|
192
|
<p>
|
|
193
|
When creating a new calendar(/component) object instance, review config settings.
|
|
194
|
</p>
|
|
195
|
|
|
196
|
|
|
197
|
<h2>CREATE</h2>
|
|
198
|
|
|
199
|
<pre><?php
|
|
200
|
.. .
|
|
201
|
require_once "iCalcreator-<version>/iCalcreator.php";
|
|
202
|
$tz = "Europe/Stockholm"; // <span class="comment">define time zone</span>
|
|
203
|
$config = array( "unique_id" => "kigkonsult.se", // <span class="comment">set Your unique id, </span>
|
|
204
|
// <span class="comment">required if any component UID is missing</span>
|
|
205
|
"TZID" => $tz ); // <span class="comment">opt. set "calendar" timezone</span>
|
|
206
|
$v = new vcalendar( $config ); // <span class="comment">create a new calendar object instance</span>
|
|
207
|
|
|
208
|
$v->setProperty( "method", "PUBLISH" ); // <span class="comment">required of some <strong>calendar</strong> software</span>
|
|
209
|
$v->setProperty( "x-wr-calname", "Calendar Sample" ); // <span class="comment">required of some <strong>calendar</strong> software</span>
|
|
210
|
$v->setProperty( "X-WR-CALDESC", "Calendar Description" ); // <span class="comment">required of some <strong>calendar</strong> software</span>
|
|
211
|
$v->setProperty( "X-WR-TIMEZONE", $tz ); // <span class="comment">required of some <strong>calendar</strong> software</span>
|
|
212
|
.. .
|
|
213
|
.. .
|
|
214
|
$vevent = $v->newComponent( "vevent" ); // <span class="comment">create an event <strong>calendar</strong> component</span>
|
|
215
|
$vevent->setProperty( "dtstart", array( "year" => 2007
|
|
216
|
, "month" => 4
|
|
217
|
, "day" => 1
|
|
218
|
, "hour" => 19
|
|
219
|
, "min" => 0
|
|
220
|
, "sec" => 0 ));
|
|
221
|
$vevent->setProperty( "dtend", array( "year" => 2007
|
|
222
|
, "month" => 4
|
|
223
|
, "day" => 1
|
|
224
|
, "hour" => 22
|
|
225
|
, "min" => 30
|
|
226
|
, "sec" => 0 ));
|
|
227
|
$vevent->setProperty( "LOCATION", "Central Placa" ); // <span class="comment">property name - case independent</span>
|
|
228
|
$vevent->setProperty( "summary", "PHP summit" );
|
|
229
|
$vevent->setProperty( "description", "This is a description" );
|
|
230
|
$vevent->setProperty( "comment", "This is a comment" );
|
|
231
|
$vevent->setProperty( "attendee", "attendee1@icaldomain.net" );
|
|
232
|
.. .
|
|
233
|
$valarm = $vevent->newComponent( "valarm" ); // <span class="comment">create an event alarm</span>
|
|
234
|
$valarm->setProperty("action", "DISPLAY" );
|
|
235
|
$valarm->setProperty("description", $vevent->getProperty( "description" );
|
|
236
|
.. . // <span class="comment">reuse the event description</span>
|
|
237
|
$d = sprintf( '%04d%02d%02d %02d%02d%02d', 2007, 3, 31, 15, 0, 0 ); // local date
|
|
238
|
iCalUtilityFunctions::transformDateTime( $d, $tz, "UTC", "Ymd\THis\Z");
|
|
239
|
$valarm->setProperty( "trigger", $d ); // <span class="comment">create alarm trigger (in UTC datetime)</span>
|
|
240
|
.. .
|
|
241
|
$vevent = $v->newComponent( "vevent" ); // <span class="comment">create next event calendar component</span>
|
|
242
|
$vevent->setProperty( "dtstart", "20070401", array("VALUE" => "DATE"));// <span class="comment">alt. date format,</span>
|
|
243
|
// <span class="comment"> now for an all-day event</span>
|
|
244
|
$vevent->setProperty( "organizer" , "boss@icaldomain.com" );
|
|
245
|
$vevent->setProperty( "summary", "ALL-DAY event" );
|
|
246
|
$vevent->setProperty( "description", "This is a description for an all-day event" );
|
|
247
|
$vevent->setProperty( "resources", "COMPUTER PROJECTOR" );
|
|
248
|
$vevent->setProperty( "rrule", array( "FREQ" => "WEEKLY", "count" => 4));// <span class="comment">weekly, four occasions</span>
|
|
249
|
$vevent->parse( "LOCATION:1CP Conference Room 4350" ); // <span class="comment">supporting parse of</span>
|
|
250
|
// <span class="comment"> strict rfc5545 formatted text</span>
|
|
251
|
.. .
|
|
252
|
.. .// <span class="comment">all calendar components are described in <a href="http://kigkonsult.se/downloads/dl.php?f=rfc5545" title="RFC5545" target="_blank">rfc5545</a></span>
|
|
253
|
.. .// <span class="comment">a complete iCalcreator function list (ex. setProperty) in <a href="http://kigkonsult.se/downloads/index.php#iCalcreator" title="iCalcreator complete manual" target="_blank">iCalcreator manual</a></span>
|
|
254
|
.. .
|
|
255
|
$xprops = array( "X-LIC-LOCATION" => $tz ); // <span class="comment">required of some <strong>calendar</strong> software</span>
|
|
256
|
iCalUtilityFunctions::createTimezone( $v, $tz, $xprops); // <span class="comment">create timezone component(-s)</span>
|
|
257
|
// <span class="comment">based on all start dates in events</span>
|
|
258
|
// <span class="comment">(i.e. dtstart)</span>
|
|
259
|
.. .
|
|
260
|
?>
|
|
261
|
</pre>
|
|
262
|
|
|
263
|
<h2>PARSE</h2>
|
|
264
|
<h4>iCal, rfc5545 / rfc2445 </h4>
|
|
265
|
<h5>create iCalcreator object instance</h5>
|
|
266
|
<pre><?php
|
|
267
|
.. .
|
|
268
|
require_once "iCalcreator-<version>/iCalcreator.php";
|
|
269
|
$config = array( "unique_id" => "kigkonsult.se" ); // <span class="comment">set Your unique id, </span>
|
|
270
|
.. . // <span class="comment">required if any component UID is missing</span>
|
|
271
|
$v = new vcalendar( $config ); // <span class="comment">create a new <strong>calendar</strong> object instance</span>
|
|
272
|
.. .
|
|
273
|
</pre>
|
|
274
|
<h5>then parse a local iCal file</h5>
|
|
275
|
<pre>.. .
|
|
276
|
$config = array( "directory" => "calendar", "filename" => "file.ics" );
|
|
277
|
$v->setConfig( $config ); // <span class="comment">set directory and file name</span>
|
|
278
|
$v->parse();
|
|
279
|
.. . // <span class="comment">continue process (edit, parse,select)</span>
|
|
280
|
.. . // <span class="comment"> the iCalcreator object instance</span>
|
|
281
|
.. .
|
|
282
|
?>
|
|
283
|
</pre>
|
|
284
|
<p>
|
|
285
|
On error, the setConfig method returns FALSE (ex. unvalid directory/filename).
|
|
286
|
</p>
|
|
287
|
<h5>or parse a remote iCal file (resource)</h5>
|
|
288
|
<pre>.. .
|
|
289
|
$v->setConfig( "url", "http://www.aDomain.net/file.ics" ); // <span class="comment">supporting parse of remote files</span>
|
|
290
|
$v->parse();
|
|
291
|
.. .
|
|
292
|
$v->sort(); // <span class="comment">ensure start date order</span>
|
|
293
|
.. . // <span class="comment">(opt., <b>NOT</b> required after parse)</span>
|
|
294
|
.. .
|
|
295
|
.. . // <span class="comment">continue process (edit, parse,select)</span>
|
|
296
|
.. . // <span class="comment"> the iCalcreator object instance</span>
|
|
297
|
.. .
|
|
298
|
?>
|
|
299
|
</pre>
|
|
300
|
<p>
|
|
301
|
On error, the parse method returns FALSE.
|
|
302
|
</p>
|
|
303
|
<h4>xCal, rfc6321 (XML)</h4>
|
|
304
|
<pre><?php
|
|
305
|
.. .
|
|
306
|
require_once "iCalcreator-<version>/iCalcreator.php";
|
|
307
|
$config = array( "unique_id" => "kigkonsult.se" ); // <span class="comment">set Your unique id, </span>
|
|
308
|
.. . // <span class="comment">required if any component UID is missing</span>
|
|
309
|
.. .
|
|
310
|
$filename = 'xmlfile.xml'; // <span class="comment">use a local xCal file</span>
|
|
311
|
// $filename = 'http://kigkonsult.se/xcal.php?a=1&b=2&c=3';// <span class="comment"> or a remote xCal resource</span>
|
|
312
|
if( FALSE === ( $v = XMLfile2iCal( $filename, $config ))) // <span class="comment">convert the XML resource</span>
|
|
313
|
exit( "Error when parsing $filename" ); // <span class="comment"> to an iCalcreator object instance</span>
|
|
314
|
.. . // <span class="comment">continue process (edit, parse, select)</span>
|
|
315
|
.. . // <span class="comment"> the iCalcreator object instance</span>
|
|
316
|
.. .
|
|
317
|
?>
|
|
318
|
</pre>
|
|
319
|
|
|
320
|
|
|
321
|
<h2>EDIT</h2>
|
|
322
|
<pre><?php
|
|
323
|
.. .
|
|
324
|
require_once "iCalcreator-<version>/iCalcreator.php";
|
|
325
|
$config = array( "unique_id" => "kigkonsult.se" // <span class="comment">set Your unique id,</span>
|
|
326
|
, "directory" => "calendar" // <span class="comment">import directory</span>
|
|
327
|
, "filename" => "file.ics" ); // <span class="comment">and file name</span>
|
|
328
|
|
|
329
|
$v = new vcalendar( $config ); // <span class="comment">create a new calendar object instance</span>
|
|
330
|
|
|
331
|
$v->parse();
|
|
332
|
|
|
333
|
$v->setProperty( "method", "PUBLISH" ); // <span class="comment">required of some <strong>calendar</strong> software</span>
|
|
334
|
$v->setProperty( "x-wr-calname", "Calendar Sample" ); // <span class="comment">required of some <strong>calendar</strong> software</span>
|
|
335
|
$v->setProperty( "X-WR-CALDESC", "Calendar Description" ); // <span class="comment">required of some <strong>calendar</strong> software</span>
|
|
336
|
$v->setProperty( "X-WR-TIMEZONE", "Europe/Stockholm" ); // <span class="comment">required of some <strong>calendar</strong> software</span>
|
|
337
|
|
|
338
|
while( $vevent = $v->getComponent( "vevent" )) { // <span class="comment">read events, one by one</span>
|
|
339
|
$uid = $vevent->getProperty( "uid" ); // <span class="comment">uid required, one occurrence</span>
|
|
340
|
.. . // <span class="comment"> (unique id/key for component)</span>
|
|
341
|
$dtstart = $vevent->getProperty( "dtstart" ); // <span class="comment">dtstart required, one occurrence</span>
|
|
342
|
.. .
|
|
343
|
if( $description = $vevent->getProperty( "description", 1 )) { // <span class="comment">opt. description, 1st occurrence</span>
|
|
344
|
.. . // <span class="comment">edit the description</span>
|
|
345
|
$vevent->setProperty( "description", $description, FALSE, 1 ); // <span class="comment">update/replace the description</span>
|
|
346
|
}
|
|
347
|
while( $comment = $vevent->getProperty( "comment" )) { // <span class="comment">optional comments</span>
|
|
348
|
.. . // <span class="comment">manage comments</span>
|
|
349
|
}
|
|
350
|
.. .
|
|
351
|
while( $vevent->deleteProperty( "attendee" ))
|
|
352
|
continue; // <span class="comment">remove all ATTENDEE properties .. .</span>
|
|
353
|
.. .
|
|
354
|
$v->setComponent ( $vevent, $uid ); // <span class="comment">update/replace event in calendar</span>
|
|
355
|
// <span class="comment"> with <b>UID</b> as key</span>
|
|
356
|
}
|
|
357
|
.. .
|
|
358
|
.. .// <span class="comment">a complete iCalcreator function list (ex. getProperty, deleteProperty) in <a href="http://kigkonsult.se/downloads/index.php#iCalcreator" title="iCalcreator complete manual" target="_blank">iCalcreator manual</a></span>
|
|
359
|
.. .
|
|
360
|
?>
|
|
361
|
</pre>
|
|
362
|
<br>
|
|
363
|
<br>
|
|
364
|
|
|
365
|
<h2>SELECT</h2>
|
|
366
|
<pre><?php
|
|
367
|
.. .
|
|
368
|
require_once "iCalcreator-<version>/iCalcreator.php";
|
|
369
|
$config = array( "unique_id" => "kigkonsult.se" ); // <span class="comment">set Your unique id</span>
|
|
370
|
$v = new vcalendar( $config ); // <span class="comment">create a new <strong>calendar</strong> object instance</span>
|
|
371
|
|
|
372
|
$v->setConfig( "url", "http://www.aDomain.net/file.ics" ); // <span class="comment">iCalcreator also support remote files</span>
|
|
373
|
$v->parse();
|
|
374
|
|
|
375
|
$v->setProperty( "method", "PUBLISH" ); // <span class="comment">required of some <strong>calendar</strong> software</span>
|
|
376
|
$v->setProperty( "x-wr-calname", "Calendar Sample" ); // <span class="comment">required of some <strong>calendar</strong> software</span>
|
|
377
|
$v->setProperty( "X-WR-CALDESC", "Calendar Description" ); // <span class="comment">required of some <strong>calendar</strong> software</span>
|
|
378
|
$v->setProperty( "X-WR-TIMEZONE", "Europe/Stockholm" ); // <span class="comment">required of some <strong>calendar</strong> software</span>
|
|
379
|
.. .
|
|
380
|
?>
|
|
381
|
</pre>
|
|
382
|
<h4>Date based select</h4>
|
|
383
|
<pre><?php
|
|
384
|
.. .
|
|
385
|
$eventArray = $v->selectComponents(); // <span class="comment">select components occurring <b>today</b></span>
|
|
386
|
// <span class="comment">(including components</span>
|
|
387
|
// <span class="comment">with recurrence pattern)</span>
|
|
388
|
foreach( $eventArray as $year => $yearArray) {
|
|
389
|
foreach( $yearArray as $month => $monthArray ) {
|
|
390
|
foreach( $monthArray as $day => $dailyEventsArray ) {
|
|
391
|
foreach( $dailyEventsArray as $vevent ) {
|
|
392
|
$currddate = $event->getProperty( "x-current-dtstart" );
|
|
393
|
// <span class="comment">if member of a recurrence set</span>
|
|
394
|
// <span class="comment">returns array( </span>
|
|
395
|
// <span class="comment"> "x-current-dtstart"</span>
|
|
396
|
// <span class="comment"> , (string) date(</span>
|
|
397
|
// <span class="comment"> "Y-m-d [H:i:s][timezone/UTC offset]"))</span>
|
|
398
|
$dtstart = $vevent->getProperty( "dtstart" ); // <span class="comment">dtstart required, one occurrence,</span>
|
|
399
|
// <span class="comment"> (orig. start date)</span>
|
|
400
|
$summary = $vevent->getProperty( "summary" );
|
|
401
|
$description = $vevent->getProperty( "description" );
|
|
402
|
.. .
|
|
403
|
.. .
|
|
404
|
}
|
|
405
|
}
|
|
406
|
}
|
|
407
|
}
|
|
408
|
.. .
|
|
409
|
?>
|
|
410
|
</pre>
|
|
411
|
<h4>Select specific property values</h4>
|
|
412
|
<pre><?php
|
|
413
|
.. .
|
|
414
|
$valueOccur = $v->getProperty( "RESOURCES" ); // <span class="comment">fetch specific property</span>
|
|
415
|
// <span class="comment">(unique) values and occurrences</span>
|
|
416
|
// <span class="comment">ATTENDEE, CATEGORIES, CONTACT,</span>
|
|
417
|
// <span class="comment">DTSTART, LOCATION, ORGANIZER,</span>
|
|
418
|
// <span class="comment">PRIORITY, RESOURCES, STATUS,</span>
|
|
419
|
// <span class="comment">SUMMARY, UID, URL,</span>
|
|
420
|
// <span class="comment">GEOLOCATION<sup>*</sup></span>
|
|
421
|
foreach( $valueOccur as $uniqueValue => $occurCnt ) {
|
|
422
|
echo "The RESOURCES value <b>$uniqueValue</b> occurs <b>$occurCnt</b> times<br />";
|
|
423
|
.. .
|
|
424
|
}
|
|
425
|
.. .
|
|
426
|
?>
|
|
427
|
</pre>
|
|
428
|
<p>
|
|
429
|
<sup>*</sup>) Using the non-standard directive "GEOLOCATION", iCalcreator returns output supporting
|
|
430
|
ISO6709 "Standard representation of geographic point location by coordinates",
|
|
431
|
by combining the "LOCATION" and "GEO" property values (only if "GEO" is set).
|
|
432
|
</p>
|
|
433
|
<h4>Select components based on specific property value</h4>
|
|
434
|
<pre><?php
|
|
435
|
.. .
|
|
436
|
$selectSpec = array( "CATEGORIES" => "course1" );
|
|
437
|
$specComps = $v->selectComponents( $selectSpec ); // <span class="comment">selects components</span>
|
|
438
|
// <span class="comment">based on specific property value(-s)</span>
|
|
439
|
// <span class="comment">ATTENDEE, CATEGORIES, CONTACT,</span>
|
|
440
|
// <span class="comment">LOCATION, ORGANIZER,</span>
|
|
441
|
// <span class="comment">PRIORITY, RESOURCES, STATUS,</span>
|
|
442
|
// <span class="comment">SUMMARY, URL, UID</span>
|
|
443
|
foreach( $specComps as $comp ) {
|
|
444
|
.. .
|
|
445
|
}
|
|
446
|
.. .
|
|
447
|
?>
|
|
448
|
</pre>
|
|
449
|
<br>
|
|
450
|
<br>
|
|
451
|
|
|
452
|
<h2>OUTPUT</h2>
|
|
453
|
<h5>create iCalcreator object instance</h5>
|
|
454
|
<pre><?php
|
|
455
|
.. .
|
|
456
|
require_once "iCalcreator-<version>/iCalcreator.php";
|
|
457
|
$config = array( "unique_id" => "kigkonsult.se" ); // <span class="comment">set Your unique id</span>
|
|
458
|
$v = new vcalendar( $config ); // <span class="comment">create a new calendar object instance</span>
|
|
459
|
|
|
460
|
$v->setProperty( "method", "PUBLISH" ); // <span class="comment">required of some <strong>calendar</strong> software</span>
|
|
461
|
$v->setProperty( "x-wr-calname", "Calendar Sample" ); // <span class="comment">required of some <strong>calendar</strong> software</span>
|
|
462
|
$v->setProperty( "X-WR-CALDESC", "Calendar Description" ); // <span class="comment">required of some <strong>calendar</strong> software</span>
|
|
463
|
$v->setProperty( "X-WR-TIMEZONE", "Europe/Stockholm" ); // <span class="comment">required of some <strong>calendar</strong> software</span>
|
|
464
|
.. .
|
|
465
|
.. . // <span class="comment">continue process (edit, parse,select)</span>
|
|
466
|
.. . // <span class="comment"> the iCalcreator object instance</span>
|
|
467
|
.. .
|
|
468
|
?>
|
|
469
|
</pre>
|
|
470
|
<h5>opt 1</h5>
|
|
471
|
<pre><?php
|
|
472
|
.. .
|
|
473
|
$v->returnCalendar(); // <span class="comment">redirect calendar file to browser</span>
|
|
474
|
exit;
|
|
475
|
</pre>
|
|
476
|
|
|
477
|
<h5>opt 2</h5>
|
|
478
|
<pre><?php
|
|
479
|
.. .
|
|
480
|
$config = array( "directory" => "depot", "filename" => "calendar.ics" );
|
|
481
|
$v->setConfig( $config ); // <span class="comment">set output directory and file name</span>
|
|
482
|
$v->saveCalendar(); // <span class="comment">save calendar to (local) file</span>
|
|
483
|
.. .
|
|
484
|
?>
|
|
485
|
</pre>
|
|
486
|
|
|
487
|
<h5>opt 3, xCal</h5>
|
|
488
|
<pre><?php
|
|
489
|
.. .
|
|
490
|
$mlstr = iCal2XML( $v ); // <span class="comment">create well-formed XML, rfc6321</span>
|
|
491
|
.. .
|
|
492
|
?>
|
|
493
|
</pre>
|
|
494
|
<br>
|
|
495
|
<br>
|
|
496
|
|
|
497
|
|
|
498
|
<h2>COPYRIGHT AND LICENSE</h2>
|
|
499
|
|
|
500
|
<h4>Copyright</h4>
|
|
501
|
<p>
|
|
502
|
iCalcreator v2.22<br>
|
|
503
|
Copyright (c) 2007-2015 Kjell-Inge Gustafsson, kigkonsult, All rights reserved.<br>
|
|
504
|
<a href="http://kigkonsult.se/iCalcreator/index.php" title="kigkonsult.se/iCalcreator" target="_blank">kigkonsult.se iCalcreator</a><br>
|
|
505
|
<a href="http://kigkonsult.se/contact/index.php" title="kigkonsult.se contact" target="_blank">kigkonsult.se contact</a>
|
|
506
|
</p>
|
|
507
|
|
|
508
|
<h4>License</h4>
|
|
509
|
|
|
510
|
<p>
|
|
511
|
This library is free software; you can redistribute it and/or
|
|
512
|
modify it under the terms of the GNU Lesser General Public
|
|
513
|
License as published by the Free Software Foundation; either
|
|
514
|
version 2.1 of the License, or (at your option) any later version.
|
|
515
|
</p>
|
|
516
|
<p>
|
|
517
|
This library is distributed in the hope that it will be useful,
|
|
518
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
519
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
520
|
Lesser General Public License for more details.
|
|
521
|
</p>
|
|
522
|
<p>
|
|
523
|
You should have received a copy of the GNU Lesser General Public
|
|
524
|
License along with this library; if not, write to the Free Software
|
|
525
|
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
526
|
or download it <a href="http://kigkonsult.se/downloads/dl.php?f=LGPL" target="_blank">here</a>.
|
|
527
|
</p>
|
|
528
|
<br>
|
|
529
|
<br>
|
|
530
|
</body>
|
|
531
|
</html>
|
