PHP: MCAL Functions - Manual

downloads | documentation | faq | getting help | mailing lists | reporting bugs | php.net sites | links | conferences | my php.net

search for in the

mcal_append_event maxdb_warning_count

Last updated: Fri, 26 Jan 2007

view this page in

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

> Замечание: This extension has been moved to the PECL repository and is no longer bundled with PHP as of PHP 5.0.0.

> Замечание: PHP had an ICAP extension previously, but the original library and the PHP extension is not supported anymore. The suggested replacement is MCAL.

> Замечание: Для Windows-платформ это расширение недоступно.

# Требования

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

# Установка

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

# Настройка во время выполнения

Данное расширение не определяет никакие директивы конфигурации в `php.ini`.

# Типы ресурсов

Данное расширение не определяет никакие типы ресурсов.

# Предопределенные константы

Перечисленные ниже константы определены данным расширением и могут быть доступны только в том случае, если PHP был собран с поддержкой этого расширения или же в том случае, если данное расширение подгружается во время выполнения.

`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)

add a note User Contributed Notes
MCAL Functions
verdy_p at wanadoo dot fr
12-May-2002 11:55
`Correction to previous extensive note:
ANDing distinct bit values will always result in zero, so your weekly events won't ever be raised. You must use the bitwise-or operator (|) to combine several week days.
mcal_event_set_recur_weekly takes an additional integer parameter
"weekdays" which is basicly a binary mask created by bitwise
ORing together integers representing the days of the week.
Sunday = 1
Monday = 2
Tuesday = 4
Wednesday = 8
Thursday = 16
Friday = 32
Saturday = 64
So if I wanted the value needed to raise the event every "Monday, Wednesday, and Friday" I would do this:
$weekdays = 2 | 8 | 32;`
jeff at univrel dot pr dot uconn dot edu
03-Jul-2001 12:03
`As of 7/3/2001, libmcal can be built shared (libmcal.so), which should get rid of the linking problem with the MySQL driver. Check the latest version out of the repository if you're planning on building it this way.`
lurker at shadowtech dot org
23-Dec-2000 01:04
`After a thorough search of the web for documentation of how recurence works in MCAL, or even for documentation of the recurence function parameters, I found nothing. So, I gave up and dove into the MCAL source code for answers, and this is what I have found. Please keep in mind that this is all "As far as I can tell" information.
First of all, I believe that mcal_list_events DOES return events that recur in the range being searched.
The mcal_event_set_recur_* functions take in an mcal stream, and date for the event to stop recuring by (given by day, month, year), and an "interval".
mcal_event_set_recur_weekly takes an additional integer parameter "weekdays" which is basicly a binary mask created by bitwise ANDing together integers representing the days of the week.
Sunday = 1
Monday = 2
Tuesday = 4
Wednesday = 8
Thursday = 16
Friday = 32
Saturday = 64
So if I wanted the value that represented "Monday, Wednesday, and Friday" I would do this:
$weekdays = 2 & 8 & 32;
Here is how to interpret "interval" and "weekdays".
For mcal_event_set_recur_daily:
This event should recur every "interval" days.
For mcal_event_set_recur_weekly:
This event should recur on every day specified in "weekdays", and should do so every "interval" weeks.
For mcal_event_set_recur_monthly_mday:
This event should recur on the "interval" day of every month.
For mcal_event_set_recur_monthly_wday:
This event should recur every on every Xday of the Yth week of the month, every "interval" months. (Where Xday is a day of the week, e.g. Monday, Tuesday, etc. Note: This is the one I am the least sure about though it seems to be the logical assumption for how it should work based on the fact that there are two monthly functions and the other one's operation is intuitive.)
For mcal_event_set_recur_yearly:
This event should recur every "interval" years.`
inan at canada dot com
25-Mar-2000 03:59
`MCAL is a great little package, but has changed quite a bit since the documentation has been updated. If you're having trouble stop by mcal.chek.com and pop a question onto the mcal users mailing list and we'll be happy to help you out.`
add a note
mcal_append_event maxdb_warning_count

Last updated: Fri, 26 Jan 2007
show source | credits | stats | sitemap | contact | advertising | mirror sites
Copyright © 2001-2007 The PHP Group
All rights reserved.
This mirror generously provided by: Yahoo! Inc.
Last updated: Sat Mar 10 10:36:09 2007 PST