<HTML
><HEAD
><TITLE
>MCAL functions</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
REL="HOME"
TITLE="PHP Manual"
HREF="index.html"><LINK
REL="UP"
TITLE="Function Reference"
HREF="funcref.html"><LINK
REL="PREVIOUS"
TITLE="mb_substr"
HREF="function.mb-substr.html"><LINK
REL="NEXT"
TITLE="mcal_append_event"
HREF="function.mcal-append-event.html"><META
HTTP-EQUIV="Content-type"
CONTENT="text/html; charset=ISO-8859-1"></HEAD
><BODY
CLASS="reference"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>PHP Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="function.mb-substr.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="function.mcal-append-event.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="reference"
><A
NAME="ref.mcal"
></A
><DIV
CLASS="TITLEPAGE"
><H1
CLASS="title"
>LIII. MCAL functions</H1
><DIV
CLASS="PARTINTRO"
><A
NAME="AEN47331"
></A
><DIV
CLASS="section"
><H1
CLASS="section"
><A
NAME="mcal.intro"
></A
>Introduction</H1
><P
> MCAL stands for Modular Calendar Access Library.
</P
><P
> 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.
</P
><P
> 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.
</P
><P
> Calendar events can be pulled up, queried, and stored. There is
also support for calendar triggers (alarms) and recurring events.
</P
><P
> With libmcal, central calendar servers can be accessed,
removing the need for any specific database or local file
programming.
</P
><P
> 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.
</P
><DIV
CLASS="note"
><BLOCKQUOTE
CLASS="note"
><P
><B
>Note: </B
>
PHP had an ICAP extension previously, but the original library
and the PHP extension is not supported anymore. The suggested
replacement is MCAL.
</P
></BLOCKQUOTE
></DIV
><DIV
CLASS="note"
><BLOCKQUOTE
CLASS="note"
><P
><B
>Note: </B
>This extension is not
available on Windows platforms.</P
></BLOCKQUOTE
></DIV
></DIV
><DIV
CLASS="section"
><H1
CLASS="section"
><A
NAME="mcal.requirements"
></A
>Requirements</H1
><P
> This extension requires the mcal library to be installed. Grab the
latest version from <A
HREF="http://mcal.chek.com/"
TARGET="_top"
>http://mcal.chek.com/</A
>
and compile and install it.
</P
></DIV
><DIV
CLASS="section"
><H1
CLASS="section"
><A
NAME="mcal.installation"
></A
>Installation</H1
><P
> After you installed the mcal library, to get these functions to
work, you have to compile PHP
<TT
CLASS="option"
>-with-mcal[=DIR]</TT
>.
</P
></DIV
><DIV
CLASS="section"
><H1
CLASS="section"
><A
NAME="mcal.configuration"
></A
>Runtime Configuration</H1
><P
>This extension has no configuration directives defined in <TT
CLASS="filename"
>php.ini</TT
>.</P
></DIV
><DIV
CLASS="section"
><H1
CLASS="section"
><A
NAME="mcal.resources"
></A
>Resource Types</H1
><P
>This extension has no resource types defined.</P
></DIV
><DIV
CLASS="section"
><H1
CLASS="section"
><A
NAME="mcal.constants"
></A
>Predefined Constants</H1
><P
> 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.
</P
><P
></P
><DIV
CLASS="variablelist"
><DL
><DT
><TT
CLASS="constant"
><B
>MCAL_SUNDAY</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_MONDAY</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_TUESDAY</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_WEDNESDAY</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_THURSDAY</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_FRIDAY</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_SATURDAY</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_JANUARY</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_FEBRUARY</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_MARCH</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_APRIL</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_MAY</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_JUNE</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_JULY</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_AUGUST</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_SEPTEMBER</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_OCTOBER</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_NOVEMBER</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_DECEMBER</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_RECUR_NONE</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_RECUR_DAILY</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_RECUR_WEEKLY</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_RECUR_MONTHLY_MDAY</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_RECUR_MONTHLY_WDAY</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_RECUR_YEARLY</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_M_SUNDAY</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_M_MONDAY</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_M_TUESDAY</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_M_WEDNESDAY</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_M_THURSDAY</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_M_FRIDAY</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_M_SATURDAY</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_M_WEEKDAYS</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_M_WEEKEND</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_M_ALLDAYS</B
></TT
>
(<A
HREF="language.types.integer.html"
>integer</A
>)</DT
><DD
><P
>
</P
></DD
></DL
></DIV
></DIV
></DIV
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="function.mcal-append-event.html"
>mcal_append_event</A
> -- Store a new event into an MCAL calendar</DT
><DT
><A
HREF="function.mcal-close.html"
>mcal_close</A
> -- Close an MCAL stream</DT
><DT
><A
HREF="function.mcal-create-calendar.html"
>mcal_create_calendar</A
> -- Create a new MCAL calendar </DT
><DT
><A
HREF="function.mcal-date-compare.html"
>mcal_date_compare</A
> -- Compares two dates</DT
><DT
><A
HREF="function.mcal-date-valid.html"
>mcal_date_valid</A
> --
Returns <TT
CLASS="constant"
><B
>TRUE</B
></TT
> if the given year, month, day is a valid date
</DT
><DT
><A
HREF="function.mcal-day-of-week.html"
>mcal_day_of_week</A
> --
Returns the day of the week of the given date
</DT
><DT
><A
HREF="function.mcal-day-of-year.html"
>mcal_day_of_year</A
> --
Returns the day of the year of the given date
</DT
><DT
><A
HREF="function.mcal-days-in-month.html"
>mcal_days_in_month</A
> --
Returns the number of days in the given month
</DT
><DT
><A
HREF="function.mcal-delete-calendar.html"
>mcal_delete_calendar</A
> -- Delete an MCAL calendar </DT
><DT
><A
HREF="function.mcal-delete-event.html"
>mcal_delete_event</A
> -- Delete an event from an MCAL calendar</DT
><DT
><A
HREF="function.mcal-event-add-attribute.html"
>mcal_event_add_attribute</A
> --
Adds an attribute and a value to the streams global event structure
</DT
><DT
><A
HREF="function.mcal-event-init.html"
>mcal_event_init</A
> --
Initializes a streams global event structure
</DT
><DT
><A
HREF="function.mcal-event-set-alarm.html"
>mcal_event_set_alarm</A
> --
Sets the alarm of the streams global event structure
</DT
><DT
><A
HREF="function.mcal-event-set-category.html"
>mcal_event_set_category</A
> --
Sets the category of the streams global event structure
</DT
><DT
><A
HREF="function.mcal-event-set-class.html"
>mcal_event_set_class</A
> --
Sets the class of the streams global event structure
</DT
><DT
><A
HREF="function.mcal-event-set-description.html"
>mcal_event_set_description</A
> --
Sets the description of the streams global event structure
</DT
><DT
><A
HREF="function.mcal-event-set-end.html"
>mcal_event_set_end</A
> --
Sets the end date and time of the streams global event structure
</DT
><DT
><A
HREF="function.mcal-event-set-recur-daily.html"
>mcal_event_set_recur_daily</A
> --
Sets the recurrence of the streams global event structure
</DT
><DT
><A
HREF="function.mcal-event-set-recur-monthly-mday.html"
>mcal_event_set_recur_monthly_mday</A
> --
Sets the recurrence of the streams global event structure
</DT
><DT
><A
HREF="function.mcal-event-set-recur-monthly-wday.html"
>mcal_event_set_recur_monthly_wday</A
> --
Sets the recurrence of the streams global event structure
</DT
><DT
><A
HREF="function.mcal-event-set-recur-none.html"
>mcal_event_set_recur_none</A
> --
Sets the recurrence of the streams global event structure
</DT
><DT
><A
HREF="function.mcal-event-set-recur-weekly.html"
>mcal_event_set_recur_weekly</A
> --
Sets the recurrence of the streams global event structure
</DT
><DT
><A
HREF="function.mcal-event-set-recur-yearly.html"
>mcal_event_set_recur_yearly</A
> --
Sets the recurrence of the streams global event structure
</DT
><DT
><A
HREF="function.mcal-event-set-start.html"
>mcal_event_set_start</A
> --
Sets the start date and time of the streams global event
structure
</DT
><DT
><A
HREF="function.mcal-event-set-title.html"
>mcal_event_set_title</A
> --
Sets the title of the streams global event structure
</DT
><DT
><A
HREF="function.mcal-expunge.html"
>mcal_expunge</A
> --
Deletes all events marked for being expunged.
</DT
><DT
><A
HREF="function.mcal-fetch-current-stream-event.html"
>mcal_fetch_current_stream_event</A
> --
Returns an object containing the current streams event structure
</DT
><DT
><A
HREF="function.mcal-fetch-event.html"
>mcal_fetch_event</A
> --
Fetches an event from the calendar stream
</DT
><DT
><A
HREF="function.mcal-is-leap-year.html"
>mcal_is_leap_year</A
> --
Returns if the given year is a leap year or not
</DT
><DT
><A
HREF="function.mcal-list-alarms.html"
>mcal_list_alarms</A
> --
Return a list of events that has an alarm triggered at the given
datetime
</DT
><DT
><A
HREF="function.mcal-list-events.html"
>mcal_list_events</A
> --
Return a list of IDs for a date or a range of dates.
</DT
><DT
><A
HREF="function.mcal-next-recurrence.html"
>mcal_next_recurrence</A
> -- Returns the next recurrence of the event</DT
><DT
><A
HREF="function.mcal-open.html"
>mcal_open</A
> -- Opens up an MCAL connection</DT
><DT
><A
HREF="function.mcal-popen.html"
>mcal_popen</A
> -- Opens up a persistent MCAL connection</DT
><DT
><A
HREF="function.mcal-rename-calendar.html"
>mcal_rename_calendar</A
> -- Rename an MCAL calendar </DT
><DT
><A
HREF="function.mcal-reopen.html"
>mcal_reopen</A
> -- Reopens an MCAL connection</DT
><DT
><A
HREF="function.mcal-snooze.html"
>mcal_snooze</A
> -- Turn off an alarm for an event</DT
><DT
><A
HREF="function.mcal-store-event.html"
>mcal_store_event</A
> -- Modify an existing event in an MCAL calendar</DT
><DT
><A
HREF="function.mcal-time-valid.html"
>mcal_time_valid</A
> --
Returns <TT
CLASS="constant"
><B
>TRUE</B
></TT
> if the given year, month, day is a valid time
</DT
><DT
><A
HREF="function.mcal-week-of-year.html"
>mcal_week_of_year</A
> --
Returns the week number of the given date
</DT
></DL
></DIV
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="function.mb-substr.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="function.mcal-append-event.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>mb_substr</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="funcref.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>mcal_append_event</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
distrib
>
Mandriva
>
9.1
>
ppc
>
media
>
main
>
by-pkgid
>
0afeee9cca140e167a996902b9a677c5
>
files
>
3099
