From 80de3068cd15c63884c35d581285230e2949bb09 Mon Sep 17 00:00:00 2001 From: Mehdi Achour Date: Sun, 17 Jun 2007 00:08:10 +0000 Subject: [PATCH] ref.icap: new doc style git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@237868 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/icap/functions/icap-close.xml | 40 +++- .../icap/functions/icap-create-calendar.xml | 9 +- .../icap/functions/icap-delete-calendar.xml | 9 +- .../icap/functions/icap-delete-event.xml | 36 +++- reference/icap/functions/icap-fetch-event.xml | 45 +++- reference/icap/functions/icap-list-alarms.xml | 120 +++++++---- reference/icap/functions/icap-list-events.xml | 115 +++++++---- reference/icap/functions/icap-open.xml | 62 +++++- .../icap/functions/icap-rename-calendar.xml | 9 +- reference/icap/functions/icap-reopen.xml | 49 ++++- reference/icap/functions/icap-snooze.xml | 40 +++- reference/icap/functions/icap-store-event.xml | 192 ++++++++++-------- 12 files changed, 512 insertions(+), 214 deletions(-) diff --git a/reference/icap/functions/icap-close.xml b/reference/icap/functions/icap-close.xml index 72e88b000e..41de41799a 100644 --- a/reference/icap/functions/icap-close.xml +++ b/reference/icap/functions/icap-close.xml @@ -1,15 +1,15 @@ - - + icap_close Close an ICAP stream - - Description + + + &reftitle.description; - inticap_close + boolicap_close inticap_stream intflags @@ -17,6 +17,36 @@ Closes the given icap stream. + + + &reftitle.parameters; + + + + icap_stream + + + + + + + flags + + + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + - + icap_create_calendar Create a new calendar - - Description + + + &reftitle.description; stringicap_create_calendar intstream_id @@ -17,6 +17,7 @@ &warn.undocumented.func; + - + icap_delete_calendar Delete a calendar - - Description + + + &reftitle.description; stringicap_delete_calendar intstream_id @@ -17,6 +17,7 @@ &warn.undocumented.func; + - + icap_delete_event Delete an event from an ICAP calendar - - Description + + + &reftitle.description; stringicap_delete_event intstream_id @@ -17,10 +17,38 @@ icap_delete_event deletes the calendar event specified by the uid. + + + + &reftitle.parameters; + + + + stream_id + + + + + + + uid + + + The event identifier. + + + + + + + + + &reftitle.returnvalues; Returns &true;. + - + icap_fetch_event Fetches an event from the calendar stream - - Description + + + &reftitle.description; inticap_fetch_event intstream_id @@ -18,6 +18,39 @@ icap_fetch_event fetches an event from the calendar stream specified by event_id. + + + + &reftitle.parameters; + + + + stream_id + + + + + + + event_id + + + + + + + options + + + + + + + + + + + &reftitle.returnvalues; Returns an event object consisting of: @@ -93,10 +126,12 @@ int sec - seconds - + + + - + icap_list_alarms Return a list of events that has an alarm triggered at the given datetime - - Description + + + &reftitle.description; inticap_list_alarms intstream_id arraydate arraytime + + 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. + + + + + &reftitle.parameters; + + + + stream_id + + + + + + + date + + + 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 + + + + + + + + time + + + + + + + + + + + &reftitle.returnvalues; 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_list_events Return a list of events between two given datetimes - - Description + + + &reftitle.description; arrayicap_list_events intstream_id intbegin_date intend_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. + + + + &reftitle.parameters; - 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 - - - + + + stream_id + + + + + + + begin_date + + + 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 + + + + + + + + end_date + + + See description of begin_date. + + + + + + + &reftitle.returnvalues; + + Returns an array of event ID's that are between the two given + datetimes. + + + - + icap_open Opens up an ICAP connection - - Description + + + &reftitle.description; resourceicap_open stringcalendar @@ -15,15 +15,59 @@ stringpassword stringoptions - - 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. + specified calendar store. + + + &reftitle.parameters; + + + + calendar + + + + + + + username + + + The user name. + + + + + password + + + Password associated to username. + + + + + options + + + If the optional options is specified, passes + the options to that mailbox also. + + + + + + + + + &reftitle.returnvalues; + + Returns an ICAP stream on success, &false; on error. + + + - + icap_rename_calendar Rename a calendar - - Description + + + &reftitle.description; stringicap_rename_calendar intstream_id @@ -18,6 +18,7 @@ &warn.undocumented.func; + - + icap_reopen Reopen ICAP stream to new calendar - - Description + + + &reftitle.description; - inticap_reopen + boolicap_reopen intstream_id stringcalendar intoptions - &warn.undocumented.func; + Reopens an ICAP stream to new calendar. + + + &reftitle.parameters; + + + + stream_id + + + + + + + calendar + + + + + + + options + + + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + - + icap_snooze Snooze an alarm - - Description + + + &reftitle.description; stringicap_snooze intstream_id intuid - icap_snooze turns on an alarm for a - calendar event specified by the uid. + icap_snooze turns on an alarm for a calendar event + specified by the uid. + + + + &reftitle.parameters; + + + + stream_id + + + + + + + uid + + + The calendar event. + + + + + + + + + &reftitle.returnvalues; Returns &true;. + - + icap_store_event Store an event into an ICAP calendar - - Description + + + &reftitle.description; - stringicap_store_event + boolicap_store_event intstream_id objectevent - icap_store_event Stores an event into - an ICAP calendar. An event object consists of: - - - - int public - 1 if public, 0 if 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 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_store_event stores an event into an ICAP + calendar. + + + &reftitle.parameters; + + + + stream_id + + + + + + + event + + + An event object consists of: + + + + int public - 1 if public, 0 if 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 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 + + + + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + +