Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > by-pkgid > 05cd670d8a02b2b4a0ffb1756f2e8308 > files > 12185

php-manual-zh-5.2.4-1mdv2008.1.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>MCAL Functions</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="PHP 手册"
HREF="index.html"><LINK
REL="UP"
TITLE="函数参考"
HREF="funcref.html"><LINK
REL="PREVIOUS"
TITLE="maxdb_warning_count"
HREF="function.maxdb-warning-count.html"><LINK
REL="NEXT"
TITLE="mcal_append_event"
HREF="function.mcal-append-event.html"><META
HTTP-EQUIV="Content-type"
CONTENT="text/html; charset=UTF-8"></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 手册</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="function.maxdb-warning-count.html"
ACCESSKEY="P"
>上一页</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"
>下一页</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="reference"
><A
NAME="ref.mcal"
></A
><DIV
CLASS="TITLEPAGE"
><H1
CLASS="title"
>LXXXIII. MCAL Functions</H1
><DIV
CLASS="PARTINTRO"
><A
NAME="AEN113844"
></A
><DIV
CLASS="section"
><H1
CLASS="section"
><A
NAME="mcal.intro"
>简介</A
></H1
><P
>&#13;     MCAL stands for Modular Calendar Access Library.
    </P
><P
>&#13;     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
>&#13;     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
>&#13;     Calendar events can be pulled up, queried, and stored. There is
     also support for calendar triggers (alarms) and recurring events.
    </P
><P
>&#13;     With libmcal, central calendar servers can be accessed,
     removing the need for any specific database or local file
     programming.
    </P
><P
>&#13;     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
>注意: </B
>
      本扩展已被移动到 <A
HREF="http://pecl.php.net"
TARGET="_top"
>PECL</A
> 库中且自以下版本起不再被绑定到 PHP 中:5.0.0.
     </P
></BLOCKQUOTE
></DIV
><DIV
CLASS="note"
><BLOCKQUOTE
CLASS="note"
><P
><B
>注意: </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
>注意: </B
>本扩展模块在 Windows 平台下不可用。</P
></BLOCKQUOTE
></DIV
></DIV
><DIV
CLASS="section"
><H1
CLASS="section"
><A
NAME="mcal.requirements"
>需求</A
></H1
><P
>&#13;     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
></H1
><P
>&#13;  After you installed the mcal library, to get these functions to
  work, you have to compile PHP
  <CODE
CLASS="option"
>-with-mcal[=DIR]</CODE
>.
 </P
></DIV
><DIV
CLASS="section"
><H1
CLASS="section"
><A
NAME="mcal.configuration"
>运行时配置</A
></H1
><P
>本扩展模块在 <TT
CLASS="filename"
>php.ini</TT
> 中未定义任何配置选项。</P
></DIV
><DIV
CLASS="section"
><H1
CLASS="section"
><A
NAME="mcal.resources"
>资源类型</A
></H1
><P
>本扩展模块未定义任何资源类型。</P
></DIV
><DIV
CLASS="section"
><H1
CLASS="section"
><A
NAME="mcal.constants"
>预定义常量</A
></H1
><P
>以下常量由本扩展模块定义,因此只有在本扩展模块被编译到
PHP 中,或者在运行时被动态加载后才有效。</P
><P
></P
><DIV
CLASS="variablelist"
><DL
><DT
><TT
CLASS="constant"
><B
>MCAL_SUNDAY</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_MONDAY</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_TUESDAY</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_WEDNESDAY</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_THURSDAY</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_FRIDAY</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_SATURDAY</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_JANUARY</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_FEBRUARY</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_MARCH</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_APRIL</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_MAY</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_JUNE</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_JULY</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_AUGUST</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_SEPTEMBER</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_OCTOBER</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_NOVEMBER</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_DECEMBER</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_RECUR_NONE</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_RECUR_DAILY</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_RECUR_WEEKLY</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_RECUR_MONTHLY_MDAY</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_RECUR_MONTHLY_WDAY</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_RECUR_YEARLY</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_M_SUNDAY</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_M_MONDAY</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_M_TUESDAY</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_M_WEDNESDAY</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_M_THURSDAY</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_M_FRIDAY</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_M_SATURDAY</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_M_WEEKDAYS</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_M_WEEKEND</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
><DT
><TT
CLASS="constant"
><B
>MCAL_M_ALLDAYS</B
></TT
> 
    (<A
HREF="language.types.integer.html"
><B
CLASS="type"
>integer</B
></A
>)</DT
><DD
><P
>&#13;     
    </P
></DD
></DL
></DIV
></DIV
></DIV
><DIV
CLASS="TOC"
><DL
><DT
><B
>目录</B
></DT
><DT
><A
HREF="function.mcal-append-event.html"
>mcal_append_event</A
>&nbsp;--&nbsp;Store a new event into an MCAL calendar</DT
><DT
><A
HREF="function.mcal-close.html"
>mcal_close</A
>&nbsp;--&nbsp;Close an MCAL stream</DT
><DT
><A
HREF="function.mcal-create-calendar.html"
>mcal_create_calendar</A
>&nbsp;--&nbsp;Create a new MCAL calendar </DT
><DT
><A
HREF="function.mcal-date-compare.html"
>mcal_date_compare</A
>&nbsp;--&nbsp;Compares two dates</DT
><DT
><A
HREF="function.mcal-date-valid.html"
>mcal_date_valid</A
>&nbsp;--&nbsp;
     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
>&nbsp;--&nbsp;
     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
>&nbsp;--&nbsp;
     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
>&nbsp;--&nbsp;
     Returns the number of days in a month
    </DT
><DT
><A
HREF="function.mcal-delete-calendar.html"
>mcal_delete_calendar</A
>&nbsp;--&nbsp;Delete an MCAL calendar</DT
><DT
><A
HREF="function.mcal-delete-event.html"
>mcal_delete_event</A
>&nbsp;--&nbsp;Delete an event from an MCAL calendar</DT
><DT
><A
HREF="function.mcal-event-add-attribute.html"
>mcal_event_add_attribute</A
>&nbsp;--&nbsp;
     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
>&nbsp;--&nbsp;
     Initializes a streams global event structure
    </DT
><DT
><A
HREF="function.mcal-event-set-alarm.html"
>mcal_event_set_alarm</A
>&nbsp;--&nbsp;
     Sets the alarm of the streams global event structure
    </DT
><DT
><A
HREF="function.mcal-event-set-category.html"
>mcal_event_set_category</A
>&nbsp;--&nbsp;
     Sets the category of the streams global event structure
    </DT
><DT
><A
HREF="function.mcal-event-set-class.html"
>mcal_event_set_class</A
>&nbsp;--&nbsp;
     Sets the class of the streams global event structure
    </DT
><DT
><A
HREF="function.mcal-event-set-description.html"
>mcal_event_set_description</A
>&nbsp;--&nbsp;
     Sets the description of the streams global event structure
    </DT
><DT
><A
HREF="function.mcal-event-set-end.html"
>mcal_event_set_end</A
>&nbsp;--&nbsp;
     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
>&nbsp;--&nbsp;
     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
>&nbsp;--&nbsp;
     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
>&nbsp;--&nbsp;
     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
>&nbsp;--&nbsp;
     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
>&nbsp;--&nbsp;
     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
>&nbsp;--&nbsp;
     Sets the recurrence of the streams global event structure
    </DT
><DT
><A
HREF="function.mcal-event-set-start.html"
>mcal_event_set_start</A
>&nbsp;--&nbsp;
     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
>&nbsp;--&nbsp;
     Sets the title of the streams global event structure
    </DT
><DT
><A
HREF="function.mcal-expunge.html"
>mcal_expunge</A
>&nbsp;--&nbsp;
     Deletes all events marked for being expunged
    </DT
><DT
><A
HREF="function.mcal-fetch-current-stream-event.html"
>mcal_fetch_current_stream_event</A
>&nbsp;--&nbsp;
     Returns an object containing the current streams event structure
    </DT
><DT
><A
HREF="function.mcal-fetch-event.html"
>mcal_fetch_event</A
>&nbsp;--&nbsp;
     Fetches an event from the calendar stream
    </DT
><DT
><A
HREF="function.mcal-is-leap-year.html"
>mcal_is_leap_year</A
>&nbsp;--&nbsp;
     Returns if the given year is a leap year or not
    </DT
><DT
><A
HREF="function.mcal-list-alarms.html"
>mcal_list_alarms</A
>&nbsp;--&nbsp;
     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
>&nbsp;--&nbsp;
     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
>&nbsp;--&nbsp;Returns the next recurrence of the event</DT
><DT
><A
HREF="function.mcal-open.html"
>mcal_open</A
>&nbsp;--&nbsp;Opens up an MCAL connection</DT
><DT
><A
HREF="function.mcal-popen.html"
>mcal_popen</A
>&nbsp;--&nbsp;Opens up a persistent MCAL connection</DT
><DT
><A
HREF="function.mcal-rename-calendar.html"
>mcal_rename_calendar</A
>&nbsp;--&nbsp;Rename an MCAL calendar </DT
><DT
><A
HREF="function.mcal-reopen.html"
>mcal_reopen</A
>&nbsp;--&nbsp;Reopens an MCAL connection</DT
><DT
><A
HREF="function.mcal-snooze.html"
>mcal_snooze</A
>&nbsp;--&nbsp;Turn off an alarm for an event</DT
><DT
><A
HREF="function.mcal-store-event.html"
>mcal_store_event</A
>&nbsp;--&nbsp;Modify an existing event in an MCAL calendar</DT
><DT
><A
HREF="function.mcal-time-valid.html"
>mcal_time_valid</A
>&nbsp;--&nbsp;
     Returns <TT
CLASS="constant"
><B
>TRUE</B
></TT
> if the given hour, minutes and seconds is a valid time
    </DT
><DT
><A
HREF="function.mcal-week-of-year.html"
>mcal_week_of_year</A
>&nbsp;--&nbsp;
     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.maxdb-warning-count.html"
ACCESSKEY="P"
>上一页</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>起始页</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="function.mcal-append-event.html"
ACCESSKEY="N"
>下一页</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>maxdb_warning_count</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="funcref.html"
ACCESSKEY="U"
>上一级</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>mcal_append_event</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>