diff --git a/appendices/extensions.xml b/appendices/extensions.xml index cedd35a23b..78f16cfc64 100644 --- a/appendices/extensions.xml +++ b/appendices/extensions.xml @@ -1,5 +1,5 @@ - + - - - - - MCAL - - - - &reftitle.intro; - - 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. - - - - &pecl.moved-ver;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. - - - ¬e.no-windows.extension; - - - - &reference.mcal.setup; - &reference.mcal.constants; - &reference.mcal.reference; - - - - - diff --git a/reference/mcal/configure.xml b/reference/mcal/configure.xml deleted file mode 100644 index 735a26e428..0000000000 --- a/reference/mcal/configure.xml +++ /dev/null @@ -1,32 +0,0 @@ - - -
- &reftitle.install; - - After you installed the mcal library, to get these functions to - work, you have to compile PHP - . - -
- - - diff --git a/reference/mcal/constants.xml b/reference/mcal/constants.xml deleted file mode 100644 index 6fe18c7f80..0000000000 --- a/reference/mcal/constants.xml +++ /dev/null @@ -1,411 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - 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) - - - - - - - - - - - diff --git a/reference/mcal/functions/mcal-append-event.xml b/reference/mcal/functions/mcal-append-event.xml deleted file mode 100644 index 3d60579eaa..0000000000 --- a/reference/mcal/functions/mcal-append-event.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - mcal_append_event - Store a new event into an MCAL calendar - - - &reftitle.description; - - intmcal_append_event - intmcal_stream - - - mcal_append_event stores the global event - into an MCAL calendar for the stream mcal_stream. - - - - &reftitle.parameters; - - - - mcal_stream - - - The MCAL stream. - - - - - - - - &reftitle.returnvalues; - - Returns the id of the newly inserted event. - - - - - diff --git a/reference/mcal/functions/mcal-close.xml b/reference/mcal/functions/mcal-close.xml deleted file mode 100644 index 2503a87b4f..0000000000 --- a/reference/mcal/functions/mcal-close.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - mcal_close - Close an MCAL stream - - - &reftitle.description; - - boolmcal_close - intmcal_stream - intflags - - - Closes the given mcal stream. - - - - &reftitle.parameters; - - - - stream - - - The MCAL stream. - - - - - flags - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/mcal/functions/mcal-create-calendar.xml b/reference/mcal/functions/mcal-create-calendar.xml deleted file mode 100644 index 31e0dbc293..0000000000 --- a/reference/mcal/functions/mcal-create-calendar.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - mcal_create_calendar - Create a new MCAL calendar - - - &reftitle.description; - - boolmcal_create_calendar - intstream - stringcalendar - - - Creates a new calendar named calendar. - - - - &reftitle.parameters; - - - - stream - - - The MCAL stream. - - - - - calendar - - - The calendar name. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/mcal/functions/mcal-date-compare.xml b/reference/mcal/functions/mcal-date-compare.xml deleted file mode 100644 index 48cc57595f..0000000000 --- a/reference/mcal/functions/mcal-date-compare.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - mcal_date_compare - Compares two dates - - - &reftitle.description; - - intmcal_date_compare - inta_year - inta_month - inta_day - intb_year - intb_month - intb_day - - - Compares the two given dates. - - - - &reftitle.parameters; - - - - a_year - - - Year part of the first date. - - - - - a_month - - - Month part of the first date. - - - - - a_day - - - Day part of the first date. - - - - - b_year - - - Year part of the second date. - - - - - b_month - - - Month part of the second date. - - - - - b_day - - - Day part of the second date. - - - - - - - - &reftitle.returnvalues; - - Returns <0, 0, >0 if a<b, a==b, a>b respectively. - - - - - diff --git a/reference/mcal/functions/mcal-date-valid.xml b/reference/mcal/functions/mcal-date-valid.xml deleted file mode 100644 index b39ae6ff46..0000000000 --- a/reference/mcal/functions/mcal-date-valid.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - mcal_date_valid - Validates a date - - - &reftitle.description; - - boolmcal_date_valid - intyear - intmonth - intday - - - Validates a date. - - - - &reftitle.parameters; - - - - year - - - The year. - - - - - month - - - The month. - - - - - day - - - The day. - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the given date is valid, &false; otherwise. - - - - - diff --git a/reference/mcal/functions/mcal-day-of-week.xml b/reference/mcal/functions/mcal-day-of-week.xml deleted file mode 100644 index dc0ebd555e..0000000000 --- a/reference/mcal/functions/mcal-day-of-week.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - mcal_day_of_week - Returns the day of the week of the given date - - - &reftitle.description; - - intmcal_day_of_week - intyear - intmonth - intday - - - Returns the day of the week of the given date. - - - - &reftitle.parameters; - - - - year - - - The year. - - - - - month - - - The month. - - - - - day - - - The day. - - - - - - - - &reftitle.returnvalues; - - Possible return values range from 0 for Sunday through 6 for Saturday. - - - - - diff --git a/reference/mcal/functions/mcal-day-of-year.xml b/reference/mcal/functions/mcal-day-of-year.xml deleted file mode 100644 index af390efc4d..0000000000 --- a/reference/mcal/functions/mcal-day-of-year.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - mcal_day_of_year - Returns the day of the year of the given date - - - &reftitle.description; - - intmcal_day_of_year - intyear - intmonth - intday - - - Returns the day of the year of the given date. - - - - &reftitle.parameters; - - - - year - - - The year. - - - - - month - - - The month. - - - - - day - - - The day. - - - - - - - - &reftitle.returnvalues; - - Returns the day as an integer. - - - - - diff --git a/reference/mcal/functions/mcal-days-in-month.xml b/reference/mcal/functions/mcal-days-in-month.xml deleted file mode 100644 index 41e4ab7294..0000000000 --- a/reference/mcal/functions/mcal-days-in-month.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - mcal_days_in_month - Returns the number of days in a month - - - &reftitle.description; - - intmcal_days_in_month - intmonth - intleap_year - - - mcal_days_in_month returns the number of - days in the month month, taking into account if the - considered year is a leap year or not. - - - - &reftitle.parameters; - - - - month - - - - - - - leap_year - - - - - - - - - - &reftitle.returnvalues; - - Returns the number of days in the month. - - - - - diff --git a/reference/mcal/functions/mcal-delete-calendar.xml b/reference/mcal/functions/mcal-delete-calendar.xml deleted file mode 100644 index 44b3a0fdd0..0000000000 --- a/reference/mcal/functions/mcal-delete-calendar.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - mcal_delete_calendar - Delete an MCAL calendar - - - &reftitle.description; - - boolmcal_delete_calendar - intstream - stringcalendar - - - Deletes the calendar named calendar. - - - - &reftitle.parameters; - - - - stream - - - The MCAL stream. - - - - - calendar - - - The calendar name. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/mcal/functions/mcal-delete-event.xml b/reference/mcal/functions/mcal-delete-event.xml deleted file mode 100644 index 1f1b539cce..0000000000 --- a/reference/mcal/functions/mcal-delete-event.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - mcal_delete_event - Delete an event from an MCAL calendar - - - &reftitle.description; - - boolmcal_delete_event - intmcal_stream - intevent_id - - - mcal_delete_event deletes the calendar event - specified by the event_id. - - - - &reftitle.parameters; - - - - mcal_stream - - - The MCAL stream. - - - - - event_id - - - The event identifier. - - - - - - - - &reftitle.returnvalues; - - Returns &true;. - - - - - diff --git a/reference/mcal/functions/mcal-event-add-attribute.xml b/reference/mcal/functions/mcal-event-add-attribute.xml deleted file mode 100644 index 8975bcf7e8..0000000000 --- a/reference/mcal/functions/mcal-event-add-attribute.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - mcal_event_add_attribute - Adds an attribute and a value to the streams global event structure - - - &reftitle.description; - - boolmcal_event_add_attribute - intstream - stringattribute - stringvalue - - - Adds an attribute to the stream's global event structure with the given - value. - - - - &reftitle.parameters; - - - - stream - - - The MCAL stream. - - - - - attribute - - - The attribute name. - - - - - value - - - The attribute value. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/mcal/functions/mcal-event-init.xml b/reference/mcal/functions/mcal-event-init.xml deleted file mode 100644 index ce77a3b971..0000000000 --- a/reference/mcal/functions/mcal-event-init.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - mcal_event_init - Initializes a streams global event structure - - - &reftitle.description; - - voidmcal_event_init - intstream - - - mcal_event_init initializes a streams global - event structure. This effectively sets all elements of the - structure to 0, or the default settings. - - - - &reftitle.parameters; - - - - stream - - - The MCAL stream. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/mcal/functions/mcal-event-set-alarm.xml b/reference/mcal/functions/mcal-event-set-alarm.xml deleted file mode 100644 index a801be6234..0000000000 --- a/reference/mcal/functions/mcal-event-set-alarm.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - mcal_event_set_alarm - Sets the alarm of the streams global event structure - - - &reftitle.description; - - voidmcal_event_set_alarm - intstream - intalarm - - - Sets the streams global event structure's alarm to the given minutes - before the event. - - - - &reftitle.parameters; - - - - stream - - - The MCAL stream. - - - - - alarm - - - The alarm, in minutes. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/mcal/functions/mcal-event-set-category.xml b/reference/mcal/functions/mcal-event-set-category.xml deleted file mode 100644 index a148b8bda2..0000000000 --- a/reference/mcal/functions/mcal-event-set-category.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - mcal_event_set_category - Sets the category of the streams global event structure - - - &reftitle.description; - - voidmcal_event_set_category - intstream - stringcategory - - - mcal_event_set_category sets the streams - global event structure's category to the given string. - - - - &reftitle.parameters; - - - - stream - - - The MCAL stream. - - - - - category - - - The category to be set. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/mcal/functions/mcal-event-set-class.xml b/reference/mcal/functions/mcal-event-set-class.xml deleted file mode 100644 index a53279fc56..0000000000 --- a/reference/mcal/functions/mcal-event-set-class.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - mcal_event_set_class - Sets the class of the streams global event structure - - - &reftitle.description; - - voidmcal_event_set_class - intstream - intclass - - - Sets the streams global event structure's class to the given value. - - - - &reftitle.parameters; - - - - stream - - - The MCAL stream. - - - - - class - - - The class is either 1 for public, or 0 for private. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/mcal/functions/mcal-event-set-description.xml b/reference/mcal/functions/mcal-event-set-description.xml deleted file mode 100644 index 71bf5c905a..0000000000 --- a/reference/mcal/functions/mcal-event-set-description.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - mcal_event_set_description - Sets the description of the streams global event structure - - - &reftitle.description; - - voidmcal_event_set_description - intstream - stringdescription - - - Sets the streams global event structure's description to the given string. - - - - &reftitle.parameters; - - - - stream - - - The MCAL stream. - - - - - description - - - The description, as a string. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/mcal/functions/mcal-event-set-end.xml b/reference/mcal/functions/mcal-event-set-end.xml deleted file mode 100644 index 66ed025f2c..0000000000 --- a/reference/mcal/functions/mcal-event-set-end.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - mcal_event_set_end - Sets the end date and time of the streams global event structure - - - &reftitle.description; - - voidmcal_event_set_end - intstream - intyear - intmonth - intday - inthour - intminutes - intseconds - - - Sets the streams global event structure's end date and time to the given - values. - - - - &reftitle.parameters; - - - - stream - - - The MCAL stream. - - - - - year - - - The year. - - - - - month - - - The month. - - - - - day - - - The day. - - - - - hour - - - The hour. - - - - - minutes - - - The minutes. - - - - - seconds - - - The seconds. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/mcal/functions/mcal-event-set-recur-daily.xml b/reference/mcal/functions/mcal-event-set-recur-daily.xml deleted file mode 100644 index f602c9d0fa..0000000000 --- a/reference/mcal/functions/mcal-event-set-recur-daily.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - mcal_event_set_recur_daily - Sets the recurrence of the streams global event structure - - - &reftitle.description; - - voidmcal_event_set_recur_daily - intstream - intyear - intmonth - intday - intinterval - - - Sets the streams global event structure's recurrence to the given value to - be reoccurring on a daily basis, ending at the given date. - - - - &reftitle.parameters; - - - - stream - - - The MCAL stream. - - - - - year - - - The year. - - - - - month - - - The month. - - - - - day - - - The day. - - - - - interval - - - The interval. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/mcal/functions/mcal-event-set-recur-monthly-mday.xml b/reference/mcal/functions/mcal-event-set-recur-monthly-mday.xml deleted file mode 100644 index 257a36e818..0000000000 --- a/reference/mcal/functions/mcal-event-set-recur-monthly-mday.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - mcal_event_set_recur_monthly_mday - Sets the recurrence of the streams global event structure - - - &reftitle.description; - - voidmcal_event_set_recur_monthly_mday - intstream - intyear - intmonth - intday - intinterval - - - Sets the streams global event structure's recurrence to the given value to - be reoccurring on a monthly by month day basis, ending at the given date. - - - - &reftitle.parameters; - - - - stream - - - The MCAL stream. - - - - - year - - - The year. - - - - - month - - - The month. - - - - - day - - - The day. - - - - - interval - - - The interval. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/mcal/functions/mcal-event-set-recur-monthly-wday.xml b/reference/mcal/functions/mcal-event-set-recur-monthly-wday.xml deleted file mode 100644 index b24a591767..0000000000 --- a/reference/mcal/functions/mcal-event-set-recur-monthly-wday.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - mcal_event_set_recur_monthly_wday - Sets the recurrence of the streams global event structure - - - &reftitle.description; - - voidmcal_event_set_recur_monthly_wday - intstream - intyear - intmonth - intday - intinterval - - - mcal_event_set_recur_monthly_wday sets the - streams global event structure's recurrence to the given value to - be reoccurring on a monthly by week basis, ending at the given - date. - - - - &reftitle.parameters; - - - - stream - - - The MCAL stream. - - - - - year - - - The year. - - - - - month - - - The month. - - - - - day - - - The day. - - - - - interval - - - The interval. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/mcal/functions/mcal-event-set-recur-none.xml b/reference/mcal/functions/mcal-event-set-recur-none.xml deleted file mode 100644 index 968a9376f8..0000000000 --- a/reference/mcal/functions/mcal-event-set-recur-none.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - mcal_event_set_recur_none - Sets the recurrence of the streams global event structure - - - &reftitle.description; - - voidmcal_event_set_recur_none - intstream - - - mcal_event_set_recur_none sets the streams - global event structure to not recur (event->recur_type is set to - MCAL_RECUR_NONE). - - - - &reftitle.parameters; - - - - stream - - - The MCAL stream. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/mcal/functions/mcal-event-set-recur-weekly.xml b/reference/mcal/functions/mcal-event-set-recur-weekly.xml deleted file mode 100644 index ba5ae26d4a..0000000000 --- a/reference/mcal/functions/mcal-event-set-recur-weekly.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - mcal_event_set_recur_weekly - Sets the recurrence of the streams global event structure - - - &reftitle.description; - - voidmcal_event_set_recur_weekly - intstream - intyear - intmonth - intday - intinterval - intweekdays - - - Sets the streams global event structure's recurrence to the given value to - be reoccurring on a weekly basis, ending at the given date. - - - - &reftitle.parameters; - - - - stream - - - The MCAL stream. - - - - - year - - - The year. - - - - - month - - - The month. - - - - - day - - - The day. - - - - - interval - - - The interval. - - - - - weekdays - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/mcal/functions/mcal-event-set-recur-yearly.xml b/reference/mcal/functions/mcal-event-set-recur-yearly.xml deleted file mode 100644 index b2ee17fb58..0000000000 --- a/reference/mcal/functions/mcal-event-set-recur-yearly.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - mcal_event_set_recur_yearly - Sets the recurrence of the streams global event structure - - - &reftitle.description; - - voidmcal_event_set_recur_yearly - intstream - intyear - intmonth - intday - intinterval - - - Sets the streams global event structure's recurrence to the given value to - be reoccurring on a yearly basis,ending at the given date. - - - - &reftitle.parameters; - - - - stream - - - The MCAL stream. - - - - - year - - - The year. - - - - - month - - - The month. - - - - - day - - - The day. - - - - - interval - - - The interval. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/mcal/functions/mcal-event-set-start.xml b/reference/mcal/functions/mcal-event-set-start.xml deleted file mode 100644 index f50dfba112..0000000000 --- a/reference/mcal/functions/mcal-event-set-start.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - mcal_event_set_start - Sets the start date and time of the streams global event structure - - - &reftitle.description; - - voidmcal_event_set_start - intstream - intyear - intmonth - intday - inthour - intminutes - intseconds - - - Sets the streams global event structure's start date and time to the given - values. - - - - &reftitle.parameters; - - - - stream - - - The MCAL stream. - - - - - year - - - The year. - - - - - month - - - The month. - - - - - day - - - The day. - - - - - hour - - - The hour. - - - - - minutes - - - The minutes. - - - - - seconds - - - The seconds. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/mcal/functions/mcal-event-set-title.xml b/reference/mcal/functions/mcal-event-set-title.xml deleted file mode 100644 index ada8dae12f..0000000000 --- a/reference/mcal/functions/mcal-event-set-title.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - mcal_event_set_title - Sets the title of the streams global event structure - - - &reftitle.description; - - voidmcal_event_set_title - intstream - stringtitle - - - mcal_event_set_title sets the streams global - event structure's title to the given string. - - - - &reftitle.parameters; - - - - stream - - - The MCAL stream. - - - - - title - - - The new title. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/mcal/functions/mcal-expunge.xml b/reference/mcal/functions/mcal-expunge.xml deleted file mode 100644 index 5a3408a00d..0000000000 --- a/reference/mcal/functions/mcal-expunge.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - mcal_expunge - Deletes all events marked for being expunged - - - &reftitle.description; - - boolmcal_expunge - intstream - - - mcal_expunge deletes all events which have - been previously marked for deletion. - - - - &reftitle.parameters; - - - - stream - - - The MCAL stream. - - - - - flags - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/mcal/functions/mcal-fetch-current-stream-event.xml b/reference/mcal/functions/mcal-fetch-current-stream-event.xml deleted file mode 100644 index 3f5c14104d..0000000000 --- a/reference/mcal/functions/mcal-fetch-current-stream-event.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - mcal_fetch_current_stream_event - Returns an object containing the current streams event structure - - - &reftitle.description; - - objectmcal_fetch_current_stream_event - intstream - - - Returns an object containing the current streams event structure. - - - - &reftitle.parameters; - - - - stream - - - The MCAL stream. - - - - - - - - &reftitle.returnvalues; - - mcal_fetch_current_stream_event - returns the current stream's event structure as an object - containing: - - - - int id - ID of that event. - - - - - int public - &true; if the event if public, &false; if it is private. - - - - - string category - Category string of the event. - - - - - string title - Title string of the event. - - - - - string description - Description string of the event. - - - - - int alarm - number of minutes before the event to send an alarm/reminder. - - - - - object start - Object containing a datetime entry. - - - - - object end - Object containing a datetime entry. - - - - - int recur_type - recurrence type - - - - - int recur_interval - recurrence interval - - - - - datetime recur_enddate - recurrence end date - - - - - int recur_data - recurrence data - - - - All datetime entries consist of an object that contains: - - - - int year - year - - - - - int month - month - - - - - int mday - day of month - - - - - int hour - hour - - - - - int min - minutes - - - - - int sec - seconds - - - - - int alarm - minutes before event to send an alarm - - - - - - - - diff --git a/reference/mcal/functions/mcal-fetch-event.xml b/reference/mcal/functions/mcal-fetch-event.xml deleted file mode 100644 index d92a716e52..0000000000 --- a/reference/mcal/functions/mcal-fetch-event.xml +++ /dev/null @@ -1,211 +0,0 @@ - - - - - mcal_fetch_event - Fetches an event from the calendar stream - - - &reftitle.description; - - objectmcal_fetch_event - intmcal_stream - intevent_id - intoptions - - - mcal_fetch_event fetches an event from the - calendar stream specified by id. - - - - &reftitle.parameters; - - - - mcal_stream - - - The MCAL stream. - - - - - event_id - - - - - - - options - - - - - - - - - - &reftitle.returnvalues; - - Returns an event object consisting of: - - - - int id - ID of that event. - - - - - int public - &true; if the event if public, &false; if it is private. - - - - - string category - Category string of the event. - - - - - string title - Title string of the event. - - - - - string description - Description string of the event. - - - - - int alarm - number of minutes before the event to send an - alarm/reminder. - - - - - object start - Object containing a datetime entry. - - - - - object end - Object containing a datetime entry. - - - - - int recur_type - recurrence type - - - - - int recur_interval - recurrence interval - - - - - datetime recur_enddate - recurrence end date - - - - - int recur_data - recurrence data - - - - All datetime entries consist of an object that contains: - - - - int year - year - - - - - int month - month - - - - - int mday - day of month - - - - - int hour - hour - - - - - int min - minutes - - - - - 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 - - - - - - - - diff --git a/reference/mcal/functions/mcal-is-leap-year.xml b/reference/mcal/functions/mcal-is-leap-year.xml deleted file mode 100644 index 4388d0436a..0000000000 --- a/reference/mcal/functions/mcal-is-leap-year.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - mcal_is_leap_year - Returns if the given year is a leap year or not - - - &reftitle.description; - - boolmcal_is_leap_year - intyear - - - mcal_is_leap_year tells if the given - year is a leap year, or not. - - - - &reftitle.parameters; - - - - year - - - The tested year. - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the given year is a leap year, &false; otherwise. - - - - - diff --git a/reference/mcal/functions/mcal-list-alarms.xml b/reference/mcal/functions/mcal-list-alarms.xml deleted file mode 100644 index e8201a21a2..0000000000 --- a/reference/mcal/functions/mcal-list-alarms.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - mcal_list_alarms - Return a list of events that has an alarm triggered at the given datetime - - - &reftitle.description; - - arraymcal_list_alarms - intmcal_stream - intbegin_year - intbegin_month - intbegin_day - intend_year - intend_month - intend_day - - - Returns an array of event ID's that has an alarm going off between the - start and end dates, or if just a stream is given, uses the start and - end dates in the global event structure. - - - - &reftitle.parameters; - - - - mcal_stream - - - The MCAL stream. - - - - - begin_year - - - Year part of the first date. - - - - - begin_month - - - Month part of the first date. - - - - - begin_day - - - Day part of the first date. - - - - - end_year - - - Year part of the second date. - - - - - end_month - - - Month part of the second date. - - - - - end_day - - - Day part of the second date. - - - - - - - - &reftitle.returnvalues; - - Returns an array of alarm id's that are between the given dates or the - internal alarm dates. - - - - - diff --git a/reference/mcal/functions/mcal-list-events.xml b/reference/mcal/functions/mcal-list-events.xml deleted file mode 100644 index 824f8443ff..0000000000 --- a/reference/mcal/functions/mcal-list-events.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - mcal_list_events - Return a list of IDs for a date or a range of dates - - - &reftitle.description; - - arraymcal_list_events - intmcal_stream - intbegin_year - intbegin_month - intbegin_day - intend_year - intend_month - intend_day - - - Returns an array of ID's that are between the start and end - dates, or if just a stream is given, uses the start and end dates - in the global event structure. - - - mcal_list_events takes in an - beginning date and an optional end date for a calendar stream. - - - - &reftitle.parameters; - - - - mcal_stream - - - The MCAL stream. - - - - - begin_year - - - Year part of the first date. - - - - - begin_month - - - Month part of the first date. - - - - - begin_day - - - Day part of the first date. - - - - - end_year - - - Year part of the second date. - - - - - end_month - - - Month part of the second date. - - - - - end_day - - - Day part of the second date. - - - - - - - - &reftitle.returnvalues; - - Returns an array of event id's that are between the given dates or the - internal event dates. - - - - - diff --git a/reference/mcal/functions/mcal-next-recurrence.xml b/reference/mcal/functions/mcal-next-recurrence.xml deleted file mode 100644 index 3943650a00..0000000000 --- a/reference/mcal/functions/mcal-next-recurrence.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - mcal_next_recurrence - Returns the next recurrence of the event - - - &reftitle.description; - - objectmcal_next_recurrence - intstream - intweekstart - arraynext - - - Gets the next recurrence of the event. - - - - &reftitle.parameters; - - - - stream - - - The MCAL stream. - - - - - weekstart - - - Uses weekstart to determine what day is considered the beginning of - the week. - - - - - next - - - - - - - - - - &reftitle.returnvalues; - - Returns an object filled with the next date the event occurs, on or after - the supplied date. Returns empty date field if event does not occur or - something is invalid. - - - - - diff --git a/reference/mcal/functions/mcal-open.xml b/reference/mcal/functions/mcal-open.xml deleted file mode 100644 index 222532b958..0000000000 --- a/reference/mcal/functions/mcal-open.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - mcal_open - Opens up an MCAL connection - - - &reftitle.description; - - intmcal_open - stringcalendar - stringusername - stringpassword - intoptions - - - mcal_open opens up an MCAL connection to the - specified calendar store. - The streams internal event structure is also initialized upon connection. - - - - &reftitle.parameters; - - - - calendar - - - The MCAL calendar store. - - - - - username - - - The MCAL username. - - - - - password - - - The MCAL password. - - - - - options - - - If the optional options is specified, - passes the options to that mailbox also. - - - - - - - - &reftitle.returnvalues; - - Returns an MCAL stream on success, &false; on error. - - - - - diff --git a/reference/mcal/functions/mcal-popen.xml b/reference/mcal/functions/mcal-popen.xml deleted file mode 100644 index f8e18a6266..0000000000 --- a/reference/mcal/functions/mcal-popen.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - mcal_popen - Opens up a persistent MCAL connection - - - &reftitle.description; - - intmcal_popen - stringcalendar - stringusername - stringpassword - intoptions - - - mcal_popen opens up an persistent MCAL connection to - the specified calendar store. - - - The streams internal event structure is also initialized upon connection. - - - - &reftitle.parameters; - - - - calendar - - - The MCAL calendar store. - - - - - username - - - The MCAL username. - - - - - password - - - The MCAL password. - - - - - options - - - If the optional options is specified, - passes the options to that mailbox also. - - - - - - - - &reftitle.returnvalues; - - Returns an MCAL stream on success, &false; on error. - - - - - diff --git a/reference/mcal/functions/mcal-rename-calendar.xml b/reference/mcal/functions/mcal-rename-calendar.xml deleted file mode 100644 index d1fe408aee..0000000000 --- a/reference/mcal/functions/mcal-rename-calendar.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - mcal_rename_calendar - Rename an MCAL calendar - - - &reftitle.description; - - boolmcal_rename_calendar - intstream - stringold_name - stringnew_name - - - Renames the calendar old_name to - new_name. - - - - &reftitle.parameters; - - - - stream - - - The MCAL stream. - - - - - old_name - - - The old name. - - - - - new_name - - - The new name. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/mcal/functions/mcal-reopen.xml b/reference/mcal/functions/mcal-reopen.xml deleted file mode 100644 index 5134dce935..0000000000 --- a/reference/mcal/functions/mcal-reopen.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - mcal_reopen - Reopens an MCAL connection - - - &reftitle.description; - - boolmcal_reopen - intmcal_stream - stringcalendar - intoptions - - - Reopens an MCAL stream to a new calendar. - - - mcal_reopen reopens an MCAL connection to the - specified calendar store. - - - - &reftitle.parameters; - - - - mcal_stream - - - The MCAL stream. - - - - - calendar - - - The calendar store. - - - - - options - - - If the optional options is specified, - passes the options to that mailbox also. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/mcal/functions/mcal-snooze.xml b/reference/mcal/functions/mcal-snooze.xml deleted file mode 100644 index 1d36858ecd..0000000000 --- a/reference/mcal/functions/mcal-snooze.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - mcal_snooze - Turn off an alarm for an event - - - &reftitle.description; - - boolmcal_snooze - intstream_id - intevent_id - - - mcal_snooze turns off an alarm for a the given - calendar event. - - - - &reftitle.parameters; - - - - stream_id - - - The MCAL stream. - - - - - event_id - - - The event identifier. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/mcal/functions/mcal-store-event.xml b/reference/mcal/functions/mcal-store-event.xml deleted file mode 100644 index 5f3e576688..0000000000 --- a/reference/mcal/functions/mcal-store-event.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - mcal_store_event - Modify an existing event in an MCAL calendar - - - &reftitle.description; - - intmcal_store_event - intmcal_stream - - - mcal_store_event stores the modifications - to the current global event for the given stream. - - - - &reftitle.parameters; - - - - mcal_stream - - - The MCAL stream. - - - - - - - - &reftitle.returnvalues; - - Returns the event id of the modified event on success and &false; on error. - - - - - diff --git a/reference/mcal/functions/mcal-time-valid.xml b/reference/mcal/functions/mcal-time-valid.xml deleted file mode 100644 index 694f930f9c..0000000000 --- a/reference/mcal/functions/mcal-time-valid.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - mcal_time_valid - Validates a time - - - &reftitle.description; - - boolmcal_time_valid - inthour - intminutes - intseconds - - - Validates a time. - - - - &reftitle.parameters; - - - - hour - - - The hour. - - - - - minutes - - - The minutes. - - - - - seconds - - - The seconds. - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the given time is valid, &false; otherwise. - - - - - diff --git a/reference/mcal/functions/mcal-week-of-year.xml b/reference/mcal/functions/mcal-week-of-year.xml deleted file mode 100644 index 4436b19179..0000000000 --- a/reference/mcal/functions/mcal-week-of-year.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - mcal_week_of_year - Returns the week number of the given date - - - &reftitle.description; - - intmcal_week_of_year - intday - intmonth - intyear - - - mcal_week_of_year returns the week number of the - given date. - - - - &reftitle.parameters; - - - - day - - - The day. - - - - - month - - - The month. - - - - - year - - - The year. - - - - - - - - &reftitle.returnvalues; - - Returns the week number. - - - - - diff --git a/reference/mcal/reference.xml b/reference/mcal/reference.xml deleted file mode 100644 index 8c750210a5..0000000000 --- a/reference/mcal/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - MCAL &Functions; - - &reference.mcal.entities.functions; - - - - - diff --git a/reference/mcal/setup.xml b/reference/mcal/setup.xml deleted file mode 100644 index 6eab3235b6..0000000000 --- a/reference/mcal/setup.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - &reftitle.setup; - - -
- &reftitle.required; - - This extension requires the mcal library to be installed. Grab the - latest version from &url.mcal; - and compile and install it. - -
- - - - &reference.mcal.configure; - - - -
- &reftitle.runtime; - &no.config; -
- - - -
- &reftitle.resources; - &no.resource; -
- - - - - -