cvs: phpdoc /en/reference/icap/functions icap-close.xml icap-create-calendar.xml icap-delete-calendar.xml icap-delete-event.xml icap-fetch-event.xml
icap-list-alarms.xml icap-list-events.xml icap-open.xml icap-rename-calendar.xml icap-reopen.xml icap-snooze.xml icap-store-event.xml
| From: | Mehdi Achour | Date: | Sat, 16 Jun 2007 23:59:15 +0000 |
| Subject: | cvs: phpdoc /en/reference/icap/functions icap-close.xml icap-create-calendar.xml icap-delete-calendar.xml icap-delete-event.xml icap-fetch-event.xml icap-list-alarms.xml icap-list-events.xml icap-open.xml icap-rename-calendar.xml icap-reopen.xml icap-snooze.xml icap-store-event.xml |
||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969376737@lists.php.net to get a copy of this message | ||
didou Sat Jun 16 23:59:15 2007 UTC
Modified files:
/phpdoc/en/reference/icap/functions icap-close.xml
icap-create-calendar.xml
icap-delete-calendar.xml
icap-delete-event.xml
icap-fetch-event.xml
icap-list-alarms.xml
icap-list-events.xml
icap-open.xml
icap-rename-calendar.xml
icap-reopen.xml icap-snooze.xml
icap-store-event.xml
Log:
WS, prepare for new doc style
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/icap/functions/icap-close.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/icap/functions/icap-close.xml diff -u phpdoc/en/reference/icap/functions/icap-close.xml:1.2 phpdoc/en/reference/icap/functions/icap-close.xml:1.3 --- phpdoc/en/reference/icap/functions/icap-close.xml:1.2 Wed Apr 17 06:38:52 2002 +++ phpdoc/en/reference/icap/functions/icap-close.xml Sat Jun 16 23:59:15 2007 @@ -1,23 +1,23 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/icap.xml, last change in rev 1.2 --> - <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-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> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/icap/functions/icap-create-calendar.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/icap/functions/icap-create-calendar.xml diff -u phpdoc/en/reference/icap/functions/icap-create-calendar.xml:1.2 phpdoc/en/reference/icap/functions/icap-create-calendar.xml:1.3 --- phpdoc/en/reference/icap/functions/icap-create-calendar.xml:1.2 Wed Apr 17 06:38:52 2002 +++ phpdoc/en/reference/icap/functions/icap-create-calendar.xml Sat Jun 16 23:59:15 2007 @@ -1,25 +1,23 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/icap.xml, last change in rev 1.15 --> - <refentry id='function.icap-create-calendar'> - <refnamediv> - <refname>icap_create_calendar</refname> - <refpurpose> - Create a new calendar - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>icap_create_calendar</methodname> - <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> - <methodparam><type>string</type><parameter>calendar</parameter></methodparam> - </methodsynopsis> - <para> - &warn.undocumented.func; - </para> - </refsect1> - </refentry> +<refentry id='function.icap-create-calendar'> + <refnamediv> + <refname>icap_create_calendar</refname> + <refpurpose>Create a new calendar</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>icap_create_calendar</methodname> + <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> + <methodparam><type>string</type><parameter>calendar</parameter></methodparam> + </methodsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/icap/functions/icap-delete-calendar.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/icap/functions/icap-delete-calendar.xml diff -u phpdoc/en/reference/icap/functions/icap-delete-calendar.xml:1.2 phpdoc/en/reference/icap/functions/icap-delete-calendar.xml:1.3 --- phpdoc/en/reference/icap/functions/icap-delete-calendar.xml:1.2 Wed Apr 17 06:38:52 2002 +++ phpdoc/en/reference/icap/functions/icap-delete-calendar.xml Sat Jun 16 23:59:15 2007 @@ -1,25 +1,23 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/icap.xml, last change in rev 1.15 --> - <refentry id='function.icap-delete-calendar'> - <refnamediv> - <refname>icap_delete_calendar</refname> - <refpurpose> - Delete a calendar - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>icap_delete_calendar</methodname> - <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> - <methodparam><type>string</type><parameter>calendar</parameter></methodparam> - </methodsynopsis> - <para> - &warn.undocumented.func; - </para> - </refsect1> - </refentry> +<refentry id='function.icap-delete-calendar'> + <refnamediv> + <refname>icap_delete_calendar</refname> + <refpurpose>Delete a calendar</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>icap_delete_calendar</methodname> + <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> + <methodparam><type>string</type><parameter>calendar</parameter></methodparam> + </methodsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/icap/functions/icap-delete-event.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/icap/functions/icap-delete-event.xml diff -u phpdoc/en/reference/icap/functions/icap-delete-event.xml:1.2 phpdoc/en/reference/icap/functions/icap-delete-event.xml:1.3 --- phpdoc/en/reference/icap/functions/icap-delete-event.xml:1.2 Wed Apr 17 06:38:52 2002 +++ phpdoc/en/reference/icap/functions/icap-delete-event.xml Sat Jun 16 23:59:15 2007 @@ -1,27 +1,27 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/icap.xml, last change in rev 1.2 --> - <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>stream_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-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>stream_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> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/icap/functions/icap-fetch-event.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/icap/functions/icap-fetch-event.xml diff -u phpdoc/en/reference/icap/functions/icap-fetch-event.xml:1.2 phpdoc/en/reference/icap/functions/icap-fetch-event.xml:1.3 --- phpdoc/en/reference/icap/functions/icap-fetch-event.xml:1.2 Wed Apr 17 06:38:52 2002 +++ phpdoc/en/reference/icap/functions/icap-fetch-event.xml Sat Jun 16 23:59:15 2007 @@ -1,103 +1,103 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/icap.xml, last change in rev 1.2 --> - <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-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> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/icap/functions/icap-list-alarms.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/icap/functions/icap-list-alarms.xml diff -u phpdoc/en/reference/icap/functions/icap-list-alarms.xml:1.2 phpdoc/en/reference/icap/functions/icap-list-alarms.xml:1.3 --- phpdoc/en/reference/icap/functions/icap-list-alarms.xml:1.2 Wed Apr 17 06:38:53 2002 +++ phpdoc/en/reference/icap/functions/icap-list-alarms.xml Sat Jun 16 23:59:15 2007 @@ -1,68 +1,65 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/icap.xml, last change in rev 1.15 --> - <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> +<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> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/icap/functions/icap-list-events.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/icap/functions/icap-list-events.xml diff -u phpdoc/en/reference/icap/functions/icap-list-events.xml:1.2 phpdoc/en/reference/icap/functions/icap-list-events.xml:1.3 --- phpdoc/en/reference/icap/functions/icap-list-events.xml:1.2 Wed Apr 17 06:38:53 2002 +++ phpdoc/en/reference/icap/functions/icap-list-events.xml Sat Jun 16 23:59:15 2007 @@ -1,68 +1,66 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/icap.xml, last change in rev 1.2 --> - <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-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> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/icap/functions/icap-open.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/icap/functions/icap-open.xml diff -u phpdoc/en/reference/icap/functions/icap-open.xml:1.3 phpdoc/en/reference/icap/functions/icap-open.xml:1.4 --- phpdoc/en/reference/icap/functions/icap-open.xml:1.3 Fri Aug 13 16:12:04 2004 +++ phpdoc/en/reference/icap/functions/icap-open.xml Sat Jun 16 23:59:15 2007 @@ -1,30 +1,30 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/icap.xml, last change in rev 1.2 --> - <refentry id="function.icap-open"> - <refnamediv> - <refname>icap_open</refname> - <refpurpose>Opens up an ICAP connection</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</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-open"> + <refnamediv> + <refname>icap_open</refname> + <refpurpose>Opens up an ICAP connection</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>resource</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> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/icap/functions/icap-rename-calendar.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/icap/functions/icap-rename-calendar.xml diff -u phpdoc/en/reference/icap/functions/icap-rename-calendar.xml:1.2 phpdoc/en/reference/icap/functions/icap-rename-calendar.xml:1.3 --- phpdoc/en/reference/icap/functions/icap-rename-calendar.xml:1.2 Wed Apr 17 06:38:53 2002 +++ phpdoc/en/reference/icap/functions/icap-rename-calendar.xml Sat Jun 16 23:59:15 2007 @@ -1,26 +1,24 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/icap.xml, last change in rev 1.15 --> - <refentry id='function.icap-rename-calendar'> - <refnamediv> - <refname>icap_rename_calendar</refname> - <refpurpose> - Rename a calendar - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>icap_rename_calendar</methodname> - <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> - <methodparam><type>string</type><parameter>old_name</parameter></methodparam> - <methodparam><type>string</type><parameter>new_name</parameter></methodparam> - </methodsynopsis> - <para> - &warn.undocumented.func; - </para> - </refsect1> - </refentry> +<refentry id='function.icap-rename-calendar'> + <refnamediv> + <refname>icap_rename_calendar</refname> + <refpurpose>Rename a calendar</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>icap_rename_calendar</methodname> + <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> + <methodparam><type>string</type><parameter>old_name</parameter></methodparam> + <methodparam><type>string</type><parameter>new_name</parameter></methodparam> + </methodsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/icap/functions/icap-reopen.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/icap/functions/icap-reopen.xml diff -u phpdoc/en/reference/icap/functions/icap-reopen.xml:1.2 phpdoc/en/reference/icap/functions/icap-reopen.xml:1.3 --- phpdoc/en/reference/icap/functions/icap-reopen.xml:1.2 Wed Apr 17 06:38:53 2002 +++ phpdoc/en/reference/icap/functions/icap-reopen.xml Sat Jun 16 23:59:15 2007 @@ -1,26 +1,24 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/icap.xml, last change in rev 1.2 --> - <refentry id='function.icap-reopen'> - <refnamediv> - <refname>icap_reopen</refname> - <refpurpose> - Reopen ICAP stream to new calendar - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>icap_reopen</methodname> - <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> - <methodparam><type>string</type><parameter>calendar</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> - </methodsynopsis> - <para> - &warn.undocumented.func; - </para> - </refsect1> - </refentry> +<refentry id='function.icap-reopen'> + <refnamediv> + <refname>icap_reopen</refname> + <refpurpose>Reopen ICAP stream to new calendar</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>icap_reopen</methodname> + <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> + <methodparam><type>string</type><parameter>calendar</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> + </methodsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/icap/functions/icap-snooze.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/icap/functions/icap-snooze.xml diff -u phpdoc/en/reference/icap/functions/icap-snooze.xml:1.2 phpdoc/en/reference/icap/functions/icap-snooze.xml:1.3 --- phpdoc/en/reference/icap/functions/icap-snooze.xml:1.2 Wed Apr 17 06:38:54 2002 +++ phpdoc/en/reference/icap/functions/icap-snooze.xml Sat Jun 16 23:59:15 2007 @@ -1,27 +1,27 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/icap.xml, last change in rev 1.2 --> - <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-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> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/icap/functions/icap-store-event.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/icap/functions/icap-store-event.xml diff -u phpdoc/en/reference/icap/functions/icap-store-event.xml:1.3 phpdoc/en/reference/icap/functions/icap-store-event.xml:1.4 --- phpdoc/en/reference/icap/functions/icap-store-event.xml:1.3 Wed Dec 17 14:32:25 2003 +++ phpdoc/en/reference/icap/functions/icap-store-event.xml Sat Jun 16 23:59:15 2007 @@ -1,99 +1,99 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/icap.xml, last change in rev 1.2 --> - <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 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 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-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 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 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> <!-- Keep this comment at the end of the file Local variables:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/icap/functions/icap-close.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/icap/functions/icap-close.xml diff -u phpdoc/en/reference/icap/functions/icap-close.xml:1.2 phpdoc/en/reference/icap/functions/icap-close.xml:1.3 --- phpdoc/en/reference/icap/functions/icap-close.xml:1.2 Wed Apr 17 06:38:52 2002 +++ phpdoc/en/reference/icap/functions/icap-close.xml Sat Jun 16 23:59:15 2007 @@ -1,23 +1,23 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/icap.xml, last change in rev 1.2 --> - <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-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> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/icap/functions/icap-create-calendar.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/icap/functions/icap-create-calendar.xml diff -u phpdoc/en/reference/icap/functions/icap-create-calendar.xml:1.2 phpdoc/en/reference/icap/functions/icap-create-calendar.xml:1.3 --- phpdoc/en/reference/icap/functions/icap-create-calendar.xml:1.2 Wed Apr 17 06:38:52 2002 +++ phpdoc/en/reference/icap/functions/icap-create-calendar.xml Sat Jun 16 23:59:15 2007 @@ -1,25 +1,23 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/icap.xml, last change in rev 1.15 --> - <refentry id='function.icap-create-calendar'> - <refnamediv> - <refname>icap_create_calendar</refname> - <refpurpose> - Create a new calendar - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>icap_create_calendar</methodname> - <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> - <methodparam><type>string</type><parameter>calendar</parameter></methodparam> - </methodsynopsis> - <para> - &warn.undocumented.func; - </para> - </refsect1> - </refentry> +<refentry id='function.icap-create-calendar'> + <refnamediv> + <refname>icap_create_calendar</refname> + <refpurpose>Create a new calendar</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>icap_create_calendar</methodname> + <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> + <methodparam><type>string</type><parameter>calendar</parameter></methodparam> + </methodsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/icap/functions/icap-delete-calendar.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/icap/functions/icap-delete-calendar.xml diff -u phpdoc/en/reference/icap/functions/icap-delete-calendar.xml:1.2 phpdoc/en/reference/icap/functions/icap-delete-calendar.xml:1.3 --- phpdoc/en/reference/icap/functions/icap-delete-calendar.xml:1.2 Wed Apr 17 06:38:52 2002 +++ phpdoc/en/reference/icap/functions/icap-delete-calendar.xml Sat Jun 16 23:59:15 2007 @@ -1,25 +1,23 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/icap.xml, last change in rev 1.15 --> - <refentry id='function.icap-delete-calendar'> - <refnamediv> - <refname>icap_delete_calendar</refname> - <refpurpose> - Delete a calendar - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>icap_delete_calendar</methodname> - <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> - <methodparam><type>string</type><parameter>calendar</parameter></methodparam> - </methodsynopsis> - <para> - &warn.undocumented.func; - </para> - </refsect1> - </refentry> +<refentry id='function.icap-delete-calendar'> + <refnamediv> + <refname>icap_delete_calendar</refname> + <refpurpose>Delete a calendar</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>icap_delete_calendar</methodname> + <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> + <methodparam><type>string</type><parameter>calendar</parameter></methodparam> + </methodsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/icap/functions/icap-delete-event.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/icap/functions/icap-delete-event.xml diff -u phpdoc/en/reference/icap/functions/icap-delete-event.xml:1.2 phpdoc/en/reference/icap/functions/icap-delete-event.xml:1.3 --- phpdoc/en/reference/icap/functions/icap-delete-event.xml:1.2 Wed Apr 17 06:38:52 2002 +++ phpdoc/en/reference/icap/functions/icap-delete-event.xml Sat Jun 16 23:59:15 2007 @@ -1,27 +1,27 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/icap.xml, last change in rev 1.2 --> - <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>stream_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-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>stream_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> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/icap/functions/icap-fetch-event.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/icap/functions/icap-fetch-event.xml diff -u phpdoc/en/reference/icap/functions/icap-fetch-event.xml:1.2 phpdoc/en/reference/icap/functions/icap-fetch-event.xml:1.3 --- phpdoc/en/reference/icap/functions/icap-fetch-event.xml:1.2 Wed Apr 17 06:38:52 2002 +++ phpdoc/en/reference/icap/functions/icap-fetch-event.xml Sat Jun 16 23:59:15 2007 @@ -1,103 +1,103 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/icap.xml, last change in rev 1.2 --> - <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-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> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/icap/functions/icap-list-alarms.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/icap/functions/icap-list-alarms.xml diff -u phpdoc/en/reference/icap/functions/icap-list-alarms.xml:1.2 phpdoc/en/reference/icap/functions/icap-list-alarms.xml:1.3 --- phpdoc/en/reference/icap/functions/icap-list-alarms.xml:1.2 Wed Apr 17 06:38:53 2002 +++ phpdoc/en/reference/icap/functions/icap-list-alarms.xml Sat Jun 16 23:59:15 2007 @@ -1,68 +1,65 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/icap.xml, last change in rev 1.15 --> - <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> +<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> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/icap/functions/icap-list-events.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/icap/functions/icap-list-events.xml diff -u phpdoc/en/reference/icap/functions/icap-list-events.xml:1.2 phpdoc/en/reference/icap/functions/icap-list-events.xml:1.3 --- phpdoc/en/reference/icap/functions/icap-list-events.xml:1.2 Wed Apr 17 06:38:53 2002 +++ phpdoc/en/reference/icap/functions/icap-list-events.xml Sat Jun 16 23:59:15 2007 @@ -1,68 +1,66 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/icap.xml, last change in rev 1.2 --> - <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-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> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/icap/functions/icap-open.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/icap/functions/icap-open.xml diff -u phpdoc/en/reference/icap/functions/icap-open.xml:1.3 phpdoc/en/reference/icap/functions/icap-open.xml:1.4 --- phpdoc/en/reference/icap/functions/icap-open.xml:1.3 Fri Aug 13 16:12:04 2004 +++ phpdoc/en/reference/icap/functions/icap-open.xml Sat Jun 16 23:59:15 2007 @@ -1,30 +1,30 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/icap.xml, last change in rev 1.2 --> - <refentry id="function.icap-open"> - <refnamediv> - <refname>icap_open</refname> - <refpurpose>Opens up an ICAP connection</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</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-open"> + <refnamediv> + <refname>icap_open</refname> + <refpurpose>Opens up an ICAP connection</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>resource</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> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/icap/functions/icap-rename-calendar.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/icap/functions/icap-rename-calendar.xml diff -u phpdoc/en/reference/icap/functions/icap-rename-calendar.xml:1.2 phpdoc/en/reference/icap/functions/icap-rename-calendar.xml:1.3 --- phpdoc/en/reference/icap/functions/icap-rename-calendar.xml:1.2 Wed Apr 17 06:38:53 2002 +++ phpdoc/en/reference/icap/functions/icap-rename-calendar.xml Sat Jun 16 23:59:15 2007 @@ -1,26 +1,24 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/icap.xml, last change in rev 1.15 --> - <refentry id='function.icap-rename-calendar'> - <refnamediv> - <refname>icap_rename_calendar</refname> - <refpurpose> - Rename a calendar - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>icap_rename_calendar</methodname> - <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> - <methodparam><type>string</type><parameter>old_name</parameter></methodparam> - <methodparam><type>string</type><parameter>new_name</parameter></methodparam> - </methodsynopsis> - <para> - &warn.undocumented.func; - </para> - </refsect1> - </refentry> +<refentry id='function.icap-rename-calendar'> + <refnamediv> + <refname>icap_rename_calendar</refname> + <refpurpose>Rename a calendar</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>icap_rename_calendar</methodname> + <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> + <methodparam><type>string</type><parameter>old_name</parameter></methodparam> + <methodparam><type>string</type><parameter>new_name</parameter></methodparam> + </methodsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/icap/functions/icap-reopen.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/icap/functions/icap-reopen.xml diff -u phpdoc/en/reference/icap/functions/icap-reopen.xml:1.2 phpdoc/en/reference/icap/functions/icap-reopen.xml:1.3 --- phpdoc/en/reference/icap/functions/icap-reopen.xml:1.2 Wed Apr 17 06:38:53 2002 +++ phpdoc/en/reference/icap/functions/icap-reopen.xml Sat Jun 16 23:59:15 2007 @@ -1,26 +1,24 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/icap.xml, last change in rev 1.2 --> - <refentry id='function.icap-reopen'> - <refnamediv> - <refname>icap_reopen</refname> - <refpurpose> - Reopen ICAP stream to new calendar - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>icap_reopen</methodname> - <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> - <methodparam><type>string</type><parameter>calendar</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> - </methodsynopsis> - <para> - &warn.undocumented.func; - </para> - </refsect1> - </refentry> +<refentry id='function.icap-reopen'> + <refnamediv> + <refname>icap_reopen</refname> + <refpurpose>Reopen ICAP stream to new calendar</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>icap_reopen</methodname> + <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> + <methodparam><type>string</type><parameter>calendar</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam> + </methodsynopsis> + <para> + &warn.undocumented.func; + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/icap/functions/icap-snooze.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/icap/functions/icap-snooze.xml diff -u phpdoc/en/reference/icap/functions/icap-snooze.xml:1.2 phpdoc/en/reference/icap/functions/icap-snooze.xml:1.3 --- phpdoc/en/reference/icap/functions/icap-snooze.xml:1.2 Wed Apr 17 06:38:54 2002 +++ phpdoc/en/reference/icap/functions/icap-snooze.xml Sat Jun 16 23:59:15 2007 @@ -1,27 +1,27 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/icap.xml, last change in rev 1.2 --> - <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-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> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/icap/functions/icap-store-event.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/icap/functions/icap-store-event.xml diff -u phpdoc/en/reference/icap/functions/icap-store-event.xml:1.3 phpdoc/en/reference/icap/functions/icap-store-event.xml:1.4 --- phpdoc/en/reference/icap/functions/icap-store-event.xml:1.3 Wed Dec 17 14:32:25 2003 +++ phpdoc/en/reference/icap/functions/icap-store-event.xml Sat Jun 16 23:59:15 2007 @@ -1,99 +1,99 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/icap.xml, last change in rev 1.2 --> - <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 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 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-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 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 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> <!-- Keep this comment at the end of the file Local variables: