class ReorderDisplays
Displays the display reorder form.
@internal
Hierarchy
- class \Drupal\Core\Form\FormBase implements \Drupal\Core\Form\FormInterface, \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait
- class \Drupal\views_ui\Form\Ajax\ViewsFormBase implements \Drupal\views_ui\Form\Ajax\ViewsFormInterface extends \Drupal\Core\Form\FormBase
- class \Drupal\views_ui\Form\Ajax\ReorderDisplays extends \Drupal\views_ui\Form\Ajax\ViewsFormBase
 
 
 - class \Drupal\views_ui\Form\Ajax\ViewsFormBase implements \Drupal\views_ui\Form\Ajax\ViewsFormInterface extends \Drupal\Core\Form\FormBase
 
Expanded class hierarchy of ReorderDisplays
File
- 
              core/
modules/ views_ui/ src/ Form/ Ajax/ ReorderDisplays.php, line 14  
Namespace
Drupal\views_ui\Form\AjaxView source
class ReorderDisplays extends ViewsFormBase {
  
  /**
   * {@inheritdoc}
   */
  public function getFormKey() {
    return 'reorder-displays';
  }
  
  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'views_ui_reorder_displays_form';
  }
  
  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    /** @var \Drupal\views\ViewEntityInterface $view */
    $view = $form_state->get('view');
    $display_id = $form_state->get('display_id');
    $form['#title'] = $this->t('Reorder displays');
    $form['#section'] = 'reorder';
    $form['#action'] = Url::fromRoute('views_ui.form_reorder_displays', [
      'js' => 'nojs',
      'view' => $view->id(),
      'display_id' => $display_id,
    ])
      ->toString();
    $form['view'] = [
      '#type' => 'value',
      '#value' => $view,
    ];
    $displays = $view->get('display');
    $count = count($displays);
    // Sort the displays.
    uasort($displays, function ($display1, $display2) {
      return $display1['position'] <=> $display2['position'];
    });
    $form['displays'] = [
      '#type' => 'table',
      '#id' => 'reorder-displays',
      '#header' => [
        $this->t('Display'),
        $this->t('Weight'),
        $this->t('Remove'),
      ],
      '#empty' => $this->t('No displays available.'),
      '#tabledrag' => [
        [
          'action' => 'order',
          'relationship' => 'sibling',
          'group' => 'weight',
        ],
      ],
      '#tree' => TRUE,
      '#prefix' => '<div class="scroll" data-drupal-views-scroll>',
      '#suffix' => '</div>',
    ];
    foreach ($displays as $id => $display) {
      $form['displays'][$id] = [
        '#display' => $display,
        '#attributes' => [
          'id' => 'display-row-' . $id,
        ],
        '#weight' => $display['position'],
      ];
      // Only make row draggable if it's not the default display.
      if ($id !== 'default') {
        $form['displays'][$id]['#attributes']['class'][] = 'draggable';
      }
      $form['displays'][$id]['title'] = [
        '#markup' => $display['display_title'],
      ];
      $form['displays'][$id]['weight'] = [
        '#type' => 'weight',
        '#value' => $display['position'],
        '#delta' => $count,
        '#title' => $this->t('Weight for @display', [
          '@display' => $display['display_title'],
        ]),
        '#title_display' => 'invisible',
        '#attributes' => [
          'class' => [
            'weight',
          ],
        ],
      ];
      $form['displays'][$id]['removed'] = [
        'checkbox' => [
          '#title' => $this->t('Remove @id', [
            '@id' => $id,
          ]),
          '#title_display' => 'invisible',
          '#type' => 'checkbox',
          '#id' => 'display-removed-' . $id,
          '#attributes' => [
            'class' => [
              'views-remove-checkbox',
            ],
          ],
          '#default_value' => !empty($display['deleted']),
        ],
        'link' => [
          '#type' => 'link',
          '#title' => new FormattableMarkup('<span>@text</span>', [
            '@text' => $this->t('Remove'),
          ]),
          '#url' => Url::fromRoute('<none>'),
          '#attributes' => [
            'id' => 'display-remove-link-' . $id,
            'class' => [
              'views-button-remove',
              'display-remove-link',
            ],
            'alt' => $this->t('Remove this display'),
            'title' => $this->t('Remove this display'),
          ],
        ],
        '#access' => $id !== 'default',
      ];
      if (!empty($display['deleted'])) {
        $form['displays'][$id]['deleted'] = [
          '#type' => 'value',
          '#value' => TRUE,
        ];
        $form['displays'][$id]['#attributes']['class'][] = 'hidden';
      }
    }
    $view->getStandardButtons($form, $form_state, 'views_ui_reorder_displays_form');
    return $form;
  }
  
  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    /** @var \Drupal\views_ui\ViewUI $view */
    $view = $form_state->get('view');
    $order = [];
    $user_input = $form_state->getUserInput();
    foreach ($user_input['displays'] as $display => $info) {
      // Add each value that is a field with a weight to our list, but only if
      // it has had its 'removed' checkbox checked.
      if (is_array($info) && isset($info['weight']) && empty($info['removed']['checkbox'])) {
        $order[$display] = $info['weight'];
      }
    }
    // Sort the order array.
    asort($order);
    // Remove the default display from ordering.
    unset($order['default']);
    // Increment up positions.
    $position = 1;
    foreach (array_keys($order) as $display) {
      $order[$display] = $position++;
    }
    // Setting up position and removing deleted displays.
    $displays = $view->get('display');
    foreach ($displays as $display_id => &$display) {
      // Don't touch the default.
      if ($display_id === 'default') {
        $display['position'] = 0;
        continue;
      }
      if (isset($order[$display_id])) {
        $display['position'] = $order[$display_id];
      }
      else {
        $display['deleted'] = TRUE;
      }
    }
    $view->set('display', $displays);
    // Store in cache.
    $view->cacheSet();
    $url = $view->toUrl('edit-form')
      ->setOption('fragment', 'views-tab-default');
    $form_state->setRedirectUrl($url);
  }
}
Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides | 
|---|---|---|---|---|---|
| DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | ||
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | ||
| DependencySerializationTrait::__sleep | public | function | 2 | ||
| DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | 2 | |
| FormBase::$configFactory | protected | property | The config factory. | 3 | |
| FormBase::$requestStack | protected | property | The request stack. | 1 | |
| FormBase::$routeMatch | protected | property | The route match. | ||
| FormBase::config | protected | function | Retrieves a configuration object. | ||
| FormBase::configFactory | protected | function | Gets the config factory for this form. | 3 | |
| FormBase::container | private | function | Returns the service container. | ||
| FormBase::create | public static | function | Instantiates a new instance of this class. | Overrides ContainerInjectionInterface::create | 111 | 
| FormBase::currentUser | protected | function | Gets the current user. | 2 | |
| FormBase::getRequest | protected | function | Gets the request object. | ||
| FormBase::getRouteMatch | protected | function | Gets the route match. | ||
| FormBase::logger | protected | function | Gets the logger for a specific channel. | ||
| FormBase::redirect | protected | function | Returns a redirect response object for the specified route. | ||
| FormBase::resetConfigFactory | public | function | Resets the configuration factory. | ||
| FormBase::setConfigFactory | public | function | Sets the config factory for this form. | ||
| FormBase::setRequestStack | public | function | Sets the request stack object to use. | ||
| LoggerChannelTrait::$loggerFactory | protected | property | The logger channel factory service. | ||
| LoggerChannelTrait::getLogger | protected | function | Gets the logger for a specific channel. | ||
| LoggerChannelTrait::setLoggerFactory | public | function | Injects the logger channel factory. | ||
| MessengerTrait::$messenger | protected | property | The messenger. | 25 | |
| MessengerTrait::messenger | public | function | Gets the messenger. | 25 | |
| MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
| RedirectDestinationTrait::$redirectDestination | protected | property | The redirect destination service. | 2 | |
| RedirectDestinationTrait::getDestinationArray | protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | ||
| RedirectDestinationTrait::getRedirectDestination | protected | function | Returns the redirect destination service. | ||
| RedirectDestinationTrait::setRedirectDestination | public | function | Sets the redirect destination service. | ||
| ReorderDisplays::buildForm | public | function | Form constructor. | Overrides FormInterface::buildForm | |
| ReorderDisplays::getFormId | public | function | Returns a unique string identifying the form. | Overrides FormInterface::getFormId | |
| ReorderDisplays::getFormKey | public | function | Returns the key that represents this form. | Overrides ViewsFormInterface::getFormKey | |
| ReorderDisplays::submitForm | public | function | Form submission handler. | Overrides ViewsFormBase::submitForm | |
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |
| StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | ||
| StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | ||
| StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | ||
| StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | |
| StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | ||
| ViewsFormBase::$id | protected | property | The ID of the item this form is manipulating. | ||
| ViewsFormBase::$type | protected | property | The type of item this form is manipulating. | ||
| ViewsFormBase::ajaxFormWrapper | protected | function | Wrapper for handling AJAX forms. | ||
| ViewsFormBase::getForm | public | function | Creates a new instance of this form. | Overrides ViewsFormInterface::getForm | 6 | 
| ViewsFormBase::getFormState | public | function | Gets the form state for this form. | Overrides ViewsFormInterface::getFormState | 1 | 
| ViewsFormBase::setID | protected | function | Sets the ID for this form. | ||
| ViewsFormBase::setType | protected | function | Sets the type for this form. | ||
| ViewsFormBase::validateForm | public | function | Form validation handler. | Overrides FormBase::validateForm | 3 | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.