LIV. MCAL Funktionen

MCAL bedeutet Modular Calendar Access Library.

Libmcal ist eine C Bibliothek für den Zugriff auf Kalender. Sie ist sehr modular programmiert, mit austauschbaren Treibern. MCAL ist das Kalendergegenstück zum IMAP Modul für Mailboxen.

Mit Hilfe der mcal-Unterstützung kann ein Kalender-Stream, ähnlich wie ein Mailbox-Stream mit der IMAP-Unterstützung, geöffnet werden. Kalender können lokale Dateispeicher, entfernte ICAP-Server oder andere Formate,von der mcal-Bibliothek unterstützt werden, sein.

Kalendereinträge können aufgerufen, abgefragt und gespeichert werden. Desweiteren werden Kalendertermine (Alarm) und wiederkehrende Termine unterstützt.

Mit libmcal kann auf zentrale Kalenderserver zugegriffen und diese benutzt werden, was die Programmierung einer bestimmten Datenbank oder einer Datei unnötig macht.

Um diese Funktionen benutzen zu können, muß PHP mit der Option --with-mcal kompiliert werden. Dies setzt eine installierte mcal-Bibliothek vorraus. Holen Sie sich die aktuelle Version unter http://mcal.chek.com/ und kompilieren und installieren Sie sie.

Die folgenden Konstanten werden definiert, wenn das mcal-Modul verwendet wird: Für Wochentage:

MCAL_SUNDAY
MCAL_MONDAY
MCAL_TUESDAY
MCAL_WEDNESDAY
MCAL_THURSDAY
MCAL_FRIDAY
MCAL_SATURDAY

Für wiederkehrende Termine :

MCAL_RECUR_NONE
MCAL_RECUR_DAILY
MCAL_RECUR_WEEKLY
MCAL_RECUR_MONTHLY_MDAY
MCAL_RECUR_MONTHLY_WDAY
MCAL_RECUR_YEARLY

Für Monate:

MCAL_JANUARY
MCAL_FEBRUARY
MCAL_MARCH
MCAL_APRIL
MCAL_MAY
MCAL_JUNE
MCAL_JULY
MCAL_AUGUST
MCAL_SEPTEMBER
MCAL_OCTOBER
MCAL_NOVEMBER
MCAL_DECEMBER

Die meisten dieser Funktionen benutzen eine interne Ereignisstruktur, die einzigartig für jeden Stream ist. Dies vermindert die Notwendigkeit, große Objekte zwischen Funktionen auszutauschen. Es gibt Hilfsfunktionen für Einstellung, Initialisierung und Abruf der Ereignisstruktur.

Inhaltsverzeichnis
mcal_append_event -- Store a new event into an MCAL calendar
mcal_close -- Schließen eines MCAL-Streams
mcal_create_calendar -- Create a new MCAL calendar
mcal_date_compare -- Compares two dates
mcal_date_valid -- Returns TRUE if the given year, month, day is a valid date
mcal_day_of_week -- Returns the day of the week of the given date
mcal_day_of_year -- Returns the day of the year of the given date
mcal_days_in_month -- Returns the number of days in the given month
mcal_delete_calendar -- Delete an MCAL calendar
mcal_delete_event -- Delete an event from an MCAL calendar
mcal_event_add_attribute -- Adds an attribute and a value to the streams global event structure
mcal_event_init -- Initializes a streams global event structure
mcal_event_set_alarm -- Sets the alarm of the streams global event structure
mcal_event_set_category -- Sets the category of the streams global event structure
mcal_event_set_class -- Sets the class of the streams global event structure
mcal_event_set_description -- Sets the description of the streams global event structure
mcal_event_set_end -- Sets the end date and time of the streams global event structure
mcal_event_set_recur_daily -- Sets the recurrence of the streams global event structure
mcal_event_set_recur_monthly_mday -- Sets the recurrence of the streams global event structure
mcal_event_set_recur_monthly_wday -- Sets the recurrence of the streams global event structure
mcal_event_set_recur_none -- Sets the recurrence of the streams global event structure
mcal_event_set_recur_weekly -- Sets the recurrence of the streams global event structure
mcal_event_set_recur_yearly -- Sets the recurrence of the streams global event structure
mcal_event_set_start -- Sets the start date and time of the streams global event structure
mcal_event_set_title -- Sets the title of the streams global event structure
mcal_expunge -- Deletes all events marked for being expunged.
mcal_fetch_current_stream_event -- Returns an object containing the current streams event structure
mcal_fetch_event -- Holt ein Ereignis aus einem Kalender-Stream.
mcal_is_leap_year -- Returns if the given year is a leap year or not
mcal_list_alarms -- Return a list of events that has an alarm triggered at the given datetime
mcal_list_events -- Zeigt eine Liste der Einträge zwischen zwei Zeitpunkten an
mcal_next_recurrence -- Returns the next recurrence of the event
mcal_open -- Stellt eine MCAL-Verbindung her
mcal_popen -- Opens up a persistent MCAL connection
mcal_rename_calendar -- Rename an MCAL calendar
mcal_reopen -- Reopens an MCAL connection
mcal_snooze -- Turn off an alarm for an event
mcal_store_event -- Modify an existing event in an MCAL calendar
mcal_time_valid -- Returns TRUE if the given year, month, day is a valid time
mcal_week_of_year -- Returns the week number of the given date