[PHP-DOC] cvs: phpdoc /en/functions mcal.xml
sander Thu Mar 28 12:00:15 2002 EDT Modified files: /phpdoc/en/functionsmcal.xml Log: mcal_week_of_year() is perfectly documented :) # Well, it's completely clear to me what it does. Index: phpdoc/en/functions/mcal.xml diff -u phpdoc/en/functions/mcal.xml:1.29 phpdoc/en/functions/mcal.xml:1.30 --- phpdoc/en/functions/mcal.xml:1.29 Sat Feb 2 10:36:02 2002 +++ phpdoc/en/functions/mcal.xmlThu Mar 28 12:00:14 2002 @@ -1,5 +1,5 @@ - + MCAL functions MCAL @@ -1194,9 +1194,6 @@ intmonth intyear - - &warn.undocumented.func; -
[PHP-DOC] cvs: phpdoc /en/functions mcal.xml
hholzgraSat Dec 15 09:45:44 2001 EDT Modified files: /phpdoc/en/functionsmcal.xml Log: added skeleton for missing function Index: phpdoc/en/functions/mcal.xml diff -u phpdoc/en/functions/mcal.xml:1.27 phpdoc/en/functions/mcal.xml:1.28 --- phpdoc/en/functions/mcal.xml:1.27 Wed Dec 12 15:47:02 2001 +++ phpdoc/en/functions/mcal.xmlSat Dec 15 09:45:44 2001 @@ -1,5 +1,5 @@ - + MCAL functions MCAL @@ -1303,6 +1303,29 @@ mcal_expunge Deletes all events which have been previously marked for deletion. + + + + + + +mcal_week_of_year + + Returns the week number of the given date + + + +Description + + + int mcal_week_of_year + int day + int month + int year + + + + &warn.undocumented.func;
[PHP-DOC] cvs: phpdoc /en/functions mcal.xml
smasiello Thu Aug 2 11:59:31 2001 EDT Modified files: /phpdoc/en/functionsmcal.xml Log: fixed some annoying spelling and grammatical errors on the main MCAL page PR: Submitted by: Reviewed by: Obtained from: Index: phpdoc/en/functions/mcal.xml diff -u phpdoc/en/functions/mcal.xml:1.21 phpdoc/en/functions/mcal.xml:1.22 --- phpdoc/en/functions/mcal.xml:1.21 Sat Jul 7 14:42:31 2001 +++ phpdoc/en/functions/mcal.xmlThu Aug 2 11:59:31 2001 @@ -8,7 +8,7 @@ Libmcal is a C library for accessing calendars. It's written to be -very modular, with plugable drivers. MCAL is the calendar +very modular, with pluggable drivers. MCAL is the calendar equivalent of the IMAP module for mailboxes. @@ -19,10 +19,10 @@ Calendar events can be pulled up, queried, and stored. There is -also support for calendar triggers (alarms) and reoccuring events. +also support for calendar triggers (alarms) and recurring events. -With libmcal, central calendar servers can be accessed and used, +With libmcal, central calendar servers can be accessed, removing the need for any specific database or local file programming. @@ -59,7 +59,7 @@ MCAL_SATURDAY -For recurences : +For recurrence : MCAL_RECUR_NONE @@ -80,7 +80,7 @@ MCAL_RECUR_YEARLY -For monthes : +For months : MCAL_JANUARY @@ -159,7 +159,7 @@ mcal_popen -Opens up a persistant MCAL connection +Opens up a persistent MCAL connection Description
[PHP-DOC] cvs: phpdoc /en/functions mcal.xml
damsMon Jul 2 06:46:41 2001 EDT Modified files: /phpdoc/en/functionsmcal.xml Log: Added more titles Index: phpdoc/en/functions/mcal.xml diff -u phpdoc/en/functions/mcal.xml:1.19 phpdoc/en/functions/mcal.xml:1.20 --- phpdoc/en/functions/mcal.xml:1.19 Mon Jul 2 06:45:54 2001 +++ phpdoc/en/functions/mcal.xmlMon Jul 2 06:46:40 2001 @@ -59,6 +59,7 @@ MCAL_SATURDAY +For recurences : MCAL_RECUR_NONE @@ -79,6 +80,7 @@ MCAL_RECUR_YEARLY +For monthes : MCAL_JANUARY
[PHP-DOC] cvs: phpdoc /en/functions mcal.xml
damsMon Jul 2 06:45:55 2001 EDT Modified files: /phpdoc/en/functionsmcal.xml Log: Fixed the augugt constant.Made the constants a list. Index: phpdoc/en/functions/mcal.xml diff -u phpdoc/en/functions/mcal.xml:1.18 phpdoc/en/functions/mcal.xml:1.19 --- phpdoc/en/functions/mcal.xml:1.18 Wed May 23 10:59:04 2001 +++ phpdoc/en/functions/mcal.xmlMon Jul 2 06:45:54 2001 @@ -34,36 +34,89 @@ it. -The following constants are defined when using the MCAL module: - -MCAL_SUNDAY, -MCAL_MONDAY, -MCAL_TUESDAY, -MCAL_WEDNESDAY, -MCAL_THURSDAY, -MCAL_FRIDAY, -MCAL_SATURDAY, - -MCAL_RECUR_NONE, -MCAL_RECUR_DAILY, -MCAL_RECUR_WEEKLY, -MCAL_RECUR_MONTHLY_MDAY, -MCAL_RECUR_MONTHLY_WDAY, -MCAL_RECUR_YEARLY, - -MCAL_JANUARY, -MCAL_FEBRUARY, -MCAL_MARCH, -MCAL_APRIL, -MCAL_MAY, -MCAL_JUNE, -MCAL_JULY, -MCAL_AUGUGT, -MCAL_SEPTEMBER, -MCAL_OCTOBER, -MCAL_NOVEMBER, and -MCAL_DECEMBER. - +The following constants are defined when using the MCAL module. +For weekdays : + + +MCAL_SUNDAY + + + MCAL_MONDAY + + + MCAL_TUESDAY + + + MCAL_WEDNESDAY + + + MCAL_THURSDAY + + + MCAL_FRIDAY + + + MCAL_SATURDAY + + + + + MCAL_RECUR_NONE + + + MCAL_RECUR_DAILY + + + MCAL_RECUR_WEEKLY + + + MCAL_RECUR_MONTHLY_MDAY + + + MCAL_RECUR_MONTHLY_WDAY + + + MCAL_RECUR_YEARLY + + + + + MCAL_JANUARY + + + MCAL_FEBRUARY + + + MCAL_MARCH + + + MCAL_APRIL + + + MCAL_MAY + + + MCAL_JUNE + + + MCAL_JULY + + + MCAL_AUGUST + + + MCAL_SEPTEMBER + + + MCAL_OCTOBER + + + MCAL_NOVEMBER + + + MCAL_DECEMBER + + 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 @@ -973,7 +1026,7 @@ mcal_event_set_recur_none sets the streams global event structure to not recur (event->recur_type is set to - MCAL_RECUR_NONE). + MCAL_RECUR_NONE).
[PHP-DOC] cvs: phpdoc /en/functions mcal.xml
smasiello Wed May 23 07:59:05 2001 EDT Modified files: /phpdoc/en/functionsmcal.xml Log: fixed function prototypes for mcal_open, mcal_popen, and mcal_reopen PR: Submitted by: Reviewed by: Obtained from: Index: phpdoc/en/functions/mcal.xml diff -u phpdoc/en/functions/mcal.xml:1.17 phpdoc/en/functions/mcal.xml:1.18 --- phpdoc/en/functions/mcal.xml:1.17 Thu Mar 1 12:11:46 2001 +++ phpdoc/en/functions/mcal.xmlWed May 23 07:59:04 2001 @@ -85,7 +85,7 @@ string calendar string username string password - int options + int options @@ -114,7 +114,7 @@ string calendar string username string password - int options + int options @@ -141,7 +141,7 @@ int mcal_reopen string calendar - int options + int options
[PHP-DOC] cvs: phpdoc /en/functions mcal.xml
smasiello Thu Mar 1 12:11:46 2001 EDT Modified files: /phpdoc/en/functionsmcal.xml Log: fixed description of return from mcal_store_event PR: Submitted by: Reviewed by: Obtained from: Index: phpdoc/en/functions/mcal.xml diff -u phpdoc/en/functions/mcal.xml:1.16 phpdoc/en/functions/mcal.xml:1.17 --- phpdoc/en/functions/mcal.xml:1.16 Tue Feb 27 05:49:38 2001 +++ phpdoc/en/functions/mcal.xmlThu Mar 1 12:11:46 2001 @@ -405,7 +405,7 @@ to the current global event for the given stream. - Returns true on success and false on error. + Returns the event id of the modified event on success and false on error.
[PHP-DOC] cvs: phpdoc /en/functions mcal.xml
smasiello Tue Feb 27 05:49:39 2001 EDT Modified files: /phpdoc/en/functionsmcal.xml Log: fixed function prototype and added possible return values for mcal_day_of_week PR: Submitted by: Reviewed by: Obtained from: Index: phpdoc/en/functions/mcal.xml diff -u phpdoc/en/functions/mcal.xml:1.15 phpdoc/en/functions/mcal.xml:1.16 --- phpdoc/en/functions/mcal.xml:1.15 Tue Feb 20 10:28:34 2001 +++ phpdoc/en/functions/mcal.xmlTue Feb 27 05:49:38 2001 @@ -864,7 +864,7 @@ Description - int mcal_ + int mcal_day_of_week int year int month int day @@ -873,6 +873,8 @@ mcal_day_of_week returns the day of the week of the given date. + +Possible return values range from 0 for Sunday through 6 for Saturday.
[PHP-DOC] cvs: phpdoc /en/functions mcal.xml
smasiello Tue Feb 20 10:28:35 2001 EDT Modified files: /phpdoc/en/functionsmcal.xml Log: added mapping for values of recur_type in mcal_fetch_event PR: Submitted by: Reviewed by: askalski Obtained from: Index: phpdoc/en/functions/mcal.xml diff -u phpdoc/en/functions/mcal.xml:1.14 phpdoc/en/functions/mcal.xml:1.15 --- phpdoc/en/functions/mcal.xml:1.14 Fri Jan 5 11:01:15 2001 +++ phpdoc/en/functions/mcal.xmlTue Feb 20 10:28:34 2001 @@ -307,6 +307,23 @@ int sec - seconds int alarm - minutes before event to send an alarm + + + The possible values for recur_type are: + + + + 0 - Indicates that this event does not recur + + 1 - This event recurs daily + + 2 - This event recurs on a weekly basis + + 3 - This event recurs monthly on a specific day of the month (e.g. the 10th of +the month) + + 4 - This event recurs monthly on a sequenced day of the week (e.g. the 3rd +Saturday) + + 5 - This event recurs on an annual basis
