mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 06:18:56 +00:00
cb7a7ec8c1
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@147966 c90b9560-bf6c-de11-be94-00142212c4b1
111 lines
4.1 KiB
XML
111 lines
4.1 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.3 $ -->
|
|
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 -->
|
|
<refentry id="function.mcal-fetch-event">
|
|
<refnamediv>
|
|
<refname>mcal_fetch_event</refname>
|
|
<refpurpose>
|
|
Fetches an event from the calendar stream
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>object</type><methodname>mcal_fetch_event</methodname>
|
|
<methodparam><type>int</type><parameter>mcal_stream</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>event_id</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>mcal_fetch_event</function> fetches an event from the
|
|
calendar stream specified by <parameter>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>
|
|
<listitem><simpara>
|
|
int recur_type - recurrence type</simpara></listitem>
|
|
<listitem><simpara>
|
|
int recur_interval - recurrence interval</simpara></listitem>
|
|
<listitem><simpara>
|
|
datetime recur_enddate - recurrence end date</simpara></listitem>
|
|
<listitem><simpara>
|
|
int recur_data - recurrence data</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>
|
|
<listitem><simpara>
|
|
int alarm - minutes before event to send an alarm</simpara></listitem>
|
|
</itemizedlist>
|
|
|
|
The possible values for recur_type are:
|
|
|
|
<itemizedlist>
|
|
<listitem><simpara>
|
|
0 - Indicates that this event does not recur</simpara></listitem>
|
|
<listitem><simpara>
|
|
1 - This event recurs daily</simpara></listitem>
|
|
<listitem><simpara>
|
|
2 - This event recurs on a weekly basis</simpara></listitem>
|
|
<listitem><simpara>
|
|
3 - This event recurs monthly on a specific day of the month (e.g. the 10th of the month)</simpara></listitem>
|
|
<listitem><simpara>
|
|
4 - This event recurs monthly on a sequenced day of the week (e.g. the 3rd Saturday) </simpara></listitem>
|
|
<listitem><simpara>
|
|
5 - This event recurs on an annual basis</simpara></listitem>
|
|
</itemizedlist></para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"../../../../manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|