Google

NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.73 ">

mcal_fetch_current_stream_event

(PHP 3>= 3.0.13, PHP 4 )

mcal_fetch_current_stream_event --  Retourne un objet contenant la structure de date pour le flot courant.

Description

object mcal_fetch_current_stream_event ( resource mcal_stream)

mcal_fetch_current_stream_event() retourne la structure de la date du flot courant sous la forme d'un objet, qui contient :

  • int id - ID de l'événement.

  • int public - TRUE si l'événement est public, FALSE si il est privé.

  • string category - Catégorie de l'événement.

  • string title - Titre de l'événement.

  • string description - Description de l'événement.

  • int alarm - Nombre de minutes avant d'envoyer une alerte pour cet événement.

  • object start - Objet contenant une date et une heure.

  • object end - Objet contenant une date et une heure.

  • int recur_type - type de récurrence

  • int recur_interval - intervalle de récurrence

  • datetime recur_endate - date de fin de récurrence

  • int recur_data - données de récurrence

Tous les objets de date et heure sont construits comme suit :

  • int year - année

  • int month - mois

  • int mday - jour du mois

  • int hour - heure

  • int min - minutes

  • int sec - secondes

  • int alarm - nombre de minutes avant de déclencher l'alarme

Les valeurs possibles de recur_type sont :

  • 0 - Indique que l'événement ne se répète jamais

  • 1 - Indique que l'événement se répète tous les jours

  • 2 - Indique que l'événement se répète toutes les semaines

  • 3 - Indique que l'événement se répète tous les mois, à la même date (le 10 du mois)

  • 4 - Indique que l'événement se répète tous les mois, un certain jours (i.e., le troisième samedi du mois)

  • 5 - Indique que l'événement se répète tous les ans