cvs: phpdoc /fr/functions mcal.xml
| From: | Damien Seguy | Date: | Wed, 22 Nov 2000 17:20:22 +0000 |
| Subject: | cvs: phpdoc /fr/functions mcal.xml | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969333030@lists.php.net to get a copy of this message | ||
dams Wed Nov 22 09:20:22 2000 EDT
Modified files:
/phpdoc/fr/functions mcal.xml
Log:
Added functions about calendars and options.
Index: phpdoc/fr/functions/mcal.xml diff -u phpdoc/fr/functions/mcal.xml:1.1 phpdoc/fr/functions/mcal.xml:1.2 --- phpdoc/fr/functions/mcal.xml:1.1 Fri Jul 21 03:27:50 2000 +++ phpdoc/fr/functions/mcal.xml Wed Nov 22 09:20:22 2000 @@ -1,1020 +1,1215 @@ - <reference id="ref.mcal"> - <title>Fonctions MCAL</title> - <titleabbrev>MCAL</titleabbrev> - - <partintro> - <para> - MCAL signifie Modular Calendar Access Library (librairie calendaire modulaire). - </para> - - <para> - Libmcal est une librairie C de calendriers. Elle est écrite pour être très - modulaire, et dispose de nombreux modules. MCAL est l'équivalent de IMAP pour les - calendriers. - </para> - - <para> - Avec mcal, un calendrier peut être ouvert comme une boîte aux lettres. Les - calendriers peuvent être des fichiers locaux, ou bien être sur des serveurs ICAP - distants, ou encore tout autre format supporté par la librairie. - </para> - - <para> - Les événements peuvent être lus, selectionnés et enregistrés. Il y a aussi la - possibilité d'ajouter des alarmes, et de placer des événéments récurents. - </para> - - <para> - Avec libmcal, les serveurs centralisés peuvent être accédés et utilisés, et - remplacent avantageusement tout développement spécifique de base de données. - </para> - - <para> - Pour faire fonctionner cette librairie, vous devez compiler PHP avec l'option - <option role="configure">--with-mcal</option>. Il vous faudra alors avoir installé - la librairie mcal. Téléchargez la dernière version à - <ulink url="http://mcal.chek.com/">http://mcal.chek.com/</ulink> et compilez la, - puis installez la. - </para> - - <para> - Les constantes suivantes sont définies lorsque mcal est utilisée : - - MCAL_SUNDAY, - MCAL_MONDAY, - MCAL_TUESDAY, - MCAL_WEDNESDAY, - MCAL_THURSDAY, - MCAL_FRIDAY, - MCAL_SATURDAY, - - MCAL_RECUR_NONE, - MCAL_RECUR_DAILY, - MCAL_RECUR_WEEKLY, - MCAL_RECUR_MONTHLY_MDAY, - MCAL_RECUR_MONTHLY_WDAY, - MCAL_RECUR_YEARLY, - - MCAL_JANUARY, - MCAL_FEBRUARY, - MCAL_MARCH, - MCAL_APRIL, - MCAL_MAY, - MCAL_JUNE, - MCAL_JULY, - MCAL_AUGUGT, - MCAL_SEPTEMBER, - MCAL_OCTOBER, - MCAL_NOVEMBER, et - MCAL_DECEMBER. - - La plus part des fonctions utilisent une structure d'événement interne, qui est - unique pour chaque connexion. Cela évite d'avoir à passer des objets de grande - taille entre les fonctions. Il y a des accesseurs bien pratiques pour créer, - initialiser et lire des objets événements. - </para> - </partintro> - - <refentry id="function.mcal-open"> - <refnamediv> - <refname>mcal_open</refname> - <refpurpose>Ouvre une connexion MCAL.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_open</function></funcdef> - <paramdef>string <parameter>calendar</parameter></paramdef> - <paramdef>string <parameter>username</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - <paramdef>string <parameter>options</parameter></paramdef> - </funcsynopsis> - <para> - Retourne un flot MCAL en cas de succès, et FALSE en cas d'erreur.</para> - <para> - <function>mcal_open</function> ouvre une connexion MCAL au serveur - <parameter>calendar</parameter>. Si <parameter>options</parameter> est spécifié, - passe aussi <parameter>options</parameter> à la boîte aux lettres (???). - La structure interne du flot MCAL est initialisée à la connnexion. - </para> - </refsect1> - </refentry> - - - <refentry id="function.mcal-close"> - <refnamediv> - <refname>mcal_close</refname> - <refpurpose>Ferme une connexion MCAL.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_close</function></funcdef> - <paramdef>int <parameter>mcal_stream</parameter></paramdef> - <paramdef>int <parameter>flags</parameter></paramdef> - </funcsynopsis> - <para> - Ferme la connexion. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-fetch-event"> - <refnamediv> - <refname>mcal_fetch_event</refname> - <refpurpose> - Recherche un événement dans le calendrier. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>object <function>mcal_fetch_event</function></funcdef> - <paramdef>int <parameter>mcal_stream</parameter></paramdef> - <paramdef>int <parameter>event_id</parameter></paramdef> - <paramdef>int <parameter><optional>options</optional></parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_fetch_event</function> recherche un évenement dans le calendrier - spécifié par <parameter>id</parameter>. - </para> - <para> - Retourne un objet événement dont les attributs sont : - - <itemizedlist> - <listitem><simpara> - int id - ID de l'événement.</simpara></listitem> - <listitem><simpara> - int public - TRUE si l'événement est public, FALSE si il est privé.</simpara></listitem> - <listitem><simpara> - string category - Catégorie de l'événement.</simpara></listitem> - <listitem><simpara> - string title - Titre de l'événement.</simpara></listitem> - <listitem><simpara> - string description - Description de l'événement.</simpara></listitem> - <listitem><simpara> - int alarm - Nombre de minutes avant d'envoyer une alerte pour cet événement.</simpara></listitem> - <listitem><simpara> - object start - Objet contenant une date et une heure.</simpara></listitem> - <listitem><simpara> - object end - Objet contenant une date et une heure.</simpara></listitem> - <listitem><simpara> - int recur_type - type de récurence</simpara></listitem> - <listitem><simpara> - int recur_interval - intervalle de récurence</simpara></listitem> - <listitem><simpara> - datetime recur_endate - date de fin de récurence</simpara></listitem> - <listitem><simpara> - int recur_data - données de récurence</simpara></listitem> - </itemizedlist> - - Tous les objets de date et heure sont construits comme suit : - - <itemizedlist> - <listitem><simpara> - int year - année</simpara></listitem> - <listitem><simpara> - int month - mois</simpara></listitem> - <listitem><simpara> - int mday - jour du mois</simpara></listitem> - <listitem><simpara> - int hour - heure</simpara></listitem> - <listitem><simpara> - int min - minutes</simpara></listitem> - <listitem><simpara> - int sec - secondes</simpara></listitem> - <listitem><simpara> - int alarm - nombre de minutes avant de déclencher l'alarme</simpara></listitem> - </itemizedlist></para> - </refsect1> - </refentry> - - - <refentry id="function.mcal-list-events"> - <refnamediv> - <refname>mcal_list_events</refname> - <refpurpose> - Retourne une liste d'événement entre deux dates. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>mcal_list_events</function></funcdef> - <paramdef>int <parameter>mcal_stream</parameter></paramdef> - <paramdef>int - <parameter><optional>begin_year</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>begin_month</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>begin_day</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>end_year</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>end_month</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>end_day</optional></parameter> - </paramdef> - </funcsynopsis> - <para> - Retourne un tableau d'identifiants d'événéments, compris entre deux dates. - </para> - <para> - <function>mcal_list_events</function> prend une date de début et une date - de fin. Un tableau d'identifiants est retourné. - </para> - </refsect1> - </refentry> - - - <refentry id="function.mcal-append-event"> - <refnamediv> - <refname>mcal_append_event</refname> - <refpurpose>Enregistre un nouvel événement dans un calendrier MCAL.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_append_event</function></funcdef> - <paramdef>int <parameter>mcal_stream</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_append_event</function> enregistre l'événement global - dans le calendrier MCAL <parameter>mcal_stream</parameter>. - </para> - <para> - Retourne l'uid de l'enregistement ainsi inséré. - </para> - </refsect1> - </refentry> - - - <refentry id="function.mcal-store-event"> - <refnamediv> - <refname>mcal_store_event</refname> - <refpurpose>Modifie un événement dans un calendrier MCAL.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_store_event</function></funcdef> - <paramdef>int <parameter>mcal_stream</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_store_event</function> enregistre l'événement global dans le - calendrier MCAL <parameter>mcal_stream</parameter>. - </para> - <para> - Retourne TRUE en cas de succès, et FALSE en cas d'erreur. - </para> - </refsect1> - </refentry> - - - <refentry id="function.mcal-delete-event"> - <refnamediv> - <refname>mcal_delete_event</refname> - <refpurpose>Efface un événement dans un calendrier MCAL.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_delete_event</function></funcdef> - <paramdef>int <parameter>uid</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_delete_event</function> efface l'événement d'identifiant - <parameter>uid</parameter>. - </para> - <para> - Retourne TRUE. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-snooze"> - <refnamediv> - <refname>mcal_snooze</refname> - <refpurpose>Eteind l'alarme d'un événement.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_snooze</function></funcdef> - <paramdef>int <parameter>uid</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_snooze</function> éteind l'alarme de l'événement identifié par - l'UID <parameter>uid</parameter>. - </para> - <para> - Retourne TRUE. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-list-alarms"> - <refnamediv> - <refname>mcal_list_alarms</refname> - <refpurpose> - Retourne une liste d'événements qui ont une alarme prévue à une date. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>mcal_list_events</function></funcdef> - <paramdef>int <parameter>mcal_stream</parameter></paramdef> - <paramdef>int - <parameter><optional>begin_year</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>begin_month</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>begin_day</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>end_year</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>end_month</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>end_day</optional></parameter> - </paramdef> - </funcsynopsis> - <para> - Retourne un tableau d'identifiants, qui ont une alarme de prévue à la date - <parameter>alarm_date</parameter>. Si seul le flot MCAL est donné, la date de - début et de fin de la structure globale sera utilisée. - </para> - <para> - <function>mcal_list_events</function> prend une date, et retourne un tableau - d'identifiants. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-event-init"> - <refnamediv> - <refname>mcal_event_init</refname> - <refpurpose> - Initialise la structure globale d'un flot. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_event_init</function></funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_event_init</function> initialise la structure globale d'un flot. - Cela remet tous les éléments de la structure à 0, ou à leur valeur par défaut. - </para> - <para> - Retourne TRUE. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-event-set-category"> - <refnamediv> - <refname>mcal_event_set_category</refname> - <refpurpose> - Fixe la catégorie de la structure globale. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_event_set_category</function></funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>string <parameter>category</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_event_set_category</function> fixe la catégorie de la structure - globale à la valeur de <parameter>category</parameter>. - </para> - <para> - Retourne TRUE. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-event-set-title"> - <refnamediv> - <refname>mcal_event_set_title</refname> - <refpurpose> - fixe le titre de la structure globale. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_event_set_title</function></funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>string <parameter>title</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_event_set_title</function> fixe le titre de la structure globale à - la valeur de <parameter>title</parameter>. - </para> - <para> - Retourne TRUE. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-event-set-description"> - <refnamediv> - <refname>mcal_event_set_description</refname> - <refpurpose> - Fixe la déscription de la structure globale. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>mcal_event_set_description</function> - </funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>string <parameter>description</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_event_set_description</function> fixe la catégorie de la structure - globale à la valeur de <parameter>description</parameter>. - </para> - <para> - Returns TRUE. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-event-set-start"> - <refnamediv> - <refname>mcal_event_set_start</refname> - <refpurpose> - Fixe les dates de début et de fin de la structure globale. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_event_set_start</function></funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int - <parameter> - <optional>day</optional> - </parameter> - </paramdef> - <paramdef>int - <parameter> - <optional>hour</optional> - </parameter> - </paramdef> - <paramdef>int - <parameter> - <optional>min</optional></parameter> - </paramdef> - <paramdef>int - <parameter> - <optional>sec</optional> - </parameter> - </paramdef> - </funcsynopsis> - <para> - <function>mcal_event_set_start</function> fixe la date de début de la structure - globale. - </para> - <para> - Retourne TRUE. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-event-set-end"> - <refnamediv> - <refname>mcal_event_set_end</refname> - <refpurpose> - Fixe la date de fin de la structure globale. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_event_set_end</function></funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int - <parameter> - <optional>day</optional> - </parameter> - </paramdef> - <paramdef>int - <parameter> - <optional>hour</optional> - </parameter> - </paramdef> - <paramdef>int - <parameter> - <optional>min</optional> - </parameter> - </paramdef> - <paramdef>int - <parameter> - <optional>sec</optional> - </parameter> - </paramdef> - </funcsynopsis> - <para> - <function>mcal_event_set_end</function> fixe la date de fin de la structure - globale. - </para> - <para> - Returns TRUE. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-event-set-alarm"> - <refnamediv> - <refname>mcal_event_set_alarm</refname> - <refpurpose> - Fixe l'alarme de la structure globale. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_event_set_alarm</function></funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>alarm</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_event_set_alarm</function> fixe l'alarme de la structure globale, - à un nombre de minutes avant déclenchement. - </para> - <para> - Retourne TRUE. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-event-set-class"> - <refnamediv> - <refname>mcal_event_set_class</refname> - <refpurpose> - Fixe la classe de la structure globale. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_event_set_class</function></funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>class</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_event_set_class</function> Fixe la classe de la structure globale. - La classe vaut 0 pour public, et 1 pour privée. - </para> - <para> - Retourne TRUE. - </para> - </refsect1> - </refentry> - - - <refentry id="function.mcal-is-leap-year"> - <refnamediv> - <refname>mcal_is_leap_year</refname> - <refpurpose> - Vérifie que l'année est bissextile. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_is_leap_year</function></funcdef> - <paramdef>int <parameter>year</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_is_leap_year</function> retoune 1 si l'année - <parameter>year</parameter> est bissextile, et 0 sinon. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-days-in-month"> - <refnamediv> - <refname>mcal_days_in_month</refname> - <refpurpose> - Retourne le nombre de jour d'un mois. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_days_in_month</function></funcdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>leap year</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_days_in_month</function> retourne le nombre de jour du mois - <parameter>month</parameter>, et prend en compte le fait que l'année est - bissextile avec le paramètre <parameter>leap year</parameter>. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-date-valid"> - <refnamediv> - <refname>mcal_date_valid</refname> - <refpurpose> - Valide une date. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_date_valid</function></funcdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_date_valid</function> retourne TRUE si la date (constituée par - l'année <parameter>year</parameter>, le mois <parameter>month</parameter> et la - date <parameter>day</parameter>) est valide, et FALSE sinon. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-time-valid"> - <refnamediv> - <refname>mcal_time_valid</refname> - <refpurpose> - Valide une heure. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_time_valid</function></funcdef> - <paramdef>int <parameter>hour</parameter></paramdef> - <paramdef>int <parameter>minutes</parameter></paramdef> - <paramdef>int <parameter>seconds</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_time_valid</function> retourne TRUE si l'heure (constituée par - l'heure <parameter>hour</parameter>, les minutes <parameter>minutes</parameter> - et les secondes <parameter>seconds</parameter>) est une heure valide, et FALSE - sinon. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-day-of-week"> - <refnamediv> - <refname>mcal_day_of_week</refname> - <refpurpose> - Le jour de la semaine. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_day_of_week</function></funcdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_day_of_week</function> retourne le jour de la semaine, pour la date - constituée par l'année <parameter>year</parameter>, le mois - <parameter>month</parameter> et la date <parameter>day</parameter>. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-day-of-year"> - <refnamediv> - <refname>mcal_day_of_year</refname> - <refpurpose> - Le jour de l'année. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_day_of_year</function></funcdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_day_of_year</function> retourne le numéro de jour dans l'année pour - la date constituée par l'année <parameter>year</parameter>, le mois - <parameter>month</parameter> et la date <parameter>day</parameter>. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-date-compare"> - <refnamediv> - <refname>mcal_date_compare</refname> - <refpurpose>Compare deux dates.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_date_compare</function></funcdef> - <paramdef>int <parameter>a_year</parameter></paramdef> - <paramdef>int <parameter>a_month</parameter></paramdef> - <paramdef>int <parameter>a_day</parameter></paramdef> - <paramdef>int <parameter>b_year</parameter></paramdef> - <paramdef>int <parameter>b_month</parameter></paramdef> - <paramdef>int <parameter>b_day</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_date_compare</function> compares les deux dates données, - et retourne <0, 0, >0 si a<b, a==b, a>b respectivement. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-next-recurrence"> - <refnamediv> - <refname>mcal_next_recurrence</refname> - <refpurpose>Retourne la prochaine occurence d'une événement.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_next_recurrence</function></funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>weekstart</parameter></paramdef> - <paramdef>array <parameter>next</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_next_recurrence</function> retourne un objet contenant la prochaine - date de l'événement, ou la date de l'événement suivant la date. - Retourne un objet date vide si l'événement n'a pas de réoccurence, ou si - quelquechose est invalide. Utilisez <parameter>weekstart</parameter> pour - déterminer le premier jour. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-event-set-recur-none"> - <refnamediv> - <refname>mcal_event_set_recur_none</refname> - <refpurpose> - Supprime la récurence de la structure globale. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>mcal_event_set_recur_none</function> - </funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_event_set_recur_none</function> supprime la récurence de la - structure globale (event->recur_type est mis à MCAL_RECUR_NONE). - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-event-set-recur-daily"> - <refnamediv> - <refname>mcal_event_set_recur_daily</refname> - <refpurpose> - Fixe la récurence quotidienne. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>mcal_event_set_recur_daily</function> - </funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - <paramdef>int <parameter>interval</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_event_set_recur_daily</function> fixe la récurence quotidienne de - la structure globale, jusqu'à la date passée en paramètre. (la date de début est - celle de la structure). - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-event-set-recur-weekly"> - <refnamediv> - <refname>mcal_event_set_recur_weekly</refname> - <refpurpose> - Fixe la récurence hedbomadaire. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>mcal_event_set_recur_weekly</function> - </funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - <paramdef>int <parameter>interval</parameter></paramdef> - <paramdef>int <parameter>weekdays</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_event_set_recur_weekly</function> fixe la récurence hedbomadaire de - la structure globale, jusqu'à la date passée en paramètre. (la date de début est - celle de la structure). - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-event-set-recur-monthly-mday"> - <refnamediv> - <refname>mcal_event_set_recur_monthly_mday</refname> - <refpurpose> - Fixe la récurence. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>mcal_event_set_recur_monthly_mday</function> - </funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - <paramdef>int <parameter>interval</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_event_set_recur_monthly_mday</function> fixe la récurence de - la structure globale, jusqu'à la date passée en paramètre. (la date de début est - celle de la structure). - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-event-set-recur-monthly-wday"> - <refnamediv> - <refname>mcal_event_set_recur_monthly_wday</refname> - <refpurpose> - fixe la récurence mensuelle. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>mcal_event_set_recur_monthly_wday</function> - </funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - <paramdef>int <parameter>interval</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_event_set_recur_monthly_wday</function> fixe la récurence mensuelle - de la structure globale, jusqu'à la date passée en paramètre. (la date de début - est celle de la structure). - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-event-set-recur-yearly"> - <refnamediv> - <refname>mcal_event_set_recur_yearly</refname> - <refpurpose> - fixe la récurence annuelle. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>mcal_event_set_recur_yearly</function> - </funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - <paramdef>int <parameter>interval</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_event_set_recur_yearly</function> fixe la récurence annuelle de la - structure globale, jusqu'à la date passée en paramètre. (la date de début est - celle de la structure). - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-fetch-current-stream-event"> - <refnamediv> - <refname>mcal_fetch_current_stream_event</refname> - <refpurpose> - Retourne un objet contenant la structure de date pour le flot courant. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>mcal_fetch_current_stream_event</function> - </funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_fetch_current_stream_event</function> retourne la structure de la - date du flot courant sous la forme d'un objet, qui contient : - - <itemizedlist> - <listitem><simpara> - int id - ID de l'événement.</simpara></listitem> - <listitem><simpara> - int public - TRUE si l'événement est public, FALSE si il est privé.</simpara></listitem> - <listitem><simpara> - string category - Catégorie de l'événement.</simpara></listitem> - <listitem><simpara> - string title - Titre de l'événement.</simpara></listitem> - <listitem><simpara> - string description - Description de l'événement.</simpara></listitem> - <listitem><simpara> - int alarm - Nombre de minutes avant d'envoyer une alerte pour cet événement.</simpara></listitem> - <listitem><simpara> - object start - Objet contenant une date et une heure.</simpara></listitem> - <listitem><simpara> - object end - Objet contenant une date et une heure.</simpara></listitem> - <listitem><simpara> - int recur_type - type de récurence</simpara></listitem> - <listitem><simpara> - int recur_interval - intervalle de récurence</simpara></listitem> - <listitem><simpara> - datetime recur_endate - date de fin de récurence</simpara></listitem> - <listitem><simpara> - int recur_data - données de récurence</simpara></listitem> - </itemizedlist> - - Tous les objets de date et heure sont construits comme suit : - - <itemizedlist> - <listitem><simpara> - int year - année</simpara></listitem> - <listitem><simpara> - int month - mois</simpara></listitem> - <listitem><simpara> - int mday - jour du mois</simpara></listitem> - <listitem><simpara> - int hour - heure</simpara></listitem> - <listitem><simpara> - int min - minutes</simpara></listitem> - <listitem><simpara> - int sec - secondes</simpara></listitem> - <listitem><simpara> - int alarm - nombre de minutes avant de déclencher l'alarme</simpara></listitem> - </itemizedlist></para> - </refsect1> - </refentry> -</reference> -<!-- 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 -sgml-parent-document:nil -sgml-default-dtd-file:"../manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: ---> + <reference id="ref.mcal"> + <title>Fonctions MCAL</title> + <titleabbrev>MCAL</titleabbrev> + <partintro> + <para> + MCAL signifie Modular Calendar Access Library (librairie calendaire modulaire). + </para> + <para> + Libmcal est une librairie C de calendriers. Elle est écrite + pour être très modulaire, et dispose de nombreux modules. + MCAL est l'équivalent de IMAP pour les calendriers. + </para> + <para> + Avec mcal, un calendrier peut être ouvert comme une boîte + aux lettres. Les calendriers peuvent être des fichiers locaux, + ou bien être sur des serveurs ICAP distants, ou encore tout + autre format supporté par la librairie. + </para> + <para> + Les événements peuvent être lus, selectionnés + et enregistrés. Il y a aussi la possibilité d'ajouter des + alarmes, et de placer des événéments récurents. + </para> + <para> + Avec libmcal, les serveurs centralisés peuvent être + accédés et utilisés, et remplacent avantageusement + tout développement spécifique de base de données. + </para> + <para> + Pour faire fonctionner cette librairie, vous devez compiler PHP avec + l'option <option role="configure">--with-mcal</option>. Il vous faudra + alors avoir installé la librairie mcal. Téléchargez + la dernière version à + <ulink url="&url.mcal;">&url.mcal;</ulink> et compilez la, puis installez la. + </para> + <para> + Les constantes suivantes sont définies lorsque mcal est utilisée : + MCAL_SUNDAY, + MCAL_MONDAY, + MCAL_TUESDAY, + MCAL_WEDNESDAY, + MCAL_THURSDAY, + MCAL_FRIDAY, + MCAL_SATURDAY, + MCAL_RECUR_NONE, + MCAL_RECUR_DAILY, + MCAL_RECUR_WEEKLY, + MCAL_RECUR_MONTHLY_MDAY, + MCAL_RECUR_MONTHLY_WDAY, + MCAL_RECUR_YEARLY, + MCAL_JANUARY, + MCAL_FEBRUARY, + MCAL_MARCH, + MCAL_APRIL, + MCAL_MAY, + MCAL_JUNE, + MCAL_JULY, + MCAL_AUGUGT, + MCAL_SEPTEMBER, + MCAL_OCTOBER, + MCAL_NOVEMBER, et + MCAL_DECEMBER. + La plus part des fonctions utilisent une structure d'événement + interne, qui est unique pour chaque connexion. Cela évite + d'avoir à passer des objets de grande taille entre les + fonctions. Il y a des accesseurs bien pratiques pour créer, + initialiser et lire des objets événements. + </para> + </partintro> + <refentry id="function.mcal-open"> + <refnamediv> + <refname>mcal_open</refname> + <refpurpose>Ouvre une connexion MCAL.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_open</function></funcdef> + <paramdef>string <parameter>calendar</parameter></paramdef> + <paramdef>string <parameter>username</parameter></paramdef> + <paramdef>string <parameter>password</parameter></paramdef> + <paramdef>int <parameter>options</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Retourne un flot MCAL en cas de succès, et FALSE en cas d'erreur. + </para> + <para> + <function>mcal_open</function> ouvre une connexion MCAL au serveur + <parameter>calendar</parameter>. Si <parameter>options</parameter> + est spécifié, passe aussi <parameter>options</parameter> + à la boîte aux lettres (???). La structure interne du + flot MCAL est initialisée à la connnexion. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-popen"> + <refnamediv> + <refname>mcal_popen</refname> + <refpurpose>Ouvre une connexion persistante MCAL.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_popen</function></funcdef> + <paramdef>string <parameter>calendar</parameter></paramdef> + <paramdef>string <parameter>username</parameter></paramdef> + <paramdef>string <parameter>password</parameter></paramdef> + <paramdef>int <parameter>options</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Retourne un flot MCAL en cas de succès, et FALSE sinon. + </para> + <para> + <function>mcal_popen</function> ouvre une connexion MCAL au serveur + de calendrier <parameter>calendar</parameter>. Si les options + <parameter>options</parameter> sont spécifiées, elles sont aussi + passé à cette boîte au lettre. La structure interne du + flot est aussi initialisée. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-reopen"> + <refnamediv> + <refname>mcal_reopen</refname> + <refpurpose>Réouvre une connexion MCAL</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_reopen</function></funcdef> + <paramdef>string <parameter>calendar</parameter></paramdef> + <paramdef>int <parameter>options</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Réouvre une connexion MCAL. + </para> + <para> + <function>mcal_reopen</function> réouvre une connexion + MCAL avec le serveur <parameter>calendar</parameter>. Si les options + <parameter>options</parameter> sont spécifiées, elles sont aussi + passé à cette boîte au lettre. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-close"> + <refnamediv> + <refname>mcal_close</refname> + <refpurpose>Ferme une connexion MCAL.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_close</function></funcdef> + <paramdef>int <parameter>mcal_stream</parameter></paramdef> + <paramdef>int <parameter>flags</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Ferme la connexion. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-create-calendar"> + <refnamediv> + <refname>mcal_create_calendar</refname> + <refpurpose>Crée un nouveau calendrier</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>stream</function></funcdef> + <paramdef>string <parameter>calendar</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Crée un nouveau calendrier nommé <parameter>calendar</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-rename-calendar"> + <refnamediv> + <refname>mcal_rename_calendar</refname> + <refpurpose>Renomme un calendrier</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>stream</function></funcdef> + <paramdef>string <parameter>old_name</parameter></paramdef> + <paramdef>string <parameter>new_name</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>stream</function> renomme le calendrier + <parameter>old_name</parameter> en <parameter>new_name</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-delete-calendar"> + <refnamediv> + <refname>mcal_delete_calendar</refname> + <refpurpose>Efface un calendrier</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>stream</function></funcdef> + <paramdef>string <parameter>calendar</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>stream</function> efface le calendrier <parameter>calendar</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-fetch-event"> + <refnamediv> + <refname>mcal_fetch_event</refname> + <refpurpose> + Recherche un événement dans le calendrier. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>object <function>mcal_fetch_event</function></funcdef> + <paramdef>int <parameter>mcal_stream</parameter></paramdef> + <paramdef>int <parameter>event_id</parameter></paramdef> + <paramdef>int <parameter><optional>options</optional></parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_fetch_event</function> recherche un + évenement dans le calendrier spécifié + par <parameter>id</parameter>. + </para> + <para> + Retourne un objet événement dont les attributs sont : + <itemizedlist> + <listitem><simpara> + int id - ID de l'événement.</simpara></listitem> + <listitem><simpara> + int public - TRUE si l'événement est public, FALSE si il est privé.</simpara></listitem> + <listitem><simpara> + string category - Catégorie de l'événement.</simpara></listitem> + <listitem><simpara> + string title - Titre de l'événement.</simpara></listitem> + <listitem><simpara> + string description - Description de l'événement.</simpara></listitem> + <listitem><simpara> + int alarm - Nombre de minutes avant d'envoyer une alerte pour cet événement.</simpara></listitem> + <listitem><simpara> + object start - Objet contenant une date et une heure.</simpara></listitem> + <listitem><simpara> + object end - Objet contenant une date et une heure.</simpara></listitem> + <listitem><simpara> + int recur_type - type de récurence</simpara></listitem> + <listitem><simpara> + int recur_interval - intervalle de récurence</simpara></listitem> + <listitem><simpara> + datetime recur_endate - date de fin de récurence</simpara></listitem> + <listitem><simpara> + int recur_data - données de récurence</simpara></listitem> + </itemizedlist> + Tous les objets de date et heure sont construits comme suit : + <itemizedlist> + <listitem><simpara> + int year - année</simpara></listitem> + <listitem><simpara> + int month - mois</simpara></listitem> + <listitem><simpara> + int mday - jour du mois</simpara></listitem> + <listitem><simpara> + int hour - heure</simpara></listitem> + <listitem><simpara> + int min - minutes</simpara></listitem> + <listitem><simpara> + int sec - secondes</simpara></listitem> + <listitem><simpara> + int alarm - nombre de minutes avant de déclencher l'alarme</simpara></listitem> + </itemizedlist> + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-list-events"> + <refnamediv> + <refname>mcal_list_events</refname> + <refpurpose> + Retourne une liste d'événement entre deux dates. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>mcal_list_events</function></funcdef> + <paramdef>int <parameter>mcal_stream</parameter></paramdef> + <paramdef>object<parameter>begin_date</parameter></paramdef> + <paramdef>object + <parameter><optional>end_date</optional></parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_list_events</function> retourne un tableau + d'identifiants d'événéments, compris + entre deux dates. + </para> + <para> + <function>mcal_list_events</function> prend une date de + début et une date de fin. Un tableau d'identifiants + est retourné. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-append-event"> + <refnamediv> + <refname>mcal_append_event</refname> + <refpurpose> + Enregistre un nouvel événement dans un calendrier MCAL. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_append_event</function></funcdef> + <paramdef>int <parameter>mcal_stream</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_append_event</function> enregistre + l'événement global dans le calendrier + MCAL <parameter>mcal_stream</parameter>. + </para> + <para> + Retourne l'uid de l'enregistement ainsi inséré. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-store-event"> + <refnamediv> + <refname>mcal_store_event</refname> + <refpurpose> + Modifie un événement dans un calendrier MCAL. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_store_event</function></funcdef> + <paramdef>int <parameter>mcal_stream</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_store_event</function> enregistre + l'événement global dans le calendrier + MCAL <parameter>mcal_stream</parameter>. + </para> + <para> + Retourne TRUE en cas de succès, et FALSE en cas d'erreur. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-delete-event"> + <refnamediv> + <refname>mcal_delete_event</refname> + <refpurpose> + Efface un événement dans un calendrier MCAL. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_delete_event</function></funcdef> + <paramdef>int <parameter>mcal_stream</parameter></paramdef> + <paramdef>int <parameter><optional>event_id</optional></parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_delete_event</function> efface + l'événement d'identifiant <parameter>uid</parameter>. + </para> + <para> + Retourne TRUE. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-snooze"> + <refnamediv> + <refname>mcal_snooze</refname> + <refpurpose>Eteind l'alarme d'un événement.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_snooze</function></funcdef> + <paramdef>int <parameter>id</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_snooze</function> éteind l'alarme de + l'événement identifié par l'UID + <parameter>uid</parameter>. + </para> + <para> + Retourne TRUE. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-list-alarms"> + <refnamediv> + <refname>mcal_list_alarms</refname> + <refpurpose> + Retourne une liste d'événements qui ont une alarme + prévue à une date. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>mcal_list_events</function></funcdef> + <paramdef>int <parameter>mcal_stream</parameter></paramdef> + <paramdef>int + <parameter><optional>begin_year</optional></parameter> + </paramdef> + <paramdef>int + <parameter><optional>begin_month</optional></parameter> + </paramdef> + <paramdef>int + <parameter><optional>begin_day</optional></parameter> + </paramdef> + <paramdef>int + <parameter><optional>end_year</optional></parameter> + </paramdef> + <paramdef>int + <parameter><optional>end_month</optional></parameter> + </paramdef> + <paramdef>int + <parameter><optional>end_day</optional></parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + <para> + Retourne un tableau d'identifiants, qui ont une alarme de + prévue à la date <parameter>alarm_date</parameter>. + Si seul le flot MCAL est donné, la date de début et + de fin de la structure globale sera utilisée. + </para> + <para> + <function>mcal_list_events</function> prend une date, et retourne un tableau + d'identifiants. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-init"> + <refnamediv> + <refname>mcal_event_init</refname> + <refpurpose> + Initialise la structure globale d'un flot. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_event_init</function></funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_init</function> initialise la structure + globale d'un flot. Cela remet tous les éléments + de la structure à 0, ou à leur valeur par défaut. + </para> + <para> + Retourne TRUE. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-set-category"> + <refnamediv> + <refname>mcal_event_set_category</refname> + <refpurpose> + Fixe la catégorie de la structure globale. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_event_set_category</function></funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>string <parameter>category</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_set_category</function> fixe la + catégorie de la structure globale à la + valeur de <parameter>category</parameter>. + </para> + <para> + Retourne TRUE. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-set-title"> + <refnamediv> + <refname>mcal_event_set_title</refname> + <refpurpose> + fixe le titre de la structure globale. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_event_set_title</function></funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>string <parameter>title</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_set_title</function> fixe le titre de + la structure globale à la valeur de <parameter>title</parameter>. + </para> + <para> + Retourne TRUE. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-set-description"> + <refnamediv> + <refname>mcal_event_set_description</refname> + <refpurpose> + Fixe la déscription de la structure globale. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>mcal_event_set_description</function> + </funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>string <parameter>description</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_set_description</function> fixe la + catégorie de la structure globale à la + valeur de <parameter>description</parameter>. + </para> + <para> + Returns TRUE. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-set-start"> + <refnamediv> + <refname>mcal_event_set_start</refname> + <refpurpose> + Fixe les dates de début et de fin de la structure globale. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_event_set_start</function></funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>int <parameter>year</parameter></paramdef> + <paramdef>int <parameter>month</parameter></paramdef> + <paramdef>int + <parameter> + <optional>day</optional> + </parameter> + </paramdef> + <paramdef>int + <parameter> + <optional>hour</optional> + </parameter> + </paramdef> + <paramdef>int + <parameter> + <optional>min</optional></parameter> + </paramdef> + <paramdef>int + <parameter> + <optional>sec</optional> + </parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_set_start</function> fixe la date de + début de la structure globale. + </para> + <para> + Retourne TRUE. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-set-end"> + <refnamediv> + <refname>mcal_event_set_end</refname> + <refpurpose> + Fixe la date de fin de la structure globale. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_event_set_end</function></funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>int <parameter>year</parameter></paramdef> + <paramdef>int <parameter>month</parameter></paramdef> + <paramdef>int + <parameter> + <optional>day</optional> + </parameter> + </paramdef> + <paramdef>int + <parameter> + <optional>hour</optional> + </parameter> + </paramdef> + <paramdef>int + <parameter> + <optional>min</optional> + </parameter> + </paramdef> + <paramdef>int + <parameter> + <optional>sec</optional> + </parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_set_end</function> fixe la date de fin de la structure + globale. + </para> + <para> + Returns TRUE. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-set-alarm"> + <refnamediv> + <refname>mcal_event_set_alarm</refname> + <refpurpose> + Fixe l'alarme de la structure globale. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_event_set_alarm</function></funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>int <parameter>alarm</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_set_alarm</function> fixe l'alarme de la + structure globale,à un nombre de minutes avant + déclenchement. + </para> + <para> + Retourne TRUE. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-set-class"> + <refnamediv> + <refname>mcal_event_set_class</refname> + <refpurpose> + Fixe la classe de la structure globale. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_event_set_class</function></funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>int <parameter>class</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_set_class</function> fixe la classe de + la structure globale. La classe vaut 0 pour public, et 1 + pour privée. + </para> + <para> + Retourne TRUE. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-is-leap-year"> + <refnamediv> + <refname>mcal_is_leap_year</refname> + <refpurpose> + Vérifie que l'année est bissextile. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_is_leap_year</function></funcdef> + <paramdef>int <parameter>year</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_is_leap_year</function> retoune 1 si l'année + <parameter>year</parameter> est bissextile, et 0 sinon. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-days-in-month"> + <refnamediv> + <refname>mcal_days_in_month</refname> + <refpurpose> + Retourne le nombre de jour d'un mois. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_days_in_month</function></funcdef> + <paramdef>int <parameter>month</parameter></paramdef> + <paramdef>int <parameter>leap year</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_days_in_month</function> retourne le nombre + de jour du mois <parameter>month</parameter>, et prend en + compte le fait que l'année est bissextile avec le + paramètre <parameter>leap year</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-date-valid"> + <refnamediv> + <refname>mcal_date_valid</refname> + <refpurpose> + Valide une date. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_date_valid</function></funcdef> + <paramdef>int <parameter>year</parameter></paramdef> + <paramdef>int <parameter>month</parameter></paramdef> + <paramdef>int <parameter>day</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_date_valid</function> retourne TRUE si la + date (constituée par l'année <parameter>year</parameter>, + le mois <parameter>month</parameter> et la date + <parameter>day</parameter>) est valide, et FALSE sinon. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-time-valid"> + <refnamediv> + <refname>mcal_time_valid</refname> + <refpurpose> + Valide une heure. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_time_valid</function></funcdef> + <paramdef>int <parameter>hour</parameter></paramdef> + <paramdef>int <parameter>minutes</parameter></paramdef> + <paramdef>int <parameter>seconds</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_time_valid</function> retourne TRUE si + l'heure (constituée par l'heure <parameter>hour</parameter>, + les minutes <parameter>minutes</parameter> et les secondes + <parameter>seconds</parameter>) est une heure valide, et FALSE sinon. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-day-of-week"> + <refnamediv> + <refname>mcal_day_of_week</refname> + <refpurpose> + Le jour de la semaine. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_</function></funcdef> + <paramdef>int <parameter>year</parameter></paramdef> + <paramdef>int <parameter>month</parameter></paramdef> + <paramdef>int <parameter>day</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_day_of_week</function> retourne le jour de + la semaine, pour la date constituée par l'année + <parameter>year</parameter>, le mois <parameter>month</parameter> + et la date <parameter>day</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-day-of-year"> + <refnamediv> + <refname>mcal_day_of_year</refname> + <refpurpose> + Le jour de l'année. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_</function></funcdef> + <paramdef>int <parameter>year</parameter></paramdef> + <paramdef>int <parameter>month</parameter></paramdef> + <paramdef>int <parameter>day</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_day_of_year</function> retourne le numéro + de jour dans l'année pour la date constituée par + l'année <parameter>year</parameter>, le mois + <parameter>month</parameter> et la date <parameter>day</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-date-compare"> + <refnamediv> + <refname>mcal_date_compare</refname> + <refpurpose>Compare deux dates.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_date_compare</function></funcdef> + <paramdef>int <parameter>a_year</parameter></paramdef> + <paramdef>int <parameter>a_month</parameter></paramdef> + <paramdef>int <parameter>a_day</parameter></paramdef> + <paramdef>int <parameter>b_year</parameter></paramdef> + <paramdef>int <parameter>b_month</parameter></paramdef> + <paramdef>int <parameter>b_day</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_date_compare</function> compares les deux + dates données, et retourne <0, 0, >0 si a<b, + a==b, a>b respectivement. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-next-recurrence"> + <refnamediv> + <refname>mcal_next_recurrence</refname> + <refpurpose> + Retourne la prochaine occurence d'une événement. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_next_recurrence</function></funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>int <parameter>weekstart</parameter></paramdef> + <paramdef>array <parameter>next</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_next_recurrence</function> retourne un objet + contenant la prochaine date de l'événement, ou + la date de l'événement suivant la date. Retourne + un objet date vide si l'événement n'a pas de + réoccurence, ou si quelquechose est invalide. Utilisez + <parameter>weekstart</parameter> pour déterminer le premier jour. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-set-recur-none"> + <refnamediv> + <refname>mcal_event_set_recur_none</refname> + <refpurpose> + Supprime la récurence de la structure globale. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>mcal_event_set_recur_none</function> + </funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_set_recur_none</function> supprime la + récurence de la structure globale (event->recur_type + est mis à MCAL_RECUR_NONE). + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-set-recur-daily"> + <refnamediv> + <refname>mcal_event_set_recur_daily</refname> + <refpurpose> + Fixe la récurence quotidienne. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>mcal_event_set_recur_daily</function> + </funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>int <parameter>year</parameter></paramdef> + <paramdef>int <parameter>month</parameter></paramdef> + <paramdef>int <parameter>day</parameter></paramdef> + <paramdef>int <parameter>interval</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_set_recur_daily</function> fixe la récurence + quotidienne de la structure globale, jusqu'à la date passée + en paramètre. (la date de début est celle de la structure). + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-set-recur-weekly"> + <refnamediv> + <refname>mcal_event_set_recur_weekly</refname> + <refpurpose> + Fixe la récurence hedbomadaire. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>mcal_event_set_recur_weekly</function> + </funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>int <parameter>year</parameter></paramdef> + <paramdef>int <parameter>month</parameter></paramdef> + <paramdef>int <parameter>day</parameter></paramdef> + <paramdef>int <parameter>interval</parameter></paramdef> + <paramdef>int <parameter>weekdays</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_set_recur_weekly</function> fixe la + récurence hedbomadaire de la structure globale, + jusqu'à la date passée en paramètre. + (la date de début est celle de la structure). + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-set-recur-monthly-mday"> + <refnamediv> + <refname>mcal_event_set_recur_monthly_mday</refname> + <refpurpose> + Fixe la récurence. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>mcal_event_set_recur_monthly_mday</function> + </funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>int <parameter>year</parameter></paramdef> + <paramdef>int <parameter>month</parameter></paramdef> + <paramdef>int <parameter>day</parameter></paramdef> + <paramdef>int <parameter>interval</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_set_recur_monthly_mday</function> fixe la + récurence de la structure globale, jusqu'à la date + passée en paramètre. (la date de début est + celle de la structure). + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-set-recur-monthly-wday"> + <refnamediv> + <refname>mcal_event_set_recur_monthly_wday</refname> + <refpurpose> + fixe la récurence mensuelle. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>mcal_event_set_recur_monthly_wday</function> + </funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>int <parameter>year</parameter></paramdef> + <paramdef>int <parameter>month</parameter></paramdef> + <paramdef>int <parameter>day</parameter></paramdef> + <paramdef>int <parameter>interval</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_set_recur_monthly_wday</function> fixe la + récurence mensuelle de la structure globale, jusqu'à + la date passée en paramètre. (la date de début + est celle de la structure). + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-set-recur-yearly"> + <refnamediv> + <refname>mcal_event_set_recur_yearly</refname> + <refpurpose> + fixe la récurence annuelle. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>mcal_event_set_recur_yearly</function> + </funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>int <parameter>year</parameter></paramdef> + <paramdef>int <parameter>month</parameter></paramdef> + <paramdef>int <parameter>day</parameter></paramdef> + <paramdef>int <parameter>interval</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_set_recur_yearly</function> fixe la + récurence annuelle de la structure globale, + jusqu'à la date passée en paramètre. + (la date de début est celle de la structure). + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-fetch-current-stream-event"> + <refnamediv> + <refname>mcal_fetch_current_stream_event</refname> + <refpurpose> + Retourne un objet contenant la structure de date pour le flot courant. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>mcal_fetch_current_stream_event</function> + </funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_fetch_current_stream_event</function> retourne + la structure de la date du flot courant sous la forme d'un + objet, qui contient : + <itemizedlist> + <listitem><simpara> + int id - ID de l'événement.</simpara></listitem> + <listitem><simpara> + int public - TRUE si l'événement est public, FALSE si il est privé.</simpara></listitem> + <listitem><simpara> + string category - Catégorie de l'événement.</simpara></listitem> + <listitem><simpara> + string title - Titre de l'événement.</simpara></listitem> + <listitem><simpara> + string description - Description de l'événement.</simpara></listitem> + <listitem><simpara> + int alarm - Nombre de minutes avant d'envoyer une alerte pour cet événement.</simpara></listitem> + <listitem><simpara> + object start - Objet contenant une date et une heure.</simpara></listitem> + <listitem><simpara> + object end - Objet contenant une date et une heure.</simpara></listitem> + <listitem><simpara> + int recur_type - type de récurence</simpara></listitem> + <listitem><simpara> + int recur_interval - intervalle de récurence</simpara></listitem> + <listitem><simpara> + datetime recur_endate - date de fin de récurence</simpara></listitem> + <listitem><simpara> + int recur_data - données de récurence</simpara></listitem> + </itemizedlist> + Tous les objets de date et heure sont construits comme suit : + <itemizedlist> + <listitem><simpara> + int year - année</simpara></listitem> + <listitem><simpara> + int month - mois</simpara></listitem> + <listitem><simpara> + int mday - jour du mois</simpara></listitem> + <listitem><simpara> + int hour - heure</simpara></listitem> + <listitem><simpara> + int min - minutes</simpara></listitem> + <listitem><simpara> + int sec - secondes</simpara></listitem> + <listitem><simpara> + int alarm - nombre de minutes avant de déclencher l'alarme</simpara></listitem> + </itemizedlist></para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-add-attribute"> + <refnamediv> + <refname>mcal_event_add_attribute</refname> + <refpurpose> + Ajoute un attribut et une valeur à la structure globale + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>void + <function>mcal_event_add_attribute</function> + </funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>string <parameter>attribute</parameter></paramdef> + <paramdef>string <parameter>value</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_add_attribute</function> ajoute l'attribut + <parameter>attribute</parameter> à la structure globale, + avec la valeur <parameter>value</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-expunge"> + <refnamediv> + <refname>mcal_expunge</refname> + <refpurpose> + Supprime tous les événements marqués pour l'effacement + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>mcal_expunge</function> + </funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_expunge</function> supprime tous les événements + marqués pour l'effacement. + </para> + </refsect1> + </refentry> +</reference> +<!-- 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 +sgml-parent-document:nil +sgml-default-dtd-file:"../manual.ced" +sgml-exposed-tags:nil +sgml-local-catalogs:nil +sgml-local-ecat-files:nil +End: +-->
Index: phpdoc/fr/functions/mcal.xml diff -u phpdoc/fr/functions/mcal.xml:1.1 phpdoc/fr/functions/mcal.xml:1.2 --- phpdoc/fr/functions/mcal.xml:1.1 Fri Jul 21 03:27:50 2000 +++ phpdoc/fr/functions/mcal.xml Wed Nov 22 09:20:22 2000 @@ -1,1020 +1,1215 @@ - <reference id="ref.mcal"> - <title>Fonctions MCAL</title> - <titleabbrev>MCAL</titleabbrev> - - <partintro> - <para> - MCAL signifie Modular Calendar Access Library (librairie calendaire modulaire). - </para> - - <para> - Libmcal est une librairie C de calendriers. Elle est écrite pour être très - modulaire, et dispose de nombreux modules. MCAL est l'équivalent de IMAP pour les - calendriers. - </para> - - <para> - Avec mcal, un calendrier peut être ouvert comme une boîte aux lettres. Les - calendriers peuvent être des fichiers locaux, ou bien être sur des serveurs ICAP - distants, ou encore tout autre format supporté par la librairie. - </para> - - <para> - Les événements peuvent être lus, selectionnés et enregistrés. Il y a aussi la - possibilité d'ajouter des alarmes, et de placer des événéments récurents. - </para> - - <para> - Avec libmcal, les serveurs centralisés peuvent être accédés et utilisés, et - remplacent avantageusement tout développement spécifique de base de données. - </para> - - <para> - Pour faire fonctionner cette librairie, vous devez compiler PHP avec l'option - <option role="configure">--with-mcal</option>. Il vous faudra alors avoir installé - la librairie mcal. Téléchargez la dernière version à - <ulink url="http://mcal.chek.com/">http://mcal.chek.com/</ulink> et compilez la, - puis installez la. - </para> - - <para> - Les constantes suivantes sont définies lorsque mcal est utilisée : - - MCAL_SUNDAY, - MCAL_MONDAY, - MCAL_TUESDAY, - MCAL_WEDNESDAY, - MCAL_THURSDAY, - MCAL_FRIDAY, - MCAL_SATURDAY, - - MCAL_RECUR_NONE, - MCAL_RECUR_DAILY, - MCAL_RECUR_WEEKLY, - MCAL_RECUR_MONTHLY_MDAY, - MCAL_RECUR_MONTHLY_WDAY, - MCAL_RECUR_YEARLY, - - MCAL_JANUARY, - MCAL_FEBRUARY, - MCAL_MARCH, - MCAL_APRIL, - MCAL_MAY, - MCAL_JUNE, - MCAL_JULY, - MCAL_AUGUGT, - MCAL_SEPTEMBER, - MCAL_OCTOBER, - MCAL_NOVEMBER, et - MCAL_DECEMBER. - - La plus part des fonctions utilisent une structure d'événement interne, qui est - unique pour chaque connexion. Cela évite d'avoir à passer des objets de grande - taille entre les fonctions. Il y a des accesseurs bien pratiques pour créer, - initialiser et lire des objets événements. - </para> - </partintro> - - <refentry id="function.mcal-open"> - <refnamediv> - <refname>mcal_open</refname> - <refpurpose>Ouvre une connexion MCAL.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_open</function></funcdef> - <paramdef>string <parameter>calendar</parameter></paramdef> - <paramdef>string <parameter>username</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - <paramdef>string <parameter>options</parameter></paramdef> - </funcsynopsis> - <para> - Retourne un flot MCAL en cas de succès, et FALSE en cas d'erreur.</para> - <para> - <function>mcal_open</function> ouvre une connexion MCAL au serveur - <parameter>calendar</parameter>. Si <parameter>options</parameter> est spécifié, - passe aussi <parameter>options</parameter> à la boîte aux lettres (???). - La structure interne du flot MCAL est initialisée à la connnexion. - </para> - </refsect1> - </refentry> - - - <refentry id="function.mcal-close"> - <refnamediv> - <refname>mcal_close</refname> - <refpurpose>Ferme une connexion MCAL.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_close</function></funcdef> - <paramdef>int <parameter>mcal_stream</parameter></paramdef> - <paramdef>int <parameter>flags</parameter></paramdef> - </funcsynopsis> - <para> - Ferme la connexion. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-fetch-event"> - <refnamediv> - <refname>mcal_fetch_event</refname> - <refpurpose> - Recherche un événement dans le calendrier. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>object <function>mcal_fetch_event</function></funcdef> - <paramdef>int <parameter>mcal_stream</parameter></paramdef> - <paramdef>int <parameter>event_id</parameter></paramdef> - <paramdef>int <parameter><optional>options</optional></parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_fetch_event</function> recherche un évenement dans le calendrier - spécifié par <parameter>id</parameter>. - </para> - <para> - Retourne un objet événement dont les attributs sont : - - <itemizedlist> - <listitem><simpara> - int id - ID de l'événement.</simpara></listitem> - <listitem><simpara> - int public - TRUE si l'événement est public, FALSE si il est privé.</simpara></listitem> - <listitem><simpara> - string category - Catégorie de l'événement.</simpara></listitem> - <listitem><simpara> - string title - Titre de l'événement.</simpara></listitem> - <listitem><simpara> - string description - Description de l'événement.</simpara></listitem> - <listitem><simpara> - int alarm - Nombre de minutes avant d'envoyer une alerte pour cet événement.</simpara></listitem> - <listitem><simpara> - object start - Objet contenant une date et une heure.</simpara></listitem> - <listitem><simpara> - object end - Objet contenant une date et une heure.</simpara></listitem> - <listitem><simpara> - int recur_type - type de récurence</simpara></listitem> - <listitem><simpara> - int recur_interval - intervalle de récurence</simpara></listitem> - <listitem><simpara> - datetime recur_endate - date de fin de récurence</simpara></listitem> - <listitem><simpara> - int recur_data - données de récurence</simpara></listitem> - </itemizedlist> - - Tous les objets de date et heure sont construits comme suit : - - <itemizedlist> - <listitem><simpara> - int year - année</simpara></listitem> - <listitem><simpara> - int month - mois</simpara></listitem> - <listitem><simpara> - int mday - jour du mois</simpara></listitem> - <listitem><simpara> - int hour - heure</simpara></listitem> - <listitem><simpara> - int min - minutes</simpara></listitem> - <listitem><simpara> - int sec - secondes</simpara></listitem> - <listitem><simpara> - int alarm - nombre de minutes avant de déclencher l'alarme</simpara></listitem> - </itemizedlist></para> - </refsect1> - </refentry> - - - <refentry id="function.mcal-list-events"> - <refnamediv> - <refname>mcal_list_events</refname> - <refpurpose> - Retourne une liste d'événement entre deux dates. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>mcal_list_events</function></funcdef> - <paramdef>int <parameter>mcal_stream</parameter></paramdef> - <paramdef>int - <parameter><optional>begin_year</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>begin_month</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>begin_day</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>end_year</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>end_month</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>end_day</optional></parameter> - </paramdef> - </funcsynopsis> - <para> - Retourne un tableau d'identifiants d'événéments, compris entre deux dates. - </para> - <para> - <function>mcal_list_events</function> prend une date de début et une date - de fin. Un tableau d'identifiants est retourné. - </para> - </refsect1> - </refentry> - - - <refentry id="function.mcal-append-event"> - <refnamediv> - <refname>mcal_append_event</refname> - <refpurpose>Enregistre un nouvel événement dans un calendrier MCAL.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_append_event</function></funcdef> - <paramdef>int <parameter>mcal_stream</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_append_event</function> enregistre l'événement global - dans le calendrier MCAL <parameter>mcal_stream</parameter>. - </para> - <para> - Retourne l'uid de l'enregistement ainsi inséré. - </para> - </refsect1> - </refentry> - - - <refentry id="function.mcal-store-event"> - <refnamediv> - <refname>mcal_store_event</refname> - <refpurpose>Modifie un événement dans un calendrier MCAL.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_store_event</function></funcdef> - <paramdef>int <parameter>mcal_stream</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_store_event</function> enregistre l'événement global dans le - calendrier MCAL <parameter>mcal_stream</parameter>. - </para> - <para> - Retourne TRUE en cas de succès, et FALSE en cas d'erreur. - </para> - </refsect1> - </refentry> - - - <refentry id="function.mcal-delete-event"> - <refnamediv> - <refname>mcal_delete_event</refname> - <refpurpose>Efface un événement dans un calendrier MCAL.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_delete_event</function></funcdef> - <paramdef>int <parameter>uid</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_delete_event</function> efface l'événement d'identifiant - <parameter>uid</parameter>. - </para> - <para> - Retourne TRUE. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-snooze"> - <refnamediv> - <refname>mcal_snooze</refname> - <refpurpose>Eteind l'alarme d'un événement.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_snooze</function></funcdef> - <paramdef>int <parameter>uid</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_snooze</function> éteind l'alarme de l'événement identifié par - l'UID <parameter>uid</parameter>. - </para> - <para> - Retourne TRUE. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-list-alarms"> - <refnamediv> - <refname>mcal_list_alarms</refname> - <refpurpose> - Retourne une liste d'événements qui ont une alarme prévue à une date. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>mcal_list_events</function></funcdef> - <paramdef>int <parameter>mcal_stream</parameter></paramdef> - <paramdef>int - <parameter><optional>begin_year</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>begin_month</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>begin_day</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>end_year</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>end_month</optional></parameter> - </paramdef> - <paramdef>int - <parameter><optional>end_day</optional></parameter> - </paramdef> - </funcsynopsis> - <para> - Retourne un tableau d'identifiants, qui ont une alarme de prévue à la date - <parameter>alarm_date</parameter>. Si seul le flot MCAL est donné, la date de - début et de fin de la structure globale sera utilisée. - </para> - <para> - <function>mcal_list_events</function> prend une date, et retourne un tableau - d'identifiants. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-event-init"> - <refnamediv> - <refname>mcal_event_init</refname> - <refpurpose> - Initialise la structure globale d'un flot. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_event_init</function></funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_event_init</function> initialise la structure globale d'un flot. - Cela remet tous les éléments de la structure à 0, ou à leur valeur par défaut. - </para> - <para> - Retourne TRUE. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-event-set-category"> - <refnamediv> - <refname>mcal_event_set_category</refname> - <refpurpose> - Fixe la catégorie de la structure globale. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_event_set_category</function></funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>string <parameter>category</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_event_set_category</function> fixe la catégorie de la structure - globale à la valeur de <parameter>category</parameter>. - </para> - <para> - Retourne TRUE. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-event-set-title"> - <refnamediv> - <refname>mcal_event_set_title</refname> - <refpurpose> - fixe le titre de la structure globale. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_event_set_title</function></funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>string <parameter>title</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_event_set_title</function> fixe le titre de la structure globale à - la valeur de <parameter>title</parameter>. - </para> - <para> - Retourne TRUE. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-event-set-description"> - <refnamediv> - <refname>mcal_event_set_description</refname> - <refpurpose> - Fixe la déscription de la structure globale. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>mcal_event_set_description</function> - </funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>string <parameter>description</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_event_set_description</function> fixe la catégorie de la structure - globale à la valeur de <parameter>description</parameter>. - </para> - <para> - Returns TRUE. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-event-set-start"> - <refnamediv> - <refname>mcal_event_set_start</refname> - <refpurpose> - Fixe les dates de début et de fin de la structure globale. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_event_set_start</function></funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int - <parameter> - <optional>day</optional> - </parameter> - </paramdef> - <paramdef>int - <parameter> - <optional>hour</optional> - </parameter> - </paramdef> - <paramdef>int - <parameter> - <optional>min</optional></parameter> - </paramdef> - <paramdef>int - <parameter> - <optional>sec</optional> - </parameter> - </paramdef> - </funcsynopsis> - <para> - <function>mcal_event_set_start</function> fixe la date de début de la structure - globale. - </para> - <para> - Retourne TRUE. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-event-set-end"> - <refnamediv> - <refname>mcal_event_set_end</refname> - <refpurpose> - Fixe la date de fin de la structure globale. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_event_set_end</function></funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int - <parameter> - <optional>day</optional> - </parameter> - </paramdef> - <paramdef>int - <parameter> - <optional>hour</optional> - </parameter> - </paramdef> - <paramdef>int - <parameter> - <optional>min</optional> - </parameter> - </paramdef> - <paramdef>int - <parameter> - <optional>sec</optional> - </parameter> - </paramdef> - </funcsynopsis> - <para> - <function>mcal_event_set_end</function> fixe la date de fin de la structure - globale. - </para> - <para> - Returns TRUE. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-event-set-alarm"> - <refnamediv> - <refname>mcal_event_set_alarm</refname> - <refpurpose> - Fixe l'alarme de la structure globale. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_event_set_alarm</function></funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>alarm</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_event_set_alarm</function> fixe l'alarme de la structure globale, - à un nombre de minutes avant déclenchement. - </para> - <para> - Retourne TRUE. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-event-set-class"> - <refnamediv> - <refname>mcal_event_set_class</refname> - <refpurpose> - Fixe la classe de la structure globale. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_event_set_class</function></funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>class</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_event_set_class</function> Fixe la classe de la structure globale. - La classe vaut 0 pour public, et 1 pour privée. - </para> - <para> - Retourne TRUE. - </para> - </refsect1> - </refentry> - - - <refentry id="function.mcal-is-leap-year"> - <refnamediv> - <refname>mcal_is_leap_year</refname> - <refpurpose> - Vérifie que l'année est bissextile. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_is_leap_year</function></funcdef> - <paramdef>int <parameter>year</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_is_leap_year</function> retoune 1 si l'année - <parameter>year</parameter> est bissextile, et 0 sinon. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-days-in-month"> - <refnamediv> - <refname>mcal_days_in_month</refname> - <refpurpose> - Retourne le nombre de jour d'un mois. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_days_in_month</function></funcdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>leap year</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_days_in_month</function> retourne le nombre de jour du mois - <parameter>month</parameter>, et prend en compte le fait que l'année est - bissextile avec le paramètre <parameter>leap year</parameter>. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-date-valid"> - <refnamediv> - <refname>mcal_date_valid</refname> - <refpurpose> - Valide une date. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_date_valid</function></funcdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_date_valid</function> retourne TRUE si la date (constituée par - l'année <parameter>year</parameter>, le mois <parameter>month</parameter> et la - date <parameter>day</parameter>) est valide, et FALSE sinon. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-time-valid"> - <refnamediv> - <refname>mcal_time_valid</refname> - <refpurpose> - Valide une heure. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_time_valid</function></funcdef> - <paramdef>int <parameter>hour</parameter></paramdef> - <paramdef>int <parameter>minutes</parameter></paramdef> - <paramdef>int <parameter>seconds</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_time_valid</function> retourne TRUE si l'heure (constituée par - l'heure <parameter>hour</parameter>, les minutes <parameter>minutes</parameter> - et les secondes <parameter>seconds</parameter>) est une heure valide, et FALSE - sinon. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-day-of-week"> - <refnamediv> - <refname>mcal_day_of_week</refname> - <refpurpose> - Le jour de la semaine. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_day_of_week</function></funcdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_day_of_week</function> retourne le jour de la semaine, pour la date - constituée par l'année <parameter>year</parameter>, le mois - <parameter>month</parameter> et la date <parameter>day</parameter>. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-day-of-year"> - <refnamediv> - <refname>mcal_day_of_year</refname> - <refpurpose> - Le jour de l'année. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_day_of_year</function></funcdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_day_of_year</function> retourne le numéro de jour dans l'année pour - la date constituée par l'année <parameter>year</parameter>, le mois - <parameter>month</parameter> et la date <parameter>day</parameter>. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-date-compare"> - <refnamediv> - <refname>mcal_date_compare</refname> - <refpurpose>Compare deux dates.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_date_compare</function></funcdef> - <paramdef>int <parameter>a_year</parameter></paramdef> - <paramdef>int <parameter>a_month</parameter></paramdef> - <paramdef>int <parameter>a_day</parameter></paramdef> - <paramdef>int <parameter>b_year</parameter></paramdef> - <paramdef>int <parameter>b_month</parameter></paramdef> - <paramdef>int <parameter>b_day</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_date_compare</function> compares les deux dates données, - et retourne <0, 0, >0 si a<b, a==b, a>b respectivement. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-next-recurrence"> - <refnamediv> - <refname>mcal_next_recurrence</refname> - <refpurpose>Retourne la prochaine occurence d'une événement.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>mcal_next_recurrence</function></funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>weekstart</parameter></paramdef> - <paramdef>array <parameter>next</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_next_recurrence</function> retourne un objet contenant la prochaine - date de l'événement, ou la date de l'événement suivant la date. - Retourne un objet date vide si l'événement n'a pas de réoccurence, ou si - quelquechose est invalide. Utilisez <parameter>weekstart</parameter> pour - déterminer le premier jour. - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-event-set-recur-none"> - <refnamediv> - <refname>mcal_event_set_recur_none</refname> - <refpurpose> - Supprime la récurence de la structure globale. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>mcal_event_set_recur_none</function> - </funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_event_set_recur_none</function> supprime la récurence de la - structure globale (event->recur_type est mis à MCAL_RECUR_NONE). - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-event-set-recur-daily"> - <refnamediv> - <refname>mcal_event_set_recur_daily</refname> - <refpurpose> - Fixe la récurence quotidienne. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>mcal_event_set_recur_daily</function> - </funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - <paramdef>int <parameter>interval</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_event_set_recur_daily</function> fixe la récurence quotidienne de - la structure globale, jusqu'à la date passée en paramètre. (la date de début est - celle de la structure). - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-event-set-recur-weekly"> - <refnamediv> - <refname>mcal_event_set_recur_weekly</refname> - <refpurpose> - Fixe la récurence hedbomadaire. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>mcal_event_set_recur_weekly</function> - </funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - <paramdef>int <parameter>interval</parameter></paramdef> - <paramdef>int <parameter>weekdays</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_event_set_recur_weekly</function> fixe la récurence hedbomadaire de - la structure globale, jusqu'à la date passée en paramètre. (la date de début est - celle de la structure). - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-event-set-recur-monthly-mday"> - <refnamediv> - <refname>mcal_event_set_recur_monthly_mday</refname> - <refpurpose> - Fixe la récurence. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>mcal_event_set_recur_monthly_mday</function> - </funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - <paramdef>int <parameter>interval</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_event_set_recur_monthly_mday</function> fixe la récurence de - la structure globale, jusqu'à la date passée en paramètre. (la date de début est - celle de la structure). - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-event-set-recur-monthly-wday"> - <refnamediv> - <refname>mcal_event_set_recur_monthly_wday</refname> - <refpurpose> - fixe la récurence mensuelle. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>mcal_event_set_recur_monthly_wday</function> - </funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - <paramdef>int <parameter>interval</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_event_set_recur_monthly_wday</function> fixe la récurence mensuelle - de la structure globale, jusqu'à la date passée en paramètre. (la date de début - est celle de la structure). - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-event-set-recur-yearly"> - <refnamediv> - <refname>mcal_event_set_recur_yearly</refname> - <refpurpose> - fixe la récurence annuelle. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>mcal_event_set_recur_yearly</function> - </funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - <paramdef>int <parameter>year</parameter></paramdef> - <paramdef>int <parameter>month</parameter></paramdef> - <paramdef>int <parameter>day</parameter></paramdef> - <paramdef>int <parameter>interval</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_event_set_recur_yearly</function> fixe la récurence annuelle de la - structure globale, jusqu'à la date passée en paramètre. (la date de début est - celle de la structure). - </para> - </refsect1> - </refentry> - - <refentry id="function.mcal-fetch-current-stream-event"> - <refnamediv> - <refname>mcal_fetch_current_stream_event</refname> - <refpurpose> - Retourne un objet contenant la structure de date pour le flot courant. - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int - <function>mcal_fetch_current_stream_event</function> - </funcdef> - <paramdef>int <parameter>stream</parameter></paramdef> - </funcsynopsis> - <para> - <function>mcal_fetch_current_stream_event</function> retourne la structure de la - date du flot courant sous la forme d'un objet, qui contient : - - <itemizedlist> - <listitem><simpara> - int id - ID de l'événement.</simpara></listitem> - <listitem><simpara> - int public - TRUE si l'événement est public, FALSE si il est privé.</simpara></listitem> - <listitem><simpara> - string category - Catégorie de l'événement.</simpara></listitem> - <listitem><simpara> - string title - Titre de l'événement.</simpara></listitem> - <listitem><simpara> - string description - Description de l'événement.</simpara></listitem> - <listitem><simpara> - int alarm - Nombre de minutes avant d'envoyer une alerte pour cet événement.</simpara></listitem> - <listitem><simpara> - object start - Objet contenant une date et une heure.</simpara></listitem> - <listitem><simpara> - object end - Objet contenant une date et une heure.</simpara></listitem> - <listitem><simpara> - int recur_type - type de récurence</simpara></listitem> - <listitem><simpara> - int recur_interval - intervalle de récurence</simpara></listitem> - <listitem><simpara> - datetime recur_endate - date de fin de récurence</simpara></listitem> - <listitem><simpara> - int recur_data - données de récurence</simpara></listitem> - </itemizedlist> - - Tous les objets de date et heure sont construits comme suit : - - <itemizedlist> - <listitem><simpara> - int year - année</simpara></listitem> - <listitem><simpara> - int month - mois</simpara></listitem> - <listitem><simpara> - int mday - jour du mois</simpara></listitem> - <listitem><simpara> - int hour - heure</simpara></listitem> - <listitem><simpara> - int min - minutes</simpara></listitem> - <listitem><simpara> - int sec - secondes</simpara></listitem> - <listitem><simpara> - int alarm - nombre de minutes avant de déclencher l'alarme</simpara></listitem> - </itemizedlist></para> - </refsect1> - </refentry> -</reference> -<!-- 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 -sgml-parent-document:nil -sgml-default-dtd-file:"../manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: ---> + <reference id="ref.mcal"> + <title>Fonctions MCAL</title> + <titleabbrev>MCAL</titleabbrev> + <partintro> + <para> + MCAL signifie Modular Calendar Access Library (librairie calendaire modulaire). + </para> + <para> + Libmcal est une librairie C de calendriers. Elle est écrite + pour être très modulaire, et dispose de nombreux modules. + MCAL est l'équivalent de IMAP pour les calendriers. + </para> + <para> + Avec mcal, un calendrier peut être ouvert comme une boîte + aux lettres. Les calendriers peuvent être des fichiers locaux, + ou bien être sur des serveurs ICAP distants, ou encore tout + autre format supporté par la librairie. + </para> + <para> + Les événements peuvent être lus, selectionnés + et enregistrés. Il y a aussi la possibilité d'ajouter des + alarmes, et de placer des événéments récurents. + </para> + <para> + Avec libmcal, les serveurs centralisés peuvent être + accédés et utilisés, et remplacent avantageusement + tout développement spécifique de base de données. + </para> + <para> + Pour faire fonctionner cette librairie, vous devez compiler PHP avec + l'option <option role="configure">--with-mcal</option>. Il vous faudra + alors avoir installé la librairie mcal. Téléchargez + la dernière version à + <ulink url="&url.mcal;">&url.mcal;</ulink> et compilez la, puis installez la. + </para> + <para> + Les constantes suivantes sont définies lorsque mcal est utilisée : + MCAL_SUNDAY, + MCAL_MONDAY, + MCAL_TUESDAY, + MCAL_WEDNESDAY, + MCAL_THURSDAY, + MCAL_FRIDAY, + MCAL_SATURDAY, + MCAL_RECUR_NONE, + MCAL_RECUR_DAILY, + MCAL_RECUR_WEEKLY, + MCAL_RECUR_MONTHLY_MDAY, + MCAL_RECUR_MONTHLY_WDAY, + MCAL_RECUR_YEARLY, + MCAL_JANUARY, + MCAL_FEBRUARY, + MCAL_MARCH, + MCAL_APRIL, + MCAL_MAY, + MCAL_JUNE, + MCAL_JULY, + MCAL_AUGUGT, + MCAL_SEPTEMBER, + MCAL_OCTOBER, + MCAL_NOVEMBER, et + MCAL_DECEMBER. + La plus part des fonctions utilisent une structure d'événement + interne, qui est unique pour chaque connexion. Cela évite + d'avoir à passer des objets de grande taille entre les + fonctions. Il y a des accesseurs bien pratiques pour créer, + initialiser et lire des objets événements. + </para> + </partintro> + <refentry id="function.mcal-open"> + <refnamediv> + <refname>mcal_open</refname> + <refpurpose>Ouvre une connexion MCAL.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_open</function></funcdef> + <paramdef>string <parameter>calendar</parameter></paramdef> + <paramdef>string <parameter>username</parameter></paramdef> + <paramdef>string <parameter>password</parameter></paramdef> + <paramdef>int <parameter>options</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Retourne un flot MCAL en cas de succès, et FALSE en cas d'erreur. + </para> + <para> + <function>mcal_open</function> ouvre une connexion MCAL au serveur + <parameter>calendar</parameter>. Si <parameter>options</parameter> + est spécifié, passe aussi <parameter>options</parameter> + à la boîte aux lettres (???). La structure interne du + flot MCAL est initialisée à la connnexion. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-popen"> + <refnamediv> + <refname>mcal_popen</refname> + <refpurpose>Ouvre une connexion persistante MCAL.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_popen</function></funcdef> + <paramdef>string <parameter>calendar</parameter></paramdef> + <paramdef>string <parameter>username</parameter></paramdef> + <paramdef>string <parameter>password</parameter></paramdef> + <paramdef>int <parameter>options</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Retourne un flot MCAL en cas de succès, et FALSE sinon. + </para> + <para> + <function>mcal_popen</function> ouvre une connexion MCAL au serveur + de calendrier <parameter>calendar</parameter>. Si les options + <parameter>options</parameter> sont spécifiées, elles sont aussi + passé à cette boîte au lettre. La structure interne du + flot est aussi initialisée. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-reopen"> + <refnamediv> + <refname>mcal_reopen</refname> + <refpurpose>Réouvre une connexion MCAL</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_reopen</function></funcdef> + <paramdef>string <parameter>calendar</parameter></paramdef> + <paramdef>int <parameter>options</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Réouvre une connexion MCAL. + </para> + <para> + <function>mcal_reopen</function> réouvre une connexion + MCAL avec le serveur <parameter>calendar</parameter>. Si les options + <parameter>options</parameter> sont spécifiées, elles sont aussi + passé à cette boîte au lettre. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-close"> + <refnamediv> + <refname>mcal_close</refname> + <refpurpose>Ferme une connexion MCAL.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_close</function></funcdef> + <paramdef>int <parameter>mcal_stream</parameter></paramdef> + <paramdef>int <parameter>flags</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Ferme la connexion. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-create-calendar"> + <refnamediv> + <refname>mcal_create_calendar</refname> + <refpurpose>Crée un nouveau calendrier</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>stream</function></funcdef> + <paramdef>string <parameter>calendar</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Crée un nouveau calendrier nommé <parameter>calendar</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-rename-calendar"> + <refnamediv> + <refname>mcal_rename_calendar</refname> + <refpurpose>Renomme un calendrier</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>stream</function></funcdef> + <paramdef>string <parameter>old_name</parameter></paramdef> + <paramdef>string <parameter>new_name</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>stream</function> renomme le calendrier + <parameter>old_name</parameter> en <parameter>new_name</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-delete-calendar"> + <refnamediv> + <refname>mcal_delete_calendar</refname> + <refpurpose>Efface un calendrier</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>stream</function></funcdef> + <paramdef>string <parameter>calendar</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>stream</function> efface le calendrier <parameter>calendar</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-fetch-event"> + <refnamediv> + <refname>mcal_fetch_event</refname> + <refpurpose> + Recherche un événement dans le calendrier. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>object <function>mcal_fetch_event</function></funcdef> + <paramdef>int <parameter>mcal_stream</parameter></paramdef> + <paramdef>int <parameter>event_id</parameter></paramdef> + <paramdef>int <parameter><optional>options</optional></parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_fetch_event</function> recherche un + évenement dans le calendrier spécifié + par <parameter>id</parameter>. + </para> + <para> + Retourne un objet événement dont les attributs sont : + <itemizedlist> + <listitem><simpara> + int id - ID de l'événement.</simpara></listitem> + <listitem><simpara> + int public - TRUE si l'événement est public, FALSE si il est privé.</simpara></listitem> + <listitem><simpara> + string category - Catégorie de l'événement.</simpara></listitem> + <listitem><simpara> + string title - Titre de l'événement.</simpara></listitem> + <listitem><simpara> + string description - Description de l'événement.</simpara></listitem> + <listitem><simpara> + int alarm - Nombre de minutes avant d'envoyer une alerte pour cet événement.</simpara></listitem> + <listitem><simpara> + object start - Objet contenant une date et une heure.</simpara></listitem> + <listitem><simpara> + object end - Objet contenant une date et une heure.</simpara></listitem> + <listitem><simpara> + int recur_type - type de récurence</simpara></listitem> + <listitem><simpara> + int recur_interval - intervalle de récurence</simpara></listitem> + <listitem><simpara> + datetime recur_endate - date de fin de récurence</simpara></listitem> + <listitem><simpara> + int recur_data - données de récurence</simpara></listitem> + </itemizedlist> + Tous les objets de date et heure sont construits comme suit : + <itemizedlist> + <listitem><simpara> + int year - année</simpara></listitem> + <listitem><simpara> + int month - mois</simpara></listitem> + <listitem><simpara> + int mday - jour du mois</simpara></listitem> + <listitem><simpara> + int hour - heure</simpara></listitem> + <listitem><simpara> + int min - minutes</simpara></listitem> + <listitem><simpara> + int sec - secondes</simpara></listitem> + <listitem><simpara> + int alarm - nombre de minutes avant de déclencher l'alarme</simpara></listitem> + </itemizedlist> + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-list-events"> + <refnamediv> + <refname>mcal_list_events</refname> + <refpurpose> + Retourne une liste d'événement entre deux dates. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>mcal_list_events</function></funcdef> + <paramdef>int <parameter>mcal_stream</parameter></paramdef> + <paramdef>object<parameter>begin_date</parameter></paramdef> + <paramdef>object + <parameter><optional>end_date</optional></parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_list_events</function> retourne un tableau + d'identifiants d'événéments, compris + entre deux dates. + </para> + <para> + <function>mcal_list_events</function> prend une date de + début et une date de fin. Un tableau d'identifiants + est retourné. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-append-event"> + <refnamediv> + <refname>mcal_append_event</refname> + <refpurpose> + Enregistre un nouvel événement dans un calendrier MCAL. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_append_event</function></funcdef> + <paramdef>int <parameter>mcal_stream</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_append_event</function> enregistre + l'événement global dans le calendrier + MCAL <parameter>mcal_stream</parameter>. + </para> + <para> + Retourne l'uid de l'enregistement ainsi inséré. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-store-event"> + <refnamediv> + <refname>mcal_store_event</refname> + <refpurpose> + Modifie un événement dans un calendrier MCAL. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_store_event</function></funcdef> + <paramdef>int <parameter>mcal_stream</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_store_event</function> enregistre + l'événement global dans le calendrier + MCAL <parameter>mcal_stream</parameter>. + </para> + <para> + Retourne TRUE en cas de succès, et FALSE en cas d'erreur. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-delete-event"> + <refnamediv> + <refname>mcal_delete_event</refname> + <refpurpose> + Efface un événement dans un calendrier MCAL. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_delete_event</function></funcdef> + <paramdef>int <parameter>mcal_stream</parameter></paramdef> + <paramdef>int <parameter><optional>event_id</optional></parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_delete_event</function> efface + l'événement d'identifiant <parameter>uid</parameter>. + </para> + <para> + Retourne TRUE. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-snooze"> + <refnamediv> + <refname>mcal_snooze</refname> + <refpurpose>Eteind l'alarme d'un événement.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_snooze</function></funcdef> + <paramdef>int <parameter>id</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_snooze</function> éteind l'alarme de + l'événement identifié par l'UID + <parameter>uid</parameter>. + </para> + <para> + Retourne TRUE. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-list-alarms"> + <refnamediv> + <refname>mcal_list_alarms</refname> + <refpurpose> + Retourne une liste d'événements qui ont une alarme + prévue à une date. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>mcal_list_events</function></funcdef> + <paramdef>int <parameter>mcal_stream</parameter></paramdef> + <paramdef>int + <parameter><optional>begin_year</optional></parameter> + </paramdef> + <paramdef>int + <parameter><optional>begin_month</optional></parameter> + </paramdef> + <paramdef>int + <parameter><optional>begin_day</optional></parameter> + </paramdef> + <paramdef>int + <parameter><optional>end_year</optional></parameter> + </paramdef> + <paramdef>int + <parameter><optional>end_month</optional></parameter> + </paramdef> + <paramdef>int + <parameter><optional>end_day</optional></parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + <para> + Retourne un tableau d'identifiants, qui ont une alarme de + prévue à la date <parameter>alarm_date</parameter>. + Si seul le flot MCAL est donné, la date de début et + de fin de la structure globale sera utilisée. + </para> + <para> + <function>mcal_list_events</function> prend une date, et retourne un tableau + d'identifiants. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-init"> + <refnamediv> + <refname>mcal_event_init</refname> + <refpurpose> + Initialise la structure globale d'un flot. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_event_init</function></funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_init</function> initialise la structure + globale d'un flot. Cela remet tous les éléments + de la structure à 0, ou à leur valeur par défaut. + </para> + <para> + Retourne TRUE. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-set-category"> + <refnamediv> + <refname>mcal_event_set_category</refname> + <refpurpose> + Fixe la catégorie de la structure globale. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_event_set_category</function></funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>string <parameter>category</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_set_category</function> fixe la + catégorie de la structure globale à la + valeur de <parameter>category</parameter>. + </para> + <para> + Retourne TRUE. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-set-title"> + <refnamediv> + <refname>mcal_event_set_title</refname> + <refpurpose> + fixe le titre de la structure globale. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_event_set_title</function></funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>string <parameter>title</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_set_title</function> fixe le titre de + la structure globale à la valeur de <parameter>title</parameter>. + </para> + <para> + Retourne TRUE. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-set-description"> + <refnamediv> + <refname>mcal_event_set_description</refname> + <refpurpose> + Fixe la déscription de la structure globale. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>mcal_event_set_description</function> + </funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>string <parameter>description</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_set_description</function> fixe la + catégorie de la structure globale à la + valeur de <parameter>description</parameter>. + </para> + <para> + Returns TRUE. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-set-start"> + <refnamediv> + <refname>mcal_event_set_start</refname> + <refpurpose> + Fixe les dates de début et de fin de la structure globale. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_event_set_start</function></funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>int <parameter>year</parameter></paramdef> + <paramdef>int <parameter>month</parameter></paramdef> + <paramdef>int + <parameter> + <optional>day</optional> + </parameter> + </paramdef> + <paramdef>int + <parameter> + <optional>hour</optional> + </parameter> + </paramdef> + <paramdef>int + <parameter> + <optional>min</optional></parameter> + </paramdef> + <paramdef>int + <parameter> + <optional>sec</optional> + </parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_set_start</function> fixe la date de + début de la structure globale. + </para> + <para> + Retourne TRUE. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-set-end"> + <refnamediv> + <refname>mcal_event_set_end</refname> + <refpurpose> + Fixe la date de fin de la structure globale. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_event_set_end</function></funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>int <parameter>year</parameter></paramdef> + <paramdef>int <parameter>month</parameter></paramdef> + <paramdef>int + <parameter> + <optional>day</optional> + </parameter> + </paramdef> + <paramdef>int + <parameter> + <optional>hour</optional> + </parameter> + </paramdef> + <paramdef>int + <parameter> + <optional>min</optional> + </parameter> + </paramdef> + <paramdef>int + <parameter> + <optional>sec</optional> + </parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_set_end</function> fixe la date de fin de la structure + globale. + </para> + <para> + Returns TRUE. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-set-alarm"> + <refnamediv> + <refname>mcal_event_set_alarm</refname> + <refpurpose> + Fixe l'alarme de la structure globale. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_event_set_alarm</function></funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>int <parameter>alarm</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_set_alarm</function> fixe l'alarme de la + structure globale,à un nombre de minutes avant + déclenchement. + </para> + <para> + Retourne TRUE. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-set-class"> + <refnamediv> + <refname>mcal_event_set_class</refname> + <refpurpose> + Fixe la classe de la structure globale. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_event_set_class</function></funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>int <parameter>class</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_set_class</function> fixe la classe de + la structure globale. La classe vaut 0 pour public, et 1 + pour privée. + </para> + <para> + Retourne TRUE. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-is-leap-year"> + <refnamediv> + <refname>mcal_is_leap_year</refname> + <refpurpose> + Vérifie que l'année est bissextile. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_is_leap_year</function></funcdef> + <paramdef>int <parameter>year</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_is_leap_year</function> retoune 1 si l'année + <parameter>year</parameter> est bissextile, et 0 sinon. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-days-in-month"> + <refnamediv> + <refname>mcal_days_in_month</refname> + <refpurpose> + Retourne le nombre de jour d'un mois. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_days_in_month</function></funcdef> + <paramdef>int <parameter>month</parameter></paramdef> + <paramdef>int <parameter>leap year</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_days_in_month</function> retourne le nombre + de jour du mois <parameter>month</parameter>, et prend en + compte le fait que l'année est bissextile avec le + paramètre <parameter>leap year</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-date-valid"> + <refnamediv> + <refname>mcal_date_valid</refname> + <refpurpose> + Valide une date. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_date_valid</function></funcdef> + <paramdef>int <parameter>year</parameter></paramdef> + <paramdef>int <parameter>month</parameter></paramdef> + <paramdef>int <parameter>day</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_date_valid</function> retourne TRUE si la + date (constituée par l'année <parameter>year</parameter>, + le mois <parameter>month</parameter> et la date + <parameter>day</parameter>) est valide, et FALSE sinon. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-time-valid"> + <refnamediv> + <refname>mcal_time_valid</refname> + <refpurpose> + Valide une heure. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_time_valid</function></funcdef> + <paramdef>int <parameter>hour</parameter></paramdef> + <paramdef>int <parameter>minutes</parameter></paramdef> + <paramdef>int <parameter>seconds</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_time_valid</function> retourne TRUE si + l'heure (constituée par l'heure <parameter>hour</parameter>, + les minutes <parameter>minutes</parameter> et les secondes + <parameter>seconds</parameter>) est une heure valide, et FALSE sinon. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-day-of-week"> + <refnamediv> + <refname>mcal_day_of_week</refname> + <refpurpose> + Le jour de la semaine. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_</function></funcdef> + <paramdef>int <parameter>year</parameter></paramdef> + <paramdef>int <parameter>month</parameter></paramdef> + <paramdef>int <parameter>day</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_day_of_week</function> retourne le jour de + la semaine, pour la date constituée par l'année + <parameter>year</parameter>, le mois <parameter>month</parameter> + et la date <parameter>day</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-day-of-year"> + <refnamediv> + <refname>mcal_day_of_year</refname> + <refpurpose> + Le jour de l'année. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_</function></funcdef> + <paramdef>int <parameter>year</parameter></paramdef> + <paramdef>int <parameter>month</parameter></paramdef> + <paramdef>int <parameter>day</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_day_of_year</function> retourne le numéro + de jour dans l'année pour la date constituée par + l'année <parameter>year</parameter>, le mois + <parameter>month</parameter> et la date <parameter>day</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-date-compare"> + <refnamediv> + <refname>mcal_date_compare</refname> + <refpurpose>Compare deux dates.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_date_compare</function></funcdef> + <paramdef>int <parameter>a_year</parameter></paramdef> + <paramdef>int <parameter>a_month</parameter></paramdef> + <paramdef>int <parameter>a_day</parameter></paramdef> + <paramdef>int <parameter>b_year</parameter></paramdef> + <paramdef>int <parameter>b_month</parameter></paramdef> + <paramdef>int <parameter>b_day</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_date_compare</function> compares les deux + dates données, et retourne <0, 0, >0 si a<b, + a==b, a>b respectivement. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-next-recurrence"> + <refnamediv> + <refname>mcal_next_recurrence</refname> + <refpurpose> + Retourne la prochaine occurence d'une événement. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>mcal_next_recurrence</function></funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>int <parameter>weekstart</parameter></paramdef> + <paramdef>array <parameter>next</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_next_recurrence</function> retourne un objet + contenant la prochaine date de l'événement, ou + la date de l'événement suivant la date. Retourne + un objet date vide si l'événement n'a pas de + réoccurence, ou si quelquechose est invalide. Utilisez + <parameter>weekstart</parameter> pour déterminer le premier jour. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-set-recur-none"> + <refnamediv> + <refname>mcal_event_set_recur_none</refname> + <refpurpose> + Supprime la récurence de la structure globale. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>mcal_event_set_recur_none</function> + </funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_set_recur_none</function> supprime la + récurence de la structure globale (event->recur_type + est mis à MCAL_RECUR_NONE). + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-set-recur-daily"> + <refnamediv> + <refname>mcal_event_set_recur_daily</refname> + <refpurpose> + Fixe la récurence quotidienne. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>mcal_event_set_recur_daily</function> + </funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>int <parameter>year</parameter></paramdef> + <paramdef>int <parameter>month</parameter></paramdef> + <paramdef>int <parameter>day</parameter></paramdef> + <paramdef>int <parameter>interval</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_set_recur_daily</function> fixe la récurence + quotidienne de la structure globale, jusqu'à la date passée + en paramètre. (la date de début est celle de la structure). + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-set-recur-weekly"> + <refnamediv> + <refname>mcal_event_set_recur_weekly</refname> + <refpurpose> + Fixe la récurence hedbomadaire. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>mcal_event_set_recur_weekly</function> + </funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>int <parameter>year</parameter></paramdef> + <paramdef>int <parameter>month</parameter></paramdef> + <paramdef>int <parameter>day</parameter></paramdef> + <paramdef>int <parameter>interval</parameter></paramdef> + <paramdef>int <parameter>weekdays</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_set_recur_weekly</function> fixe la + récurence hedbomadaire de la structure globale, + jusqu'à la date passée en paramètre. + (la date de début est celle de la structure). + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-set-recur-monthly-mday"> + <refnamediv> + <refname>mcal_event_set_recur_monthly_mday</refname> + <refpurpose> + Fixe la récurence. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>mcal_event_set_recur_monthly_mday</function> + </funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>int <parameter>year</parameter></paramdef> + <paramdef>int <parameter>month</parameter></paramdef> + <paramdef>int <parameter>day</parameter></paramdef> + <paramdef>int <parameter>interval</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_set_recur_monthly_mday</function> fixe la + récurence de la structure globale, jusqu'à la date + passée en paramètre. (la date de début est + celle de la structure). + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-set-recur-monthly-wday"> + <refnamediv> + <refname>mcal_event_set_recur_monthly_wday</refname> + <refpurpose> + fixe la récurence mensuelle. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>mcal_event_set_recur_monthly_wday</function> + </funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>int <parameter>year</parameter></paramdef> + <paramdef>int <parameter>month</parameter></paramdef> + <paramdef>int <parameter>day</parameter></paramdef> + <paramdef>int <parameter>interval</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_set_recur_monthly_wday</function> fixe la + récurence mensuelle de la structure globale, jusqu'à + la date passée en paramètre. (la date de début + est celle de la structure). + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-set-recur-yearly"> + <refnamediv> + <refname>mcal_event_set_recur_yearly</refname> + <refpurpose> + fixe la récurence annuelle. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>mcal_event_set_recur_yearly</function> + </funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>int <parameter>year</parameter></paramdef> + <paramdef>int <parameter>month</parameter></paramdef> + <paramdef>int <parameter>day</parameter></paramdef> + <paramdef>int <parameter>interval</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_set_recur_yearly</function> fixe la + récurence annuelle de la structure globale, + jusqu'à la date passée en paramètre. + (la date de début est celle de la structure). + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-fetch-current-stream-event"> + <refnamediv> + <refname>mcal_fetch_current_stream_event</refname> + <refpurpose> + Retourne un objet contenant la structure de date pour le flot courant. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>mcal_fetch_current_stream_event</function> + </funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_fetch_current_stream_event</function> retourne + la structure de la date du flot courant sous la forme d'un + objet, qui contient : + <itemizedlist> + <listitem><simpara> + int id - ID de l'événement.</simpara></listitem> + <listitem><simpara> + int public - TRUE si l'événement est public, FALSE si il est privé.</simpara></listitem> + <listitem><simpara> + string category - Catégorie de l'événement.</simpara></listitem> + <listitem><simpara> + string title - Titre de l'événement.</simpara></listitem> + <listitem><simpara> + string description - Description de l'événement.</simpara></listitem> + <listitem><simpara> + int alarm - Nombre de minutes avant d'envoyer une alerte pour cet événement.</simpara></listitem> + <listitem><simpara> + object start - Objet contenant une date et une heure.</simpara></listitem> + <listitem><simpara> + object end - Objet contenant une date et une heure.</simpara></listitem> + <listitem><simpara> + int recur_type - type de récurence</simpara></listitem> + <listitem><simpara> + int recur_interval - intervalle de récurence</simpara></listitem> + <listitem><simpara> + datetime recur_endate - date de fin de récurence</simpara></listitem> + <listitem><simpara> + int recur_data - données de récurence</simpara></listitem> + </itemizedlist> + Tous les objets de date et heure sont construits comme suit : + <itemizedlist> + <listitem><simpara> + int year - année</simpara></listitem> + <listitem><simpara> + int month - mois</simpara></listitem> + <listitem><simpara> + int mday - jour du mois</simpara></listitem> + <listitem><simpara> + int hour - heure</simpara></listitem> + <listitem><simpara> + int min - minutes</simpara></listitem> + <listitem><simpara> + int sec - secondes</simpara></listitem> + <listitem><simpara> + int alarm - nombre de minutes avant de déclencher l'alarme</simpara></listitem> + </itemizedlist></para> + </refsect1> + </refentry> + <refentry id="function.mcal-event-add-attribute"> + <refnamediv> + <refname>mcal_event_add_attribute</refname> + <refpurpose> + Ajoute un attribut et une valeur à la structure globale + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>void + <function>mcal_event_add_attribute</function> + </funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + <paramdef>string <parameter>attribute</parameter></paramdef> + <paramdef>string <parameter>value</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_event_add_attribute</function> ajoute l'attribut + <parameter>attribute</parameter> à la structure globale, + avec la valeur <parameter>value</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.mcal-expunge"> + <refnamediv> + <refname>mcal_expunge</refname> + <refpurpose> + Supprime tous les événements marqués pour l'effacement + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int + <function>mcal_expunge</function> + </funcdef> + <paramdef>int <parameter>stream</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>mcal_expunge</function> supprime tous les événements + marqués pour l'effacement. + </para> + </refsect1> + </refentry> +</reference> +<!-- 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 +sgml-parent-document:nil +sgml-default-dtd-file:"../manual.ced" +sgml-exposed-tags:nil +sgml-local-catalogs:nil +sgml-local-ecat-files:nil +End: +-->