mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
WS, prepare for new doc style
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@237863 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour
parent
933a8287e5
commit
c281e03547
12 changed files with 474 additions and 487 deletions
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
Loading…
Reference in a new issue