LIII_ MCAL functions

MCAL stands for Modular Calendar Access Library_

Libmcal is a C library for accessing calendars_ It's written to be very modular, with plugable drivers_ MCAL is the calendar equivalent of the IMAP module for mailboxes_

With mcal support, a calendar stream can be opened much like the mailbox stream with the IMAP support_ Calendars can be local file stores, remote ICAP servers, or other formats that are supported by the mcal library_

Calendar events can be pulled up, queried, and stored_ There is also support for calendar triggers (alarms) and reoccuring events_

With libmcal, central calendar servers can be accessed and used, removing the need for any specific database or local file programming_

To get these functions to work, you have to compile PHP with __with_mcal_ That requires the mcal library to be installed_ Grab the latest version from http://mcal_chek_com/ and compile and install it_

The following constants are defined when using the MCAL module: 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, and MCAL_DECEMBER_ Most of the functions use an internal event structure that is unique for each stream_ This alleviates the need to pass around large objects between functions_ There are convenience functions for setting, initializing, and retrieving the event structure values_

Tabla de contenidos
mcal_append_event __ Store a new event into an MCAL calendar
mcal_close __ Close an MCAL stream
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 __ Fetches an event from the calendar 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 __ Return a list of events between two given datetimes
mcal_next_recurrence __ Returns the next recurrence of the event
mcal_open __ Opens up an MCAL connection
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