Public Member Functions | |
| render () | |
| getEventGroup ($event) | |
| getGroups () | |
| getGroupName ($group) | |
| getBody () | |
| getEventCell ($group, $inter) | |
| getEventRowSpanning ($event, $inters) | |
| getHead () | |
| getDaySpanning () | |
| daysOfWeek () | |
| getDayNumber ($start, $end) | |
| getStartEndDays () | |
| cleanEventList () | |
| getTimeIntervals ($start='', $end='') | |
| getSimultaneous () | |
| getMaxSimultaneous () | |
| __get ($prop) | |
Public Attributes | |
| $events = array() | |
| $summary = '' | |
| $opts = array() | |
| $bspans = array() | |
| $_events = array() | |
| $_time_intervals = array() | |
| $_simultaneous = array() | |
| $_max_simultaneous = array() | |
| $_groups = array() | |
The calendar is independent of other elements of Pluf, you can use it standalone if you want.
The principle is that you set options and feed the calendar with a list of events. Based on the options, the render() method will produce different views of the calendar.
| Pluf_Calendar::render | ( | ) |
Render the calendar based on the options.
| Pluf_Calendar::getEventGroup | ( | $ | event | ) |
Event are grouped by day per default, you can group as you want, just subclass this method. Groups are used to make columns in the table with the headings.
| Pluf_Calendar::getGroups | ( | ) |
Get all the available groups.
| Pluf_Calendar::getGroupName | ( | $ | group | ) |
Get the name of a group to print in the headers.
| Pluf_Calendar::getBody | ( | ) |
Generate the body of the calendar.
| Pluf_Calendar::getEventCell | ( | $ | group, | |
| $ | inter | |||
| ) |
Get the value to print for the given cell
| string | Current group | |
| string | Current interval |
| Pluf_Calendar::getEventRowSpanning | ( | $ | event, | |
| $ | inters | |||
| ) |
Get event spanning over the rows.
| array | Event | |
| array | Intervals |
| Pluf_Calendar::getHead | ( | ) |
Generate the head of the calendar.
| Pluf_Calendar::getDaySpanning | ( | ) |
Get the rowspan for each day.
| Pluf_Calendar::daysOfWeek | ( | ) |
Get an array with the days of the week.
| Pluf_Calendar::getDayNumber | ( | $ | start, | |
| $ | end | |||
| ) |
Get the number of days to list.
| string | Start date | |
| string | End date |
| Pluf_Calendar::getStartEndDays | ( | ) |
Get the start and end dates based on the event list.
| Pluf_Calendar::cleanEventList | ( | ) |
Clean event list.
| Pluf_Calendar::getTimeIntervals | ( | $ | start = '', |
|
| $ | end = '' | |||
| ) |
Get the time intervals. They span all the groups.
| Pluf_Calendar::getSimultaneous | ( | ) |
Get simultaneous events at the same time slot and same group.
| Pluf_Calendar::getMaxSimultaneous | ( | ) |
Get maximum simultaneous events
| Pluf_Calendar::__get | ( | $ | prop | ) |
Overloading of the get method.
| string | Property to get |
| Pluf_Calendar::$events = array() |
The list of events to display.
| Pluf_Calendar::$summary = '' |
| Pluf_Calendar::$opts = array() |
The display options of the calendar.
| Pluf_Calendar::$bspans = array() |
| Pluf_Calendar::$_events = array() |
List of events without the events not between the start/end days.
| Pluf_Calendar::$_time_intervals = array() |
List of time intervals in the $_events list.
| Pluf_Calendar::$_simultaneous = array() |
Simultaneous events at a given time slot, for a given group.
array('2007-03-25' => array(array('time' => '10:15', 'start' => 4 , 'continued' => 5), array('time' => '11:30', 'start' => 3 , 'continued' => 0), ) '2007-03-24' => array(array('time' => '11:30', 'start' => 2 , 'continued' => 3), ) )
| Pluf_Calendar::$_max_simultaneous = array() |
| Pluf_Calendar::$_groups = array() |