public function ViewFormControllerBase::getDisplayTabs

Adds tabs for navigating across Displays when editing a View.

This function can be called from hook_menu_local_tasks_alter() to implement these tabs as secondary local tasks, or it can be called from elsewhere if having them as secondary local tasks isn't desired. The caller is responsible for setting the active tab's #active property to TRUE.

Parameters

$display_id: The display_id which is edited on the current request.

File

drupal/core/modules/views/views_ui/lib/Drupal/views_ui/ViewFormControllerBase.php, line 82

Contains Drupal\views_ui\ViewFormControllerBase.

Class

ViewFormControllerBase

Base form controller for Views forms.

Namespace

Code

public function getDisplayTabs(ViewUI $view) {
  $display_id = $view->displayID;
  $tabs = array();

  // Create a tab for each display.
  $displays = $view
    ->get('display');
  uasort($displays, array(
    $view,
    'sortPosition',
  ));
  $view
    ->set('display', $displays);
  foreach ($displays as $id => $display) {
    $tabs[$id] = array(
      '#theme' => 'menu_local_task',
      '#link' => array(
        'title' => $this
          ->getDisplayLabel($view, $id),
        'href' => 'admin/structure/views/view/' . $view
          ->get('name') . '/edit/' . $id,
        'localized_options' => array(),
      ),
    );
    if (!empty($display['deleted'])) {
      $tabs[$id]['#link']['localized_options']['attributes']['class'][] = 'views-display-deleted-link';
    }
    if (isset($display['display_options']['enabled']) && !$display['display_options']['enabled']) {
      $tabs[$id]['#link']['localized_options']['attributes']['class'][] = 'views-display-disabled-link';
    }
  }

  // If the default display isn't supposed to be shown, don't display its tab, unless it's the only display.
  if (!$this
    ->isDefaultDisplayShown($view) && $display_id != 'default' && count($tabs) > 1) {
    $tabs['default']['#access'] = FALSE;
  }

  // Mark the display tab as red to show validation errors.
  $view
    ->get('executable')
    ->validate();
  foreach ($view
    ->get('display') as $id => $display) {
    if (!empty($view->display_errors[$id])) {

      // Always show the tab.
      $tabs[$id]['#access'] = TRUE;

      // Add a class to mark the error and a title to make a hover tip.
      $tabs[$id]['#link']['localized_options']['attributes']['class'][] = 'error';
      $tabs[$id]['#link']['localized_options']['attributes']['title'] = t('This display has one or more validation errors; please review it.');
    }
  }
  return $tabs;
}