 |
|
 PhpDig.net |
What is PhpDig?
PhpDig is a PHP MySQL based Web Spider & Search Engine. |
mcal_list_events
Synopsis
array mcal_list_events(MCALconnection, startyear, startmonth, startday, endyear, endmonth, endday);
int MCALconnection: An open
MCAL connection
int startyear: The year of
the start of the search range
int startmonth: The month of
the start of the search range
int startday: The day of the
start of the search range
int endyear: The year of the
end of the search range
int endmonth: The month of
the end of the search range
int endday: The day of the
end of the search range
Description
This function returns an array of all events that occur within the specified date range. This includes recurring events that have at least one recurrence inside the range.
Note
However, events that recur inside the range will only be returned once. You must use mcal_next_recurrence() to get the rest of the recurrences inside the date range.
Example
$calendar = "{/mstore}";
$MCALconnection = mcal_open($calendar, "username", "password");
// List all events during the week of October 1st to 7th.
$start_year = 2001;
$start_month = MCAL_OCTOBER;
$start_day = 1;
$end_year = 2001;
$end_month = MCAL_OCTOBER;
$end_day = 7;
$events = mcal_list_events($MCALconnection, $start_year,
$start_month, $start_day,
$end_year, $end_month, $end_day);
foreach ($events as $eventid) {
echo "Event " . $eventid . " occurs during this time period.<br />";
}