function calendar_plugin_style::render in Calendar 7.3

Same name and namespace in other branches

1. 6.2 includes/calendar_plugin_style.inc \calendar_plugin_style::render()
2. 7 includes/calendar_plugin_style.inc \calendar_plugin_style::render()
3. 7.2 includes/calendar_plugin_style.inc \calendar_plugin_style::render()

Render the display in this style.

Overrides views_plugin_style::render

File

includes/calendar_plugin_style.inc, line 232

Views style plugin for the Calendar module.

Class

calendar_plugin_style

Default style plugin to render an iCal feed.

Code

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;
}