class calendar_plugin_style in Calendar 7.3
Same name and namespace in other branches
- 6.2 includes/calendar_plugin_style.inc \calendar_plugin_style
- 7 includes/calendar_plugin_style.inc \calendar_plugin_style
- 7.2 includes/calendar_plugin_style.inc \calendar_plugin_style
Default style plugin to render an iCal feed.
Hierarchy
- class \views_object
- class \views_plugin
- class \views_plugin_style
- class \calendar_plugin_style
- class \views_plugin_style
- class \views_plugin
Expanded class hierarchy of calendar_plugin_style
1 string reference to 'calendar_plugin_style'
- calendar_views_plugins in includes/
calendar.views.inc - Implementation of hook_views_plugins
File
- includes/
calendar_plugin_style.inc, line 16 - Views style plugin for the Calendar module.
View source
class calendar_plugin_style extends views_plugin_style {
var $date_info;
var $items;
var $curday;
function init(&$view, &$display, $options = NULL) {
parent::init($view, $display, $options);
if (empty($view->date_info)) {
$this->date_info = new stdClass();
}
$this->date_info =& $this->view->date_info;
}
/**
* Add custom option definitions.
*/
function option_definition() {
$options = parent::option_definition();
$options['calendar_type'] = array(
'default' => 'month',
);
$options['name_size'] = array(
'default' => 3,
);
$options['mini'] = array(
'default' => 0,
);
$options['with_weekno'] = array(
'default' => 0,
);
$options['multiday_theme'] = array(
'default' => 1,
);
$options['theme_style'] = array(
'default' => 1,
);
$options['max_items'] = array(
'default' => 0,
);
$options['max_items_behavior'] = array(
'default' => 'more',
);
$options['groupby_times'] = array(
'default' => 'hour',
);
$options['groupby_times_custom'] = array(
'default' => '',
);
$options['groupby_field'] = array(
'default' => '',
);
$options['multiday_hidden'] = array(
'default' => array(),
);
return $options;
}
function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
$form['calendar_type'] = array(
'#title' => t('Calendar type'),
'#type' => 'select',
'#description' => t('Select the calendar time period for this display.'),
'#default_value' => $this->options['calendar_type'],
'#options' => calendar_display_types(),
);
$form['mini'] = array(
'#title' => t('Display as mini calendar'),
'#default_value' => $this->options['mini'],
'#type' => 'radios',
'#options' => array(
0 => t('No'),
1 => t('Yes'),
),
'#description' => t('Display the mini style calendar, with no item details. Suitable for a calendar displayed in a block.'),
'#dependency' => array(
'edit-style-options-calendar-type' => array(
'month',
),
),
);
$form['name_size'] = array(
'#title' => t('Calendar day of week names'),
'#default_value' => $this->options['name_size'],
'#type' => 'radios',
'#options' => array(
1 => t('First letter of name'),
2 => t('First two letters of name'),
3 => t('Abbreviated name'),
99 => t('Full name'),
),
'#description' => t('The way day of week names should be displayed in a calendar.'),
'#dependency' => array(
'edit-style-options-calendar-type' => array(
'month',
'week',
'year',
),
),
);
$form['with_weekno'] = array(
'#title' => t('Show week numbers'),
'#default_value' => $this->options['with_weekno'],
'#type' => 'radios',
'#options' => array(
0 => t('No'),
1 => t('Yes'),
),
'#description' => t('Whether or not to show week numbers in the left column of calendar weeks and months.'),
'#dependency' => array(
'edit-style-options-calendar-type' => array(
'month',
),
),
);
$form['max_items'] = array(
'#title' => t('Maximum items'),
'#type' => 'select',
'#options' => array(
0 => t('Unlimited'),
1 => format_plural(1, '1 item', '@count items'),
3 => format_plural(3, '1 item', '@count items'),
5 => format_plural(5, '1 item', '@count items'),
10 => format_plural(10, '1 item', '@count items'),
),
'#default_value' => $this->options['calendar_type'] != 'day' ? $this->options['max_items'] : 0,
'#description' => t('Maximum number of items to show in calendar cells, used to keep the calendar from expanding to a huge size when there are lots of items in one day.'),
'#dependency' => array(
'edit-style-options-calendar-type' => array(
'month',
),
),
);
$form['max_items_behavior'] = array(
'#title' => t('Too many items'),
'#type' => 'select',
'#options' => array(
'more' => t("Show maximum, add 'more' link"),
'hide' => t('Hide all, add link to day'),
),
'#default_value' => $this->options['calendar_type'] != 'day' ? $this->options['max_items_behavior'] : 'more',
'#description' => t('Behavior when there are more than the above number of items in a single day. When there more items than this limit, a link to the day view will be displayed.'),
'#dependency' => array(
'edit-style-options-calendar-type' => array(
'month',
),
),
);
$form['groupby_times'] = array(
'#title' => t('Time grouping'),
'#type' => 'select',
'#default_value' => $this->options['groupby_times'],
'#description' => t("Group items together into time periods based on their start time."),
'#options' => array(
'' => t('None'),
'hour' => t('Hour'),
'half' => t('Half hour'),
'custom' => t('Custom'),
),
'#dependency' => array(
'edit-style-options-calendar-type' => array(
'day',
'week',
),
),
);
$form['groupby_times_custom'] = array(
'#title' => t('Custom time grouping'),
'#type' => 'textarea',
'#default_value' => $this->options['groupby_times_custom'],
'#description' => t("When choosing the 'custom' Time grouping option above, create custom time period groupings as a comma-separated list of 24-hour times in the format HH:MM:SS, like '00:00:00,08:00:00,18:00:00'. Be sure to start with '00:00:00'. All items after the last time will go in the final group."),
'#dependency' => array(
'edit-style-options-groupby-times' => array(
'custom',
),
),
);
$form['theme_style'] = array(
'#title' => t('Overlapping time style'),
'#default_value' => $this->options['theme_style'],
'#type' => 'select',
'#options' => array(
0 => t('Do not display overlapping items'),
1 => t('Display overlapping items, with scrolling'),
2 => t('Display overlapping items, no scrolling'),
),
'#description' => t('Select whether calendar items are displayed as overlapping items. Use scrolling to shrink the window and focus on the selected items, or omit scrolling to display the whole day. This only works if hour or half hour time grouping is chosen!'),
'#dependency' => array(
'edit-style-options-calendar-type' => array(
'day',
'week',
),
),
);
// Create a list of fields that are available for grouping,
$field_options = array();
$fields = $this->display->handler
->get_option('fields');
foreach ($fields as $field_name => $field) {
$field_options[$field_name] = $field['field'];
}
$form['groupby_field'] = array(
'#title' => t('Field grouping'),
'#type' => 'select',
'#default_value' => $this->options['groupby_field'],
'#description' => t("Optionally group items into columns by a field value, for instance select the content type to show items for each content type in their own column, or use a location field to organize items into columns by location. NOTE! This is incompatible with the overlapping style option."),
'#options' => array(
'' => '',
) + $field_options,
'#dependency' => array(
'edit-style-options-calendar-type' => array(
'day',
),
),
);
$form['multiday_theme'] = array(
'#title' => t('Multi-day style'),
'#default_value' => $this->options['multiday_theme'],
'#type' => 'select',
'#options' => array(
0 => t('Display multi-day item as a single column'),
1 => t('Display multi-day item as a multiple column row'),
),
'#description' => t('If selected, items which span multiple days will displayed as a multi-column row. If not selected, items will be displayed as an individual column.'),
'#dependency' => array(
'edit-style-options-calendar-type' => array(
'month',
'week',
),
),
);
$form['multiday_hidden'] = array(
'#title' => t('Fields to hide in Multi-day rows'),
'#default_value' => $this->options['multiday_hidden'],
'#type' => 'checkboxes',
'#options' => $field_options,
'#description' => t('Choose fields to hide when displayed in multi-day rows. Usually you only want to see the title or Colorbox selector in multi-day rows and would hide all other fields.'),
'#dependency' => array(
'edit-style-options-calendar-type' => array(
'month',
'week',
'day',
),
),
);
}
function options_validate(&$form, &$form_state) {
$values = $form_state['values']['style_options'];
if ($values['groupby_times'] == 'custom' && empty($values['groupby_times_custom'])) {
form_set_error('style_options][groupby_times_custom', t('Custom groupby times cannot be empty.'));
}
if (!empty($values['theme_style']) && (empty($values['groupby_times']) || !in_array($values['groupby_times'], array(
'hour',
'half',
)))) {
form_set_error('style_options][theme_style', t('Overlapping items only work with hour or half hour groupby times.'));
}
if (!empty($values['theme_style']) && !empty($values['groupby_field'])) {
form_set_error('style_options][theme_style', t('You cannot use overlapping items and also try to group by a field value.'));
}
if ($values['groupby_times'] != 'custom') {
form_set_value($form['groupby_times_custom'], NULL, $form_state);
}
}
function options_submit(&$form, &$form_state, &$options = array()) {
$form_state['values']['style_options']['multiday_hidden'] = array_filter($form_state['values']['style_options']['multiday_hidden']);
}
/**
* Helper function to find the date argument handler for this view.
*/
function date_argument_handler() {
$i = 0;
foreach ($this->view->argument as $name => $handler) {
if (date_views_handler_is_date($handler, 'argument')) {
$this->date_info->date_arg_pos = $i;
return $handler;
}
$i++;
}
return FALSE;
}
/**
* Inspect argument and view information to see which calendar
* period we should show. The argument tells us what to use
* if there is no value, the view args tell us what to use
* if there are values.
*/
function granularity() {
if (!($handler = $this
->date_argument_handler())) {
return 'month';
}
$default_granularity = !empty($handler) && !empty($handler->granularity) ? $handler->granularity : 'month';
$wildcard = !empty($handler) ? $handler->options['exception']['value'] : '';
$argument = $handler->argument;
// TODO Anything else we need to do for 'all' arguments?
if ($argument == $wildcard) {
$this->view_granularity = $default_granularity;
}
elseif (!empty($argument)) {
module_load_include('inc', 'date_api', 'date_api_sql');
$date_handler = new date_sql_handler();
$this->view_granularity = $date_handler
->arg_granularity($argument);
}
else {
$this->view_granularity = $default_granularity;
}
return $this->view_granularity;
}
function has_calendar_row_plugin() {
return $this->row_plugin instanceof calendar_plugin_row || $this->row_plugin instanceof calendar_plugin_row_node;
}
function render() {
if (empty($this->row_plugin) || !$this
->has_calendar_row_plugin()) {
debug('calendar_plugin_style: The calendar row plugin is required when using the calendar style, but it is missing.');
return;
}
if (!($argument = $this
->date_argument_handler())) {
debug('calendar_plugin_style: A date argument is required when using the calendar style, but it is missing or is not using the default date.');
return;
}
// There are date arguments that have not been added by Date Views.
// They will be missing the information we would need to render the field.
if (empty($argument->min_date)) {
return;
}
// Add information from the date argument to the view.
$this->date_info->granularity = $this
->granularity();
$this->date_info->calendar_type = $this->options['calendar_type'];
$this->date_info->date_arg = $argument->argument;
$this->date_info->year = date_format($argument->min_date, 'Y');
$this->date_info->month = date_format($argument->min_date, 'n');
$this->date_info->day = date_format($argument->min_date, 'j');
$this->date_info->week = date_week(date_format($argument->min_date, DATE_FORMAT_DATE));
$this->date_info->date_range = $argument->date_range;
$this->date_info->min_date = $argument->min_date;
$this->date_info->max_date = $argument->max_date;
$this->date_info->limit = $argument->limit;
$this->date_info->url = $this->view
->get_url();
$this->date_info->min_date_date = date_format($this->date_info->min_date, DATE_FORMAT_DATE);
$this->date_info->max_date_date = date_format($this->date_info->max_date, DATE_FORMAT_DATE);
$this->date_info->forbid = isset($argument->forbid) ? $argument->forbid : FALSE;
// Add calendar style information to the view.
$this->date_info->calendar_popup = $this->display->handler
->get_option('calendar_popup');
$this->date_info->style_name_size = $this->options['name_size'];
$this->date_info->mini = $this->options['mini'];
$this->date_info->style_with_weekno = $this->options['with_weekno'];
$this->date_info->style_multiday_theme = $this->options['multiday_theme'];
$this->date_info->style_theme_style = $this->options['theme_style'];
$this->date_info->style_max_items = $this->options['max_items'];
$this->date_info->style_max_items_behavior = $this->options['max_items_behavior'];
if (!empty($this->options['groupby_times_custom'])) {
$this->date_info->style_groupby_times = explode(',', $this->options['groupby_times_custom']);
}
else {
$this->date_info->style_groupby_times = calendar_groupby_times($this->options['groupby_times']);
}
$this->date_info->style_groupby_field = $this->options['groupby_field'];
// TODO make this an option setting.
$this->date_info->style_show_empty_times = !empty($this->options['groupby_times_custom']) ? TRUE : FALSE;
// Set up parameters for the current view that can be used by the row plugin.
$display_timezone = date_timezone_get($this->date_info->min_date);
$this->date_info->display_timezone = $display_timezone;
$this->date_info->display_timezone_name = timezone_name_get($display_timezone);
$date = clone $this->date_info->min_date;
date_timezone_set($date, $display_timezone);
$this->date_info->min_zone_string = date_format($date, DATE_FORMAT_DATE);
$date = clone $this->date_info->max_date;
date_timezone_set($date, $display_timezone);
$this->date_info->max_zone_string = date_format($date, DATE_FORMAT_DATE);
// Let views render fields the way it thinks they should look before we start massaging them.
$this
->render_fields($this->view->result);
// Invoke the row plugin to massage each result row into calendar items.
// Gather the row items into an array grouped by date and time.
$items = array();
foreach ($this->view->result as $row_index => $row) {
$this->view->row_index = $row_index;
$rows = $this->row_plugin
->render($row);
foreach ($rows as $key => $item) {
$item->granularity = $this->date_info->granularity;
$rendered_fields = array();
$item_start = date_format($item->calendar_start_date, DATE_FORMAT_DATE);
$item_end = date_format($item->calendar_end_date, DATE_FORMAT_DATE);
$time_start = date_format($item->calendar_start_date, 'H:i:s');
$item->rendered_fields = $this->rendered_fields[$row_index];
//set custom class to item
$item->classCustom = $this->view->style_plugin
->get_row_class($row_index);
$items[$item_start][$time_start][] = $item;
}
}
ksort($items);
$rows = array();
$this->curday = clone $this->date_info->min_date;
$this->items = $items;
// Retrieve the results array using a the right method for the granularity of the display.
switch ($this->options['calendar_type']) {
case 'year':
$rows = array();
$this->view->date_info->mini = TRUE;
for ($i = 1; $i <= 12; $i++) {
$rows[$i] = $this
->calendar_build_mini_month();
}
$this->view->date_info->mini = FALSE;
break;
case 'month':
$rows = !empty($this->date_info->mini) ? $this
->calendar_build_mini_month() : $this
->calendar_build_month();
break;
case 'day':
$rows = $this
->calendar_build_day();
break;
case 'week':
$rows = $this
->calendar_build_week();
// Merge the day names in as the first row.
$rows = array_merge(array(
calendar_week_header($this->view),
), $rows);
break;
}
// Send the sorted rows to the right theme for this type of calendar.
$this->definition['theme'] = 'calendar_' . $this->options['calendar_type'];
// Adjust the theme to match the currently selected default.
// Only the month view needs the special 'mini' class,
// which is used to retrieve a different, more compact, theme.
if ($this->options['calendar_type'] == 'month' && !empty($this->view->date_info->mini)) {
$this->definition['theme'] = 'calendar_mini';
}
elseif (in_array($this->options['calendar_type'], array(
'week',
'day',
)) && !empty($this->options['multiday_theme']) && !empty($this->options['theme_style'])) {
$this->definition['theme'] .= '_overlap';
}
$output = theme($this
->theme_functions(), array(
'view' => $this->view,
'options' => $this->options,
'rows' => $rows,
));
unset($this->view->row_index);
return $output;
}
/**
* Build one month.
*/
function calendar_build_month() {
$translated_days = date_week_days_ordered(date_week_days(TRUE));
$month = date_format($this->curday, 'n');
$curday_date = date_format($this->curday, DATE_FORMAT_DATE);
$weekdays = calendar_untranslated_days($this->items, $this->view);
date_modify($this->curday, '-' . strval(date_format($this->curday, 'j') - 1) . ' days');
$rows = array();
do {
$init_day = clone $this->curday;
$today = date_format(date_now(date_default_timezone()), DATE_FORMAT_DATE);
$month = date_format($this->curday, 'n');
$week = date_week($curday_date);
$first_day = variable_get('date_first_day', 0);
$week_rows = $this
->calendar_build_week(TRUE);
$multiday_buckets = $week_rows['multiday_buckets'];
$singleday_buckets = $week_rows['singleday_buckets'];
$total_rows = $week_rows['total_rows'];
// Theme each row
$output = "";
$final_day = clone $this->curday;
$iehint = 0;
$max_multirow_cnt = 0;
$max_singlerow_cnt = 0;
for ($i = 0; $i < intval($total_rows + 1); $i++) {
$inner = "";
// If we're displaying the week number, add it as the
// first cell in the week.
if ($i == 0 && !empty($this->date_info->style_with_weekno) && !in_array($this->date_info->granularity, array(
'day',
'week',
))) {
$path = calendar_granularity_path($this->view, 'week');
if (!empty($path)) {
$url = $path . '/' . $this->date_info->year . '-W' . $week;
$weekno = l($week, $url, array(
'query' => !empty($this->date_info->append) ? $this->date_info->append : '',
));
}
else {
// Do not link week numbers, if Week views are disabled.
$weekno = $week;
}
$item = array(
'entry' => $weekno,
'colspan' => 1,
'rowspan' => $total_rows + 1,
'id' => $this->view->name . '-weekno-' . $curday_date,
'class' => 'week',
);
$inner .= theme('calendar_month_col', array(
'item' => $item,
));
}
$this->curday = clone $init_day;
// move backwards to the first day of the week
$day_wday = date_format($this->curday, 'w');
date_modify($this->curday, '-' . strval((7 + $day_wday - $first_day) % 7) . ' days');
for ($wday = 0; $wday < 7; $wday++) {
$curday_date = date_format($this->curday, DATE_FORMAT_DATE);
$class = strtolower($weekdays[$wday]);
$item = NULL;
$in_month = !($curday_date < $this->date_info->min_date_date || $curday_date > $this->date_info->max_date_date || date_format($this->curday, 'n') != $month);
// Add the datebox
if ($i == 0) {
$variables = array(
'date' => $curday_date,
'view' => $this->view,
'items' => $this->items,
'selected' => $in_month ? count($multiday_buckets[$wday]) + count($singleday_buckets[$wday]) : FALSE,
);
$item = array(
'entry' => theme('calendar_datebox', $variables),
'colspan' => 1,
'rowspan' => 1,
'class' => 'date-box',
'date' => $curday_date,
'id' => $this->view->name . '-' . $curday_date . '-date-box',
'header_id' => $translated_days[$wday],
'day_of_month' => $this->curday
->format('j'),
);
$item['class'] .= ($curday_date == $today && $in_month ? ' today' : '') . ($curday_date < $today ? ' past' : '') . ($curday_date > $today ? ' future' : '');
}
else {
$index = $i - 1;
$multi_count = count($multiday_buckets[$wday]);
// Process multiday buckets first. If there is a multiday-bucket item in this row...
if ($index < $multi_count) {
// If this item is filled with either a blank or an entry...
if ($multiday_buckets[$wday][$index]['filled']) {
// Add item and add class
$item = $multiday_buckets[$wday][$index];
$item['class'] = 'multi-day';
$item['date'] = $curday_date;
// Is this an entry?
if (!$multiday_buckets[$wday][$index]['avail']) {
// If the item either starts or ends on today,
// then add tags so we can style the borders
if ($curday_date == $today && $in_month) {
$item['class'] .= ' starts-today';
}
// Calculate on which day of this week this item ends on..
$end_day = clone $this->curday;
$span = $item['colspan'] - 1;
date_modify($end_day, '+' . $span . ' day');
$endday_date = date_format($end_day, DATE_FORMAT_DATE);
// If it ends today, add class
if ($endday_date == $today && $in_month) {
$item['class'] .= ' ends-today';
}
}
}
// If this is an actual entry, add classes regarding the state of the
// item
if ($multiday_buckets[$wday][$index]['avail']) {
$item['class'] .= ' ' . $wday . ' ' . $index . ' no-entry ' . ($curday_date == $today && $in_month ? ' today' : '') . ($curday_date < $today ? ' past' : '') . ($curday_date > $today ? ' future' : '');
}
// Else, process the single day bucket - we only do this once per day
}
elseif ($index == $multi_count) {
$single_day_cnt = 0;
// If it's empty, add class
if (count($singleday_buckets[$wday]) == 0) {
$single_days = " ";
if ($max_multirow_cnt == 0) {
$class = $multi_count > 0 ? 'single-day no-entry noentry-multi-day' : 'single-day no-entry';
}
else {
$class = 'single-day';
}
}
else {
$single_days = "";
foreach ($singleday_buckets[$wday] as $day) {
foreach ($day as $event) {
$single_day_cnt++;
$single_days .= isset($event['more_link']) ? '<div class="calendar-more">' . $event['entry'] . '</div>' : $event['entry'];
}
}
$class = 'single-day';
}
$rowspan = $total_rows - $index;
// Add item...
$item = array(
'entry' => $single_days,
'colspan' => 1,
'rowspan' => $rowspan,
'class' => $class,
'date' => $curday_date,
'id' => $this->view->name . '-' . $curday_date . '-' . $index,
'header_id' => $translated_days[$wday],
'day_of_month' => $this->curday
->format('j'),
);
// Hack for ie to help it properly space single day rows
if ($rowspan > 1 && $in_month && $single_day_cnt > 0) {
$max_multirow_cnt = max($max_multirow_cnt, $single_day_cnt);
}
else {
$max_singlerow_cnt = max($max_singlerow_cnt, $single_day_cnt);
}
// If the singlerow is bigger than the multi-row, then null out
// ieheight - I'm estimating that a single row is twice the size of
// multi-row. This is really the best that can be done with ie
if ($max_singlerow_cnt >= $max_multirow_cnt || $max_multirow_cnt <= $multi_count / 2) {
$iehint = 0;
}
elseif ($rowspan > 1 && $in_month && $single_day_cnt > 0) {
$iehint = max($iehint, $rowspan - 1);
// How many rows to adjust for?
}
// Set the class
$item['class'] .= ($curday_date == $today && $in_month ? ' today' : '') . ($curday_date < $today ? ' past' : '') . ($curday_date > $today ? ' future' : '');
}
}
// If there isn't an item, then add empty class
if ($item != NULL) {
if (!$in_month) {
$item['class'] .= ' empty';
}
// Style this entry - it will be a <td>.
$inner .= theme('calendar_month_col', array(
'item' => $item,
));
}
date_modify($this->curday, '+1 day');
}
if ($i == 0) {
$output .= theme('calendar_month_row', array(
'inner' => $inner,
'class' => 'date-box',
'iehint' => $iehint,
));
}
elseif ($i == $total_rows) {
$output .= theme('calendar_month_row', array(
'inner' => $inner,
'class' => 'single-day',
'iehint' => $iehint,
));
$iehint = 0;
$max_singlerow_cnt = 0;
$max_multirow_cnt = 0;
}
else {
// Style all the columns into a row
$output .= theme('calendar_month_row', array(
'inner' => $inner,
'class' => 'multi-day',
'iehint' => 0,
));
}
}
// End foreach
$this->curday = $final_day;
// Add the row into the row array....
$rows[] = array(
'data' => $output,
);
$curday_date = date_format($this->curday, DATE_FORMAT_DATE);
$curday_month = date_format($this->curday, 'n');
} while ($curday_month == $month && $curday_date <= $this->date_info->max_date_date);
// Merge the day names in as the first row.
$rows = array_merge(array(
calendar_week_header($this->view),
), $rows);
return $rows;
}
/**
* Build one week row.
*/
function calendar_build_week($check_month = FALSE) {
$curday_date = date_format($this->curday, DATE_FORMAT_DATE);
$weekdays = calendar_untranslated_days($this->items, $this->view);
$month = date_format($this->curday, 'n');
$first_day = variable_get('date_first_day', 0);
// Set up buckets
$total_rows = 0;
$multiday_buckets = array(
array(),
array(),
array(),
array(),
array(),
array(),
array(),
);
$singleday_buckets = array(
array(),
array(),
array(),
array(),
array(),
array(),
array(),
);
// move backwards to the first day of the week
$day_wday = date_format($this->curday, 'w');
date_modify($this->curday, '-' . strval((7 + $day_wday - $first_day) % 7) . ' days');
$curday_date = date_format($this->curday, DATE_FORMAT_DATE);
for ($i = 0; $i < 7; $i++) {
if ($check_month && ($curday_date < $this->date_info->min_date_date || $curday_date > $this->date_info->max_date_date || date_format($this->curday, 'n') != $month)) {
$class = strtolower($weekdays[$i]) . ' empty';
$singleday_buckets[$i][][] = array(
'entry' => theme('calendar_empty_day', array(
'curday' => $curday_date,
'view' => $this->view,
)),
'item' => NULL,
);
}
else {
$this
->calendar_build_week_day($i, $multiday_buckets, $singleday_buckets);
}
$total_rows = max(count($multiday_buckets[$i]) + 1, $total_rows);
date_modify($this->curday, '+1 day');
$curday_date = date_format($this->curday, DATE_FORMAT_DATE);
}
$rows = array(
'multiday_buckets' => $multiday_buckets,
'singleday_buckets' => $singleday_buckets,
'total_rows' => $total_rows,
);
return $rows;
}
/**
* Build the contents of a single day for the $rows results.
*/
function calendar_build_week_day($wday, &$multiday_buckets, &$singleday_buckets) {
$curday_date = date_format($this->curday, DATE_FORMAT_DATE);
$max_events = $this->date_info->calendar_type == 'month' && !empty($this->date_info->style_max_items) ? $this->date_info->style_max_items : 0;
$hide = !empty($this->date_info->style_max_items_behavior) ? $this->date_info->style_max_items_behavior == 'hide' : FALSE;
$multiday_theme = !empty($this->date_info->style_multiday_theme) && $this->date_info->style_multiday_theme == '1';
$first_day = variable_get('date_first_day', 0);
$cur_cnt = 0;
$extra_events = FALSE;
$total_cnt = 0;
$ids = array();
// If we are hiding, count before processing further
if ($max_events != CALENDAR_SHOW_ALL) {
foreach ($this->items as $date => $day) {
if ($date == $curday_date) {
foreach ($day as $time => $hour) {
foreach ($hour as $key => $item) {
$total_cnt++;
$ids[] = $item->date_id;
}
}
}
}
}
// If we haven't already exceeded the max or we'll showing all, then process the items
if ($max_events == CALENDAR_SHOW_ALL || !$hide || $total_cnt < $max_events) {
// Count currently filled items
foreach ($multiday_buckets[$wday] as $bucket) {
if (!$bucket['avail']) {
$cur_cnt++;
}
}
foreach ($this->items as $date => $day) {
if ($date == $curday_date) {
ksort($day);
foreach ($day as $time => $hour) {
foreach ($hour as $key => $item) {
$all_day = $item->calendar_all_day;
// Parse out date part
$start_ydate = date_format($item->date_start, DATE_FORMAT_DATE);
$end_ydate = date_format($item->date_end, DATE_FORMAT_DATE);
$cur_ydate = date_format($this->curday, DATE_FORMAT_DATE);
$is_multi_day = $start_ydate < $cur_ydate || $end_ydate > $cur_ydate;
// Does this event span multi-days?
if ($multiday_theme && ($is_multi_day || $all_day)) {
// Remove multiday items from the total count. We can't hide them or they will break.
$total_cnt--;
// If this the first day of the week, or is the start date of the multi-day event,
// then record this item, otherwise skip over
$day_no = date_format($this->curday, 'd');
if ($wday == 0 || $start_ydate == $cur_ydate || $this->date_info->granularity == 'month' && $day_no == 1 || $all_day && !$is_multi_day) {
// Calculate the colspan for this event
// If the last day of this event exceeds the end of the current month or week,
// truncate the remaining days
$diff = $this->curday
->difference($this->date_info->max_date, 'days');
$remaining_days = $this->date_info->granularity == 'month' ? min(6 - $wday, $diff) : $diff;
// The bucket_cnt defines the colspan. colspan = bucket_cnt + 1
$days = $this->curday
->difference($item->date_end, 'days');
$bucket_cnt = max(0, min($days, $remaining_days));
// See if there is an available slot to add an event. This will allow
// an event to precede a row filled up by a previous day event
$avail = FALSE;
$bucket_index = count($multiday_buckets[$wday]);
for ($i = 0; $i < $bucket_index; $i++) {
if ($multiday_buckets[$wday][$i]['avail']) {
$bucket_index = $i;
break;
}
}
// Add continuation attributes
$item->continuation = $item->date_start < $this->curday;
$item->continues = $days > $bucket_cnt;
$item->is_multi_day = TRUE;
// Assign the item to the available bucket
$multiday_buckets[$wday][$bucket_index] = array(
'colspan' => $bucket_cnt + 1,
'rowspan' => 1,
'filled' => TRUE,
'avail' => FALSE,
'all_day' => $all_day,
'item' => $item,
'wday' => $wday,
'entry' => theme('calendar_item', array(
'view' => $this->view,
'rendered_fields' => $item->rendered_fields,
'item' => $item,
)),
);
// Block out empty buckets for the next days in this event for this week
for ($i = 0; $i < $bucket_cnt; $i++) {
$bucket =& $multiday_buckets[$i + $wday + 1];
$bucket_row_count = count($bucket);
$row_diff = $bucket_index - $bucket_row_count;
// Fill up the preceding buckets - these are available for future
// events
for ($j = 0; $j < $row_diff; $j++) {
$bucket[$bucket_row_count + $j] = array(
'entry' => ' ',
'colspan' => 1,
'rowspan' => 1,
'filled' => TRUE,
'avail' => TRUE,
'wday' => $wday,
'item' => NULL,
);
}
$bucket[$bucket_index] = array(
'filled' => FALSE,
'avail' => FALSE,
);
}
}
}
elseif ($max_events == CALENDAR_SHOW_ALL || $cur_cnt < $max_events) {
$cur_cnt++;
// Assign to single day bucket
$singleday_buckets[$wday][$time][] = array(
'entry' => theme('calendar_item', array(
'view' => $this->view,
'rendered_fields' => $item->rendered_fields,
'item' => $item,
)),
'item' => $item,
'colspan' => 1,
'rowspan' => 1,
'filled' => TRUE,
'avail' => FALSE,
'wday' => $wday,
);
}
elseif (!$extra_events) {
// The event we're currently on will never be displaed.
// So let's set a flag the make sure more link is set.
$extra_events = TRUE;
}
}
}
}
}
}
// Add a more link if necessary
if ($max_events != CALENDAR_SHOW_ALL && $total_cnt > 0 && ($cur_cnt < $total_cnt || $extra_events)) {
$entry = theme('calendar_' . $this->date_info->calendar_type . '_multiple_entity', array(
'curday' => $curday_date,
'count' => $total_cnt,
'view' => $this->view,
'ids' => $ids,
));
if (!empty($entry)) {
$singleday_buckets[$wday][][] = array(
'entry' => $entry,
'more_link' => TRUE,
'item' => NULL,
);
}
}
}
/**
* Build the contents of a single day for the $rows results.
*/
function calendar_build_day() {
$curday_date = date_format($this->curday, DATE_FORMAT_DATE);
$selected = FALSE;
$max_events = !empty($this->date_info->style_max_items) ? $this->date_info->style_max_items : 0;
$ids = array();
$inner = array();
$all_day = array();
$empty = '';
$link = '';
$count = 0;
foreach ($this->items as $date => $day) {
if ($date == $curday_date) {
$count = 0;
$selected = TRUE;
ksort($day);
foreach ($day as $time => $hour) {
foreach ($hour as $key => $item) {
$count++;
if (isset($item->type)) {
$ids[$item->type] = $item;
}
if (empty($this->date_info->mini) && ($max_events == CALENDAR_SHOW_ALL || $count <= $max_events || $count > 0 && $max_events == CALENDAR_HIDE_ALL)) {
if ($item->calendar_all_day) {
$item->is_multi_day = TRUE;
$all_day[] = $item;
}
else {
$key = date_format($item->calendar_start_date, 'H:i:s');
$inner[$key][] = $item;
}
}
}
}
}
}
ksort($inner);
if (empty($inner) && empty($all_day)) {
$empty = theme('calendar_empty_day', array(
'curday' => $curday_date,
'view' => $this->view,
));
}
// We have hidden events on this day, use the theme('calendar_multiple_') to show a link.
if ($max_events != CALENDAR_SHOW_ALL && $count > 0 && $count > $max_events && $this->date_info->calendar_type != 'day' && !$this->date_info->mini) {
if ($this->date_info->style_max_items_behavior == 'hide' || $max_events == CALENDAR_HIDE_ALL) {
$all_day = array();
$inner = array();
}
$link = theme('calendar_' . $this->date_info->calendar_type . '_multiple_node', array(
'curday' => $curday_date,
'count' => $count,
'view' => $this->view,
'ids' => $ids,
));
}
$content = array(
'date' => $curday_date,
'datebox' => theme('calendar_datebox', array(
'date' => $curday_date,
'view' => $this->view,
'items' => $this->items,
'selected' => $selected,
)),
'empty' => $empty,
'link' => $link,
'all_day' => $all_day,
'items' => $inner,
);
return $content;
}
/**
* Build one mini month.
*/
function calendar_build_mini_month() {
$month = date_format($this->curday, 'n');
date_modify($this->curday, '-' . strval(date_format($this->curday, 'j') - 1) . ' days');
$rows = array();
do {
$rows = array_merge($rows, $this
->calendar_build_mini_week());
$curday_date = date_format($this->curday, DATE_FORMAT_DATE);
$curday_month = date_format($this->curday, 'n');
} while ($curday_month == $month && $curday_date <= $this->date_info->max_date_date);
// Merge the day names in as the first row.
$rows = array_merge(array(
calendar_week_header($this->view),
), $rows);
return $rows;
}
/**
* Build one week row.
*/
function calendar_build_mini_week($check_month = TRUE) {
$curday_date = date_format($this->curday, DATE_FORMAT_DATE);
$weekdays = calendar_untranslated_days($this->items, $this->view);
$today = date_format(date_now(date_default_timezone()), DATE_FORMAT_DATE);
$month = date_format($this->curday, 'n');
$week = date_week($curday_date);
$first_day = variable_get('date_first_day', 0);
// move backwards to the first day of the week
$day_wday = date_format($this->curday, 'w');
date_modify($this->curday, '-' . strval((7 + $day_wday - $first_day) % 7) . ' days');
$curday_date = date_format($this->curday, DATE_FORMAT_DATE);
if (!empty($this->date_info->style_with_weekno)) {
$path = calendar_granularity_path($this->view, 'week');
if (!empty($path)) {
$url = $path . '/' . $this->date_info->year . '-W' . $week;
$weekno = l($week, $url, array(
'query' => !empty($this->date_info->append) ? $this->date_info->append : '',
));
}
else {
// Do not link week numbers, if Week views are disabled.
$weekno = $week;
}
$rows[$week][] = array(
'data' => $weekno,
'class' => 'mini week',
'id' => $this->view->name . '-weekno-' . $curday_date,
);
}
for ($i = 0; $i < 7; $i++) {
$curday_date = date_format($this->curday, DATE_FORMAT_DATE);
$class = strtolower($weekdays[$i] . ' mini');
if ($check_month && ($curday_date < $this->date_info->min_date_date || $curday_date > $this->date_info->max_date_date || date_format($this->curday, 'n') != $month)) {
$class .= ' empty';
$variables = array(
'curday' => $curday_date,
'view' => $this->view,
);
$content = array(
'date' => '',
'datebox' => '',
'empty' => theme('calendar_empty_day', $variables),
'link' => '',
'all_day' => array(),
'items' => array(),
);
}
else {
$content = $this
->calendar_build_day();
$class .= ($curday_date == $today ? ' today' : '') . ($curday_date < $today ? ' past' : '') . ($curday_date > $today ? ' future' : '') . (empty($this->items[$curday_date]) ? ' has-no-events' : ' has-events');
}
$rows[$week][] = array(
'data' => $content,
'class' => $class,
'id' => $this->view->name . '-' . $curday_date,
);
date_modify($this->curday, '+1 day');
}
return $rows;
}
}Members
Name |
Modifiers | Type | Description | Overrides |
|---|---|---|---|---|
|
calendar_plugin_style:: |
property | |||
|
calendar_plugin_style:: |
property | |||
|
calendar_plugin_style:: |
property | |||
|
calendar_plugin_style:: |
function | Build the contents of a single day for the $rows results. | ||
|
calendar_plugin_style:: |
function | Build one mini month. | ||
|
calendar_plugin_style:: |
function | Build one week row. | ||
|
calendar_plugin_style:: |
function | Build one month. | ||
|
calendar_plugin_style:: |
function | Build one week row. | ||
|
calendar_plugin_style:: |
function | Build the contents of a single day for the $rows results. | ||
|
calendar_plugin_style:: |
function | Helper function to find the date argument handler for this view. | ||
|
calendar_plugin_style:: |
function | Inspect argument and view information to see which calendar period we should show. The argument tells us what to use if there is no value, the view args tell us what to use if there are values. | ||
|
calendar_plugin_style:: |
function | |||
|
calendar_plugin_style:: |
function |
Initialize a style plugin. Overrides views_plugin_style:: |
||
|
calendar_plugin_style:: |
function |
Provide a form to edit options for this plugin. Overrides views_plugin_style:: |
||
|
calendar_plugin_style:: |
function |
Handle any special handling on the validate form. Overrides views_plugin:: |
||
|
calendar_plugin_style:: |
function |
Validate the options form. Overrides views_plugin_style:: |
||
|
calendar_plugin_style:: |
function |
Add custom option definitions. Overrides views_plugin_style:: |
||
|
calendar_plugin_style:: |
function |
Render the display in this style. Overrides views_plugin_style:: |
||
|
views_object:: |
public | property | Handler's definition. | |
|
views_object:: |
public | property | Except for displays, options for the object will be held here. | 1 |
|
views_object:: |
function | Collect this handler's option definition and alter them, ready for use. | ||
|
views_object:: |
public | function | Views handlers use a special construct function. | 4 |
|
views_object:: |
public | function | 1 | |
|
views_object:: |
public | function | ||
|
views_object:: |
public | function | Always exports the option, regardless of the default value. | |
|
views_object:: |
public | function | Set default options on this object. | 1 |
|
views_object:: |
public | function | Set default options. | |
|
views_object:: |
public | function | Let the handler know what its full definition is. | |
|
views_object:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
|
views_object:: |
public | function | Unpack a single option definition. | |
|
views_object:: |
public | function | Unpacks each handler to store translatable texts. | |
|
views_object:: |
public | function | ||
|
views_plugin:: |
public | property | The current used views display. | |
|
views_plugin:: |
public | property | The plugin name of this plugin, for example table or full. | |
|
views_plugin:: |
public | property | The plugin type of this plugin, for example style or query. | |
|
views_plugin:: |
public | property |
The top object of a view. Overrides views_object:: |
1 |
|
views_plugin:: |
public | function | Provide a list of additional theme functions for the theme info page. | |
|
views_plugin:: |
public | function | Return the human readable name of the display. | |
|
views_plugin:: |
public | function | Returns the summary of the settings in the display. | 8 |
|
views_plugin:: |
public | function | Provide a full list of possible theme templates used by this style. | |
|
views_plugin_style:: |
public | property | The row plugin, if it's initialized and the style itself supports it. | |
|
views_plugin_style:: |
public | property | Store all available tokens row rows. | |
|
views_plugin_style:: |
public | function | Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query. | 1 |
|
views_plugin_style:: |
public | function | Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view. | 1 |
|
views_plugin_style:: |
public | function |
Destructor. Overrides views_object:: |
|
|
views_plugin_style:: |
public | function | Should the output of the style plugin be rendered even if it's empty. | 1 |
|
views_plugin_style:: |
public | function | Get a rendered field. | |
|
views_plugin_style:: |
public | function | Get the raw field value. | |
|
views_plugin_style:: |
public | function | Return the token replaced row class for the specified row. | |
|
views_plugin_style:: |
public | function | Allow the style to do stuff before each row is rendered. | |
|
views_plugin_style:: |
public | function |
Add anything to the query that we might need to. Overrides views_plugin:: |
2 |
|
views_plugin_style:: |
public | function | Render all of the fields for a given style and store them on the object. | |
|
views_plugin_style:: |
public | function | Group records as needed for rendering. | |
|
views_plugin_style:: |
public | function | Render the grouping sets. | |
|
views_plugin_style:: |
public | function | Take a value and apply token replacement logic to it. | |
|
views_plugin_style:: |
public | function | Return TRUE if this style also uses fields. | |
|
views_plugin_style:: |
public | function | Return TRUE if this style also uses a row plugin. | |
|
views_plugin_style:: |
public | function | Return TRUE if this style also uses a row plugin. | |
|
views_plugin_style:: |
public | function | Return TRUE if this style uses tokens. | |
|
views_plugin_style:: |
public | function |
Validate that the plugin is correct and can be saved. Overrides views_plugin:: |