ICAP FunctionsICAP
To get these functions to work, you have to compile PHP with
. That requires the
icap library to be installed. Grab the latest version from &url.icap; and compile and install it.
icap_openOpens up an ICAP connectionDescriptionstream icap_openstring calendarstring usernamestring passwordstring options
Returns an ICAP stream on success, &false; on error.icap_open opens up an ICAP connection to the
specified calendar store. If the optional
options is specified, passes the
options to that mailbox also.
icap_closeClose an ICAP streamDescriptionint icap_closeint icap_streamint
flags
Closes the given icap stream.
icap_fetch_eventFetches an event from the calendar stream/Descriptionint icap_fetch_eventint stream_idint event_idint
optionsicap_fetch_event fetches an event from the
calendar stream specified by event_id.
Returns an event object consisting of:
int id - ID of that event.
int public - &true; if the event if public, &false; if it is private.
string category - Category string of the event.
string title - Title string of the event.
string description - Description string of the event.
int alarm - number of minutes before the event to send an
alarm/reminder.
object start - Object containing a datetime entry.
object end - Object containing a datetime entry.
All datetime entries consist of an object that contains:
int year - year
int month - month
int mday - day of month
int hour - hour
int min - minutes
int sec - seconds
icap_list_events
Return a list of events between two given datetimes
Descriptionarray icap_list_eventsint stream_idint begin_dateint
end_date
Returns an array of event ID's that are between the two given
datetimes.
icap_list_events 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.
All datetime entries consist of an object that contains:
int year - year
int month - month
int mday - day of month
int hour - hour
int min - minutes
int sec - seconds
icap_store_eventStore an event into an ICAP calendarDescriptionstring icap_store_eventint stream_idobject eventicap_store_event Stores an event into
an ICAP calendar. An event object consists of:
int public - 1 if public, 0 if private;
string caegory - Category string of the event.
string title - Title string of the event.
string description - Description string of the event.
int alarm - Number of minutes before the event to sned out an alarm.
datetime start - datetime object of the start of the event.
datetime end - datetime object of the end of the event.
All datetime entries consist of an object that contains:
int year - year
int month - month
int mday - day of month
int hour - hour
int min - minutes
int sec - seconds
Returns &true; on success and &false; on error.
icap_delete_eventDelete an event from an ICAP calendarDescriptionstring icap_delete_eventint sream_idint uidicap_delete_event deletes the calendar event
specified by the uid.
Returns &true;.
icap_snoozeSnooze an alarmDescriptionstring icap_snoozeint stream_idint uidicap_snooze turns on an alarm for a
calendar event specified by the uid.
Returns &true;.
icap_list_alarms
Return a list of events that has an alarm triggered at the given
datetime
Descriptionint icap_list_alarmsint stream_idarray datearray time
Returns an array of event ID's that has an alarm going off at the
given datetime.
icap_list_alarms 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.
All datetime entries consist of an object that contains:
int year - year
int month - month
int mday - day of month
int hour - hour
int min - minutes
int sec - seconds
icap_create_calendar
Create a new calendar
Descriptionstring icap_create_calendarint stream_idstring calendar
&warn.undocumented.func;
icap_rename_calendar
Rename a calendar
Descriptionstring icap_rename_calendarint stream_idstring old_namestring new_name
&warn.undocumented.func;
icap_delete_calendar
Delete a calendar
Descriptionstring icap_delete_calendarint stream_idstring calendar
&warn.undocumented.func;
icap_reopen
Reopen ICAP stream to new calendar
Descriptionint icap_reopenint stream_idstring calendarint options
&warn.undocumented.func;