1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
|
<?xml version="1.0" encoding="utf-8"?>
<reference id="ref.icap">
<title>ICAP Functions</title>
<titleabbrev>ICAP</titleabbrev>
<partintro>
<simpara>
To get these functions to work, you have to compile PHP with
<option role="configure">--with-icap</option>. That requires the
icap library to be installed. Grab the latest version from <ulink
url="&url.icap;">&url.icap;</ulink> and compile and install it.
</simpara>
</partintro>
<refentry id="function.icap-open">
<refnamediv>
<refname>icap_open</refname>
<refpurpose>Opens up an ICAP connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>stream</type><methodname>icap_open</methodname>
<methodparam><type>string</type><parameter>calendar</parameter></methodparam>
<methodparam><type>string</type><parameter>username</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
<methodparam><type>string</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
Returns an ICAP stream on success, &false; on error.</para>
<para>
<function>icap_open</function> opens up an ICAP connection to the
specified <parameter>calendar</parameter> store. If the optional
<parameter>options</parameter> is specified, passes the
<parameter>options</parameter> to that mailbox also.
</para>
</refsect1>
</refentry>
<refentry id="function.icap-close">
<refnamediv>
<refname>icap_close</refname>
<refpurpose>Close an ICAP stream</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>icap_close</methodname>
<methodparam><type>int</type><parameter>icap_stream</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
Closes the given icap stream.
</para>
</refsect1>
</refentry>
<refentry id="function.icap-fetch-event">
<refnamediv>
<refname>icap_fetch_event</refname>
<refpurpose>Fetches an event from the calendar stream/</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>icap_fetch_event</methodname>
<methodparam><type>int</type><parameter>stream_id</parameter></methodparam>
<methodparam><type>int</type><parameter>event_id</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
<function>icap_fetch_event</function> fetches an event from the
calendar stream specified by <parameter>event_id</parameter>.
</para>
<para>
Returns an event object consisting of:
<itemizedlist>
<listitem>
<simpara>
int id - ID of that event.
</simpara>
</listitem>
<listitem>
<simpara>
int public - &true; if the event if public, &false; if it is private.
</simpara>
</listitem>
<listitem>
<simpara>
string category - Category string of the event.
</simpara>
</listitem>
<listitem>
<simpara>
string title - Title string of the event.
</simpara>
</listitem>
<listitem>
<simpara>
string description - Description string of the event.
</simpara>
</listitem>
<listitem>
<simpara>
int alarm - number of minutes before the event to send an
alarm/reminder.
</simpara>
</listitem>
<listitem>
<simpara>
object start - Object containing a datetime entry.
</simpara>
</listitem>
<listitem>
<simpara>
object end - Object containing a datetime entry.
</simpara>
</listitem>
</itemizedlist>
All datetime entries consist of an object that contains:
<itemizedlist>
<listitem>
<simpara>
int year - year
</simpara>
</listitem>
<listitem>
<simpara>
int month - month
</simpara>
</listitem>
<listitem>
<simpara>
int mday - day of month
</simpara>
</listitem>
<listitem>
<simpara>
int hour - hour
</simpara>
</listitem>
<listitem>
<simpara>
int min - minutes
</simpara>
</listitem>
<listitem>
<simpara>
int sec - seconds
</simpara></listitem>
</itemizedlist>
</para>
</refsect1>
</refentry>
<refentry id="function.icap-list-events">
<refnamediv>
<refname>icap_list_events</refname>
<refpurpose>
Return a list of events between two given datetimes
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>icap_list_events</methodname>
<methodparam><type>int</type><parameter>stream_id</parameter></methodparam>
<methodparam><type>int</type><parameter>begin_date</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>end_date</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array of event ID's that are between the two given
datetimes.
</para>
<para>
<function>icap_list_events</function> function takes in a
beginning datetime and an end datetime for a calendar stream. An
array of event id's that are between the given datetimes are
returned.
</para>
<para>
All datetime entries consist of an object that contains:
<itemizedlist>
<listitem>
<simpara>
int year - year
</simpara>
</listitem>
<listitem>
<simpara>
int month - month
</simpara>
</listitem>
<listitem>
<simpara>
int mday - day of month
</simpara>
</listitem>
<listitem>
<simpara>
int hour - hour
</simpara>
</listitem>
<listitem>
<simpara>
int min - minutes
</simpara>
</listitem>
<listitem>
<simpara>
int sec - seconds
</simpara>
</listitem>
</itemizedlist>
</para>
</refsect1>
</refentry>
<refentry id="function.icap-store-event">
<refnamediv>
<refname>icap_store_event</refname>
<refpurpose>Store an event into an ICAP calendar</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>icap_store_event</methodname>
<methodparam><type>int</type><parameter>stream_id</parameter></methodparam>
<methodparam><type>object</type><parameter>event</parameter></methodparam>
</methodsynopsis>
<para>
<function>icap_store_event</function> Stores an event into
an ICAP calendar. An event object consists of:
<itemizedlist>
<listitem>
<simpara>
int public - 1 if public, 0 if private;
</simpara>
</listitem>
<listitem>
<simpara>
string caegory - Category string of the event.
</simpara>
</listitem>
<listitem>
<simpara>
string title - Title string of the event.
</simpara>
</listitem>
<listitem>
<simpara>
string description - Description string of the event.
</simpara>
</listitem>
<listitem>
<simpara>
int alarm - Number of minutes before the event to sned out an alarm.
</simpara>
</listitem>
<listitem>
<simpara>
datetime start - datetime object of the start of the event.
</simpara>
</listitem>
<listitem>
<simpara>
datetime end - datetime object of the end of the event.
</simpara>
</listitem>
</itemizedlist>
</para>
<para>
All datetime entries consist of an object that contains:
<itemizedlist>
<listitem>
<simpara>
int year - year
</simpara>
</listitem>
<listitem>
<simpara>
int month - month
</simpara>
</listitem>
<listitem>
<simpara>
int mday - day of month
</simpara>
</listitem>
<listitem>
<simpara>
int hour - hour
</simpara>
</listitem>
<listitem>
<simpara>
int min - minutes
</simpara>
</listitem>
<listitem>
<simpara>
int sec - seconds
</simpara>
</listitem>
</itemizedlist>
</para>
<para>
Returns &true; on success and &false; on error.
</para>
</refsect1>
</refentry>
<refentry id="function.icap-delete-event">
<refnamediv>
<refname>icap_delete_event</refname>
<refpurpose>Delete an event from an ICAP calendar</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>icap_delete_event</methodname>
<methodparam><type>int</type><parameter>sream_id</parameter></methodparam>
<methodparam><type>int</type><parameter>uid</parameter></methodparam>
</methodsynopsis>
<para>
<function>icap_delete_event</function> deletes the calendar event
specified by the <parameter>uid</parameter>.
</para>
<para>
Returns &true;.
</para>
</refsect1>
</refentry>
<refentry id="function.icap-snooze">
<refnamediv>
<refname>icap_snooze</refname>
<refpurpose>Snooze an alarm</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>icap_snooze</methodname>
<methodparam><type>int</type><parameter>stream_id</parameter></methodparam>
<methodparam><type>int</type><parameter>uid</parameter></methodparam>
</methodsynopsis>
<para>
<function>icap_snooze</function> turns on an alarm for a
calendar event specified by the <parameter>uid</parameter>.
</para>
<para>
Returns &true;.
</para>
</refsect1>
</refentry>
<refentry id="function.icap-list-alarms">
<refnamediv>
<refname>icap_list_alarms</refname>
<refpurpose>
Return a list of events that has an alarm triggered at the given
datetime
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>icap_list_alarms</methodname>
<methodparam><type>int</type><parameter>stream_id</parameter></methodparam>
<methodparam><type>array</type><parameter>date</parameter></methodparam>
<methodparam><type>array</type><parameter>time</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array of event ID's that has an alarm going off at the
given datetime.
</para>
<para>
<function>icap_list_alarms</function> function takes in a
datetime for a calendar stream. An array of event id's that has
an alarm should be going off at the datetime are returned.
</para>
<para>
All datetime entries consist of an object that contains:
<itemizedlist>
<listitem>
<simpara>
int year - year
</simpara>
</listitem>
<listitem>
<simpara>
int month - month
</simpara>
</listitem>
<listitem>
<simpara>
int mday - day of month
</simpara>
</listitem>
<listitem>
<simpara>
int hour - hour
</simpara>
</listitem>
<listitem>
<simpara>
int min - minutes
</simpara>
</listitem>
<listitem>
<simpara>
int sec - seconds
</simpara>
</listitem>
</itemizedlist>
</para>
</refsect1>
</refentry>
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
|
