views_plugin_ds_object_view.inc in Display Suite 6.2

Contains the ds views node style plugin.

File

views/views_plugin_ds_object_view.inc

<?php

/**
 * @file
 * Contains the ds views node style plugin.
 */

/**
 * Plugin which sets a build mode on the resulting object.
 */
class views_plugin_ds_object_view extends views_plugin_row {

  // Views 3 support: set base_table and base_field.
  function init(&$view, &$display, $options = NULL) {
    parent::init($view, $display, $options);
    if (version_compare(views_api_version(), '2.0') == 1) {
      $this->base_table = $view->base_table;

      // Special case for apachesolr_views.
      if ($this->base_table == 'apachesolr_node' || $this->base_table == 'apachesolr') {
        $this->base_table = 'node';
      }
      $this->base_field = $this
        ->ds_views_3_support();
    }
  }

  // Return base_field based on base_table. It might not be
  // the cleanest solution, it's the fastest though. No
  // need to a lot of mumbo jumbo here.
  function ds_views_3_support() {
    $base_table_fields = array(
      'node' => 'nid',
      'users' => 'uid',
      'comments' => 'cid',
      'apachesolr' => 'nid',
      'apachesolr_node' => 'nid',
    );
    return $base_table_fields[$this->base_table];
  }
  function option_definition() {
    $options = parent::option_definition();
    $options['build_mode'] = array(
      'default' => 'teaser',
    );
    $options['changing'] = array(
      'default' => FALSE,
    );
    $options['advanced'] = array(
      'default' => FALSE,
    );
    return $options;
  }
  function options_form(&$form, &$form_state) {
    $views_base_table = $this->view->base_table;
    $build_mode_options = array();
    $build_modes = ds_get_build_modes();
    foreach ($build_modes as $module => $modes) {
      $function = $module . '_ds_api';
      $api_info = $function();

      // $api_info['views_base'] can either be a string or an array.
      if (is_array($api_info['views_base']) && in_array($views_base_table, $api_info['views_base']) || is_string($api_info['views_base']) && $api_info['views_base'] == $views_base_table) {
        foreach ($modes as $key => $title) {
          $build_mode_options[$key] = $title['title'];
        }
      }
    }

    // Default build mode.
    $form['default_fieldset'] = array(
      '#type' => 'fieldset',
      '#title' => t('Default build mode'),
      '#collapsible' => TRUE,
      '#collapsed' => $this->options['advanced'],
    );
    $form['default_fieldset']['build_mode'] = array(
      '#type' => 'select',
      '#default_value' => $this->options['build_mode'],
      '#options' => $build_mode_options,
      '#description' => t('Make sure you select a build mode which is compatible with the base table of this view which is %base_table. <br />Also note that if you excluded build modes, you will still see them listed here as it\'s possible to list different types in a view.', array(
        '%base_table' => $this->view->base_table,
      )),
    );

    // Changing build modes.
    $form['changing_fieldset'] = array(
      '#type' => 'fieldset',
      '#title' => t('Changing build mode'),
      '#collapsible' => TRUE,
      '#collapsed' => !$this->options['changing'],
    );
    $form['changing_fieldset']['changing'] = array(
      '#type' => 'checkbox',
      '#title' => t('Use the changing build mode selector'),
      '#default_value' => $this->options['changing'],
    );
    $form['changing_fieldset']['allpages'] = array(
      '#type' => 'checkbox',
      '#title' => t('Use this configuration on every page. Otherwise the default build mode is used as soon you browse away from the first page of this view.'),
      '#default_value' => isset($this->options['changing_fieldset']['allpages']) ? $this->options['changing_fieldset']['allpages'] : FALSE,
    );
    $limit = $this->view->display_handler
      ->get_option('items_per_page');
    if ($limit == 0 || $limit > 20) {
      $form['changing_fieldset']['disabled'] = array(
        '#type' => 'markup',
        '#value' => t('This option is disabled because you have unlimited items or listing more than 20 items.'),
      );
      $form['changing_fieldset']['changing']['#disabled'] = TRUE;
      $form['changing_fieldset']['allpages']['#disabled'] = TRUE;
    }
    else {
      $i = 1;
      $a = 0;
      while ($limit != 0) {
        $form['changing_fieldset']['item_' . $a] = array(
          '#title' => 'Item ' . $i,
          '#type' => 'select',
          '#default_value' => isset($this->options['changing_fieldset']['item_' . $a]) ? $this->options['changing_fieldset']['item_' . $a] : 'teaser',
          '#options' => $build_mode_options,
        );
        $limit--;
        $a++;
        $i++;
      }
    }

    // Grouping rows.
    $sorts = $this->view->display_handler
      ->get_option('sorts');
    $groupable = !empty($sorts) && $this->options['grouping'];
    $form['grouping_fieldset'] = array(
      '#type' => 'fieldset',
      '#title' => t('Group data'),
      '#collapsible' => TRUE,
      '#collapsed' => !$groupable,
    );
    $form['grouping_fieldset']['grouping'] = array(
      '#type' => 'checkbox',
      '#title' => t('Group data on a field. The value of this field will be displayed too.'),
      '#default_value' => $groupable,
    );
    if (!empty($sorts)) {
      $sort_options = array();
      foreach ($sorts as $key => $sort) {
        $sort_name = ucfirst(str_replace('_', ' ', $sort['table']) . ' ' . $sort['field']);
        $sort_options[$sort['table'] . '_' . $sort['field']] = $sort_name;
      }
      $form['grouping_fieldset']['group_field'] = array(
        '#type' => 'select',
        '#options' => $sort_options,
        '#default_value' => $this->options['grouping_fieldset']['group_field'],
      );
    }
    else {
      $form['grouping_fieldset']['grouping']['#disabled'] = TRUE;
      $form['grouping_fieldset']['grouping']['#description'] = t('Grouping is disabled because you do not have any sort fields.');
    }

    // Advanced function.
    $form['advanced_fieldset'] = array(
      '#type' => 'fieldset',
      '#title' => t('Advanced build mode'),
      '#collapsible' => TRUE,
      '#collapsed' => !$this->options['advanced'],
    );
    $form['advanced_fieldset']['advanced'] = array(
      '#type' => 'checkbox',
      '#title' => t('Use the advanced build mode selector'),
      '#description' => t('This gives you the opportunity to have full control of a list for really advanced features.<br /> There is no UI for this, you need to create a function named like this: <strong><em>ds_views_row_adv_@VIEWSNAME(&$variables, $build_mode)</em></strong>.<br />See <a href="http://drupal.org/node/697320#ds_views_row_adv_VIEWSNAME">http://drupal.org/node/697320#ds_views_row_adv_VIEWSNAME</a> for an example.', array(
        '@VIEWSNAME' => $this->view->name,
      )),
      '#default_value' => $this->options['advanced'],
    );
  }

  /**
   * Validate build mode type selector.
   */
  function options_validate($form, &$form_state) {
    if (($form_state['values']['row_options']['changing_fieldset']['changing'] || $form_state['values']['row_options']['grouping_fieldset']['grouping']) && $form_state['values']['row_options']['advanced_fieldset']['advanced']) {
      form_set_error('advanced', t('You can not have changing/grouping and advanced enabled at the same time'));
    }
  }

  /**
   * Reset all fieldsets except for changing.
   */
  function options_submit($form, &$form_state) {
    $form_state['values']['row_options']['build_mode'] = $form_state['values']['row_options']['default_fieldset']['build_mode'];
    $form_state['values']['row_options']['changing'] = $form_state['values']['row_options']['changing_fieldset']['changing'];
    $form_state['values']['row_options']['grouping'] = $form_state['values']['row_options']['grouping_fieldset']['grouping'];
    $form_state['values']['row_options']['advanced'] = $form_state['values']['row_options']['advanced_fieldset']['advanced'];
  }

}

Classes

Name	Description
views_plugin_ds_object_view	Plugin which sets a build mode on the resulting object.