getCalendarWeek
Description
Returns the information needed to show a calendar for the given week.
Syntax
array getCalendarWeek (int $month, int $year, int $day, array $calendarOptions)
Parameter $month
Expected type: Integer
Description: The month
Parameter $year
Expected type: Integer
Description: The year
Parameter $day
Expected type: Integer
Description: The day
Parameter $calendarOptions
Expected type: Array
Description: An array of options for the calendar
| Array Elements of $calendarOptions | |||
| Key | Optional | Expected type | Description |
| show_birthdays | no | Boolean | Whether or not to show birthdays |
| show_events | no | Boolean | Whether or not to show events |
| show_holidays | no | Boolean | Whether or not to show holidays |
| show_next_prev | no | Boolean | Whether or not to show links to the previous and next weeks |
| show_week_num | no | Boolean | Whether or not to show week numbers |
| start_day | yes | Integer | An integer from 0 to 6 specifying which day of the week to start on |
Return value
Expected type: Array of arrays
Description: An array of arrays with information about the current week. Similar to the one returned by getCalendarGrid, but with less info. See code for complete details.