function template_preprocess_views_view_table

Prepares variables for views table templates.

Default template: views-view-table.html.twig.

Parameters

array $vars: An associative array containing:

File

drupal/core/modules/views/views.theme.inc, line 533
Preprocessors and helper functions to make theming easier.

Code

function template_preprocess_views_view_table(&$vars) {
  $view = $vars['view'];

  // We need the raw data for this grouping, which is passed in
  // as $vars['rows'].
  // However, the template also needs to use for the rendered fields.  We
  // therefore swap the raw data out to a new variable and reset $vars['rows']
  // so that it can get rebuilt.
  // Store rows so that they may be used by further preprocess functions.
  $result = $vars['result'] = $vars['rows'];
  $vars['rows'] = array();
  $vars['field_classes'] = array();
  $vars['header'] = array();
  $options = $view->style_plugin->options;
  $handler = $view->style_plugin;
  $default_row_class = isset($options['default_row_class']) ? $options['default_row_class'] : TRUE;
  $row_class_special = isset($options['row_class_special']) ? $options['row_class_special'] : TRUE;
  $fields =& $view->field;
  $columns = $handler
    ->sanitizeColumns($options['columns'], $fields);
  $active = !empty($handler->active) ? $handler->active : '';
  $order = !empty($handler->order) ? $handler->order : 'asc';

  // A boolean variable which stores whether the table has a responsive class.
  $responsive = FALSE;
  $query = tablesort_get_query_parameters();
  if (isset($view->exposed_raw_input)) {
    $query += $view->exposed_raw_input;
  }
  foreach ($columns as $field => $column) {

    // Create a second variable so we can easily find what fields we have and
    // what the CSS classes should be.
    $vars['fields'][$field] = drupal_clean_css_identifier($field);
    if ($active == $field) {
      $vars['fields'][$field] .= ' active';
    }

    // render the header labels
    if ($field == $column && empty($fields[$field]->options['exclude'])) {
      $label = check_plain(!empty($fields[$field]) ? $fields[$field]
        ->label() : '');
      if (empty($options['info'][$field]['sortable']) || !$fields[$field]
        ->clickSortable()) {
        $vars['header'][$field] = $label;
      }
      else {
        $initial = !empty($options['info'][$field]['default_sort_order']) ? $options['info'][$field]['default_sort_order'] : 'asc';
        if ($active == $field) {
          $initial = $order == 'asc' ? 'desc' : 'asc';
        }
        $title = t('sort by @s', array(
          '@s' => $label,
        ));
        if ($active == $field) {
          $tablesort_indicator = array(
            '#theme' => 'tablesort_indicator',
            '#style' => $initial,
          );
          $label .= drupal_render($tablesort_indicator);
        }
        $query['order'] = $field;
        $query['sort'] = $initial;
        $link_options = array(
          'html' => TRUE,
          'attributes' => array(
            'title' => $title,
          ),
          'query' => $query,
        );
        $vars['header'][$field] = l($label, current_path(), $link_options);
      }

      // Set up the header label class.
      $vars['header_classes'][$field] = array();
      if ($fields[$field]->options['element_default_classes']) {
        $vars['header_classes'][$field]['class'][] = 'views-field';
        $vars['header_classes'][$field]['class'][] = 'views-field-' . $vars['fields'][$field];
      }
      $vars['header_classes'][$field] = new Attribute($vars['header_classes'][$field]);
      $class = $fields[$field]
        ->elementLabelClasses(0);
      if ($class) {
        $vars['header_classes'][$field]['class'][] = $class;
      }

      // Add responsive header classes.
      if (!empty($options['info'][$field]['responsive'])) {
        $vars['header_classes'][$field]['class'][] = $options['info'][$field]['responsive'];
        $responsive = TRUE;
      }

      // Add a CSS align class to each field if one was set.
      if (!empty($options['info'][$field]['align'])) {
        $vars['header_classes'][$field]['class'][] = drupal_clean_css_identifier($options['info'][$field]['align']);
      }

      // Add a header label wrapper if one was selected.
      if ($vars['header'][$field]) {
        $element_label_type = $fields[$field]
          ->elementLabelType(TRUE, TRUE);
        if ($element_label_type) {
          $vars['header'][$field] = '<' . $element_label_type . '>' . $vars['header'][$field] . '</' . $element_label_type . '>';
        }
      }
    }

    // Add a CSS align class to each field if one was set.
    if (!empty($options['info'][$field]['align'])) {
      $vars['fields'][$field] .= ' ' . drupal_clean_css_identifier($options['info'][$field]['align']);
    }

    // Render each field into its appropriate column.
    foreach ($result as $num => $row) {

      // Add field classes.
      $vars['field_classes'][$field][$num] = array();
      if ($fields[$field]->options['element_default_classes']) {
        $vars['field_classes'][$field][$num]['class'][] = 'views-field';
        $vars['field_classes'][$field][$num]['class'][] = 'views-field-' . $vars['fields'][$field];
      }
      $vars['field_classes'][$field][$num] = new Attribute($vars['field_classes'][$field][$num]);
      if ($classes = $fields[$field]
        ->elementClasses($num)) {
        $vars['field_classes'][$field][$num]['class'][] = $classes;
      }

      // Add responsive header classes.
      if (!empty($options['info'][$field]['responsive'])) {
        $vars['field_classes'][$field][$num]['class'][] = $options['info'][$field]['responsive'];
      }
      if (!empty($fields[$field]) && empty($fields[$field]->options['exclude'])) {
        $field_output = $handler
          ->getField($num, $field);
        $element_type = $fields[$field]
          ->elementType(TRUE, TRUE);
        if ($element_type) {
          $field_output = '<' . $element_type . '>' . $field_output . '</' . $element_type . '>';
        }

        // Don't bother with separators and stuff if the field does not show up.
        if (empty($field_output) && !empty($vars['rows'][$num][$column])) {
          continue;
        }

        // Place the field into the column, along with an optional separator.
        if (!empty($vars['rows'][$num][$column])) {
          if (!empty($options['info'][$column]['separator'])) {
            $vars['rows'][$num][$column] .= filter_xss_admin($options['info'][$column]['separator']);
          }
        }
        else {
          $vars['rows'][$num][$column] = '';
        }
        $vars['rows'][$num][$column] .= $field_output;
      }
    }

    // Remove columns if the option is hide empty column is checked and the
    // field is not empty.
    if (!empty($options['info'][$field]['empty_column'])) {
      $empty = TRUE;
      foreach ($vars['rows'] as $num => $columns) {
        $empty &= empty($columns[$column]);
      }
      if ($empty) {
        foreach ($vars['rows'] as $num => &$column_items) {
          unset($column_items[$column]);
          unset($vars['header'][$column]);
        }
      }
    }
  }

  // Hide table header if all labels are empty.
  if (!array_filter($vars['header'])) {
    $vars['header'] = array();
  }
  $count = 0;
  $vars['row_classes'] = array();
  foreach ($vars['rows'] as $num => $row) {
    $vars['row_classes'][$num] = array();
    if ($row_class_special) {
      $vars['row_classes'][$num]['class'][] = $count++ % 2 == 0 ? 'odd' : 'even';
      if ($num === 0) {
        $vars['row_classes'][$num]['class'][] = 'views-row-first';
      }
      elseif ($num === count($vars['rows']) - 1) {
        $vars['row_classes'][$num]['class'][] = 'views-row-last';
      }
    }
    if ($row_class = $handler
      ->getRowClass($num)) {
      $vars['row_classes'][$num]['class'][] = $row_class;
    }
    $vars['row_classes'][$num] = new Attribute($vars['row_classes'][$num]);
  }
  $vars['attributes']['class'][] = 'views-table';
  $vars['attributes']['class'][] = 'views-view-table';
  if (empty($vars['rows']) && !empty($options['empty_table'])) {
    $build = $view->display_handler
      ->renderArea('empty');
    $vars['rows'][0][0] = drupal_render($build);
    $vars['row_classes'][0] = new Attribute(array(
      'class' => 'odd',
    ));

    // Calculate the amounts of rows with output.
    $vars['field_classes'][0][0] = new Attribute(array(
      'colspan' => count($vars['header']),
      'class' => 'views-empty',
    ));
  }
  if (!empty($options['sticky'])) {
    $vars['view']->element['#attached']['library'][] = array(
      'system',
      'drupal.tableheader',
    );
    $vars['attributes']['class'][] = "sticky-enabled";
  }
  $vars['attributes']['class'][] = 'cols-' . count($vars['header']);
  if (!empty($handler->options['summary'])) {
    $vars['attributes']['summary'] = $handler->options['summary'];
  }

  // If the table has headers and it should react responsively to columns hidden
  // with the classes represented by the constants RESPONSIVE_PRIORITY_MEDIUM
  // and RESPONSIVE_PRIORITY_LOW, add the tableresponsive behaviors.
  if (count($vars['header']) && $responsive) {
    $vars['view']->element['#attached']['library'][] = array(
      'system',
      'drupal.tableresponsive',
    );

    // Add 'responsive-enabled' class to the table to identify it for JS.
    // This is needed to target tables constructed by this function.
    $vars['attributes']['class'][] = 'responsive-enabled';
  }
}