class quicktabs_style_plugin in Quick Tabs 6.3

Style plugin to display Quicktabs.

Hierarchy

• class \quicktabs_style_plugin extends \views_plugin_style

1 string reference to 'quicktabs_style_plugin'

quicktabs_views_plugins in includes/quicktabs.views.inc

Implementation of hook_views_plugins().

File

includes/quicktabs_style_plugin.inc, line 11

Add Quicktabs style plugins to Views.

class quicktabs_style_plugin extends views_plugin_style {

  // Allow some options for the style.
  function option_definition() {
    $options = parent::option_definition();
    $options['tab_style'] = array(
      'default' => 'default',
    );
    $options['tab_title_field'] = array(
      'default' => NULL,
    );
    return $options;
  }

  // Create the options form.
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['tab_style'] = array(
      '#type' => 'select',
      '#title' => t('Tab style'),
      '#options' => quicktabs_style_options(),
      '#default_value' => $this->options['tab_style'],
      '#description' => t('The tab style that will be applied to this set of tabs. Note that this style may not show in the live preview.'),
      '#weight' => -5,
    );
    if (isset($form['grouping'])) {
      $options = $form['grouping']['#options'];
      unset($options['']);
      $form['tab_title_field'] = array(
        '#type' => 'select',
        '#title' => t('Title field'),
        '#options' => $options,
        '#required' => TRUE,
        '#default_value' => $this->options['tab_title_field'],
        '#description' => t('Select the field that will be used as the tab title.'),
        '#weight' => -3,
      );
    }
  }

  // Ensure we have all the settings necessary to render into tabs.
  function validate() {
    $errors = parent::validate();

    // Ensure that we're using the field row style.
    if (!$this->row_plugin
      ->uses_fields()) {
      $errors[] = t('Display "@display" uses the "@style" row style, but the Quicktabs display style requires use of the "Fields" row style.', array(
        '@display' => $this->display->display_title,
        '@style' => $this->row_plugin->definition['title'],
      ));
    }

    // Ensure that a valid tab title field is selected.
    $fields = $this->display->handler
      ->get_handlers('field');
    if (empty($this->options['tab_title_field']) || !isset($fields[$this->options['tab_title_field']])) {
      $errors[] = t('The Quicktabs display style requires that a field be configured to be used as the tab title.');
    }
    return $errors;
  }

  // Override the render functionality.
  function render() {
    if (empty($this->row_plugin)) {
      vpr('views_plugin_style_default: Missing row plugin');
      return;
    }
    $view = $this->view;
    $machine_name = 'view__' . $view->name . '__' . $view->current_display;

    // Group the rows according to the grouping field, if specified.
    $sets = $this
      ->render_grouping($this->view->result, $this->options['grouping']);
    $tabs = array();
    foreach ($sets as $title => $records) {
      if ($this
        ->uses_row_plugin()) {
        $rows = array();
        foreach ($records as $row_index => $row) {
          $this->view->row_index = $row_index;
          $rows[] = $this->row_plugin
            ->render($row);
        }
      }
      else {
        $rows = $records;
      }

      // If grouped, we'll be using the group title for each tab.
      if ($this->options['grouping']) {

        // Remove labels from titles.
        $grouping_field = $this->options['grouping'];
        if ($this->view->field[$grouping_field]->options['label']) {
          $title = str_replace($this->view->field[$grouping_field]->options['label'] . ': ', '', $title);
        }
        $tabs[] = array(
          'title' => $title,
          'content' => $rows,
        );
      }
      else {
        foreach ($rows as $index => $row) {
          $title = $this
            ->get_field($index, $this->options['tab_title_field']);
          $tabs[] = array(
            'title' => $title,
            'content' => $row,
          );
        }
      }
    }
    $output = theme('quicktabs_views_render', $view, $tabs, $machine_name);

    // If doing a live preview, add the JavaScript directly to the output.
    if (isset($view->live_preview) && $view->live_preview) {
      $js = drupal_add_js();
      $qtsettings = array();
      foreach ($js['setting'] as $settings) {
        if (isset($settings['quicktabs']['qt_' . $machine_name])) {
          $qtsettings = $settings['quicktabs']['qt_' . $machine_name];
          break;
        }
      }
      $output .= "<script type=\"text/javascript\">\n";
      $output .= "Drupal.settings.quicktabs = Drupal.settings.quicktabs || {};\n";
      $output .= "jQuery.extend(Drupal.settings.quicktabs, " . drupal_to_js(array(
        'qt_' . $machine_name => $qtsettings,
      )) . ");\n";
      $output .= "</script>\n";
    }
    unset($view->row_index);
    return $output;
  }

  // Because we don't provide templates, but Views may complain when visiting
  // the theme information if it can't find any. Specify the name of our theme
  // function to keep it from causing any errors.
  function theme_functions() {
    return array(
      'quicktabs_view_render',
    );
  }

}

Members

Name	Modifiers	Type	Description	Overrides
quicktabs_style_plugin::options_form		function
quicktabs_style_plugin::option_definition		function
quicktabs_style_plugin::render		function
quicktabs_style_plugin::theme_functions		function
quicktabs_style_plugin::validate		function