Introduction

MCAL stands for Modular Calendar Access Library.

Libmcal is a C library for accessing calendars. It's written to be very modular, with pluggable 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 recurring events.

With libmcal, central calendar servers can be accessed, removing the need for any specific database or local file programming.

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.

Note: This extension has been moved to the » PECL repository and is no longer bundled with PHP as of PHP 5.0.0.

Note: PHP had an ICAP extension previously, but the original library and the PHP extension is not supported anymore. The suggested replacement is MCAL.

Note: This extension is not available on Windows platforms.

Requirements

This extension requires the mcal library to be installed. Grab the latest version from » http://mcal.chek.com/ and compile and install it.

Installation

After you installed the mcal library, to get these functions to work, you have to compile PHP -with-mcal[=DIR].

Runtime Configuration

This extension has no configuration directives defined in php.ini.

Resource Types

This extension has no resource types defined.

Predefined Constants

The constants below are defined by this extension, and will only be available when the extension has either been compiled into PHP or dynamically loaded at runtime.

Table of Contents

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 a 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 IDs for a date or a range of dates

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 hour, minutes and seconds is a valid time

mcal_week_of_year — Returns the week number of the given date