Forum und email

mcal_fetch_event

(PHP 4)

mcal_fetch_event — Recherche un événement dans le calendrier

Description

object mcal_fetch_event ( int $mcal_stream , int $event_id [, int $options ] )

mcal_fetch_event() recherche un événement dans le calendrier spécifié par id .

mcal_fetch_event() retourne un objet événement dont les attributs sont :

  • int id - ID de l'événement.
  • int public - TRUE si l'événement est public, FALSE s'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 jour (i.e., le troisième samedi du mois)
  • 5 - Indique que l'événement se répète tous les ans