MCAL functions

PHP Manual
Prev |  | Next

# LIII. MCAL functions

# 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: PHP had an ICAP extension previously, but the original library and the PHP extension is not supported anymore. The suggested replacement is MCAL.

# 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 `--with-mcal`.

# 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.

`MCAL_SUNDAY` (integer)

`MCAL_MONDAY` (integer)

`MCAL_TUESDAY` (integer)

`MCAL_WEDNESDAY` (integer)

`MCAL_THURSDAY` (integer)

`MCAL_FRIDAY` (integer)

`MCAL_SATURDAY` (integer)

`MCAL_JANUARY` (integer)

`MCAL_FEBRUARY` (integer)

`MCAL_MARCH` (integer)

`MCAL_APRIL` (integer)

`MCAL_MAY` (integer)

`MCAL_JUNE` (integer)

`MCAL_JULY` (integer)

`MCAL_AUGUST` (integer)

`MCAL_SEPTEMBER` (integer)

`MCAL_OCTOBER` (integer)

`MCAL_NOVEMBER` (integer)

`MCAL_DECEMBER` (integer)

`MCAL_RECUR_NONE` (integer)

`MCAL_RECUR_DAILY` (integer)

`MCAL_RECUR_WEEKLY` (integer)

`MCAL_RECUR_MONTHLY_MDAY` (integer)

`MCAL_RECUR_MONTHLY_WDAY` (integer)

`MCAL_RECUR_YEARLY` (integer)

`MCAL_M_SUNDAY` (integer)

`MCAL_M_MONDAY` (integer)

`MCAL_M_TUESDAY` (integer)

`MCAL_M_WEDNESDAY` (integer)

`MCAL_M_THURSDAY` (integer)

`MCAL_M_FRIDAY` (integer)

`MCAL_M_SATURDAY` (integer)

`MCAL_M_WEEKDAYS` (integer)

`MCAL_M_WEEKEND` (integer)

`MCAL_M_ALLDAYS` (integer)

Prev | Home | Next
mb_substr | Up | mcal_append_event