class Rearrange

Same name in other branches
  1. 8.9.x core/modules/views_ui/src/Form/Ajax/Rearrange.php \Drupal\views_ui\Form\Ajax\Rearrange
  2. 10 core/modules/views_ui/src/Form/Ajax/Rearrange.php \Drupal\views_ui\Form\Ajax\Rearrange
  3. 11.x core/modules/views_ui/src/Form/Ajax/Rearrange.php \Drupal\views_ui\Form\Ajax\Rearrange

Provides a rearrange form for Views handlers.

@internal

Hierarchy

Expanded class hierarchy of Rearrange

1 string reference to 'Rearrange'
Rearrange::getFormKey in core/modules/views_ui/src/Form/Ajax/Rearrange.php
Returns the key that represents this form.

File

core/modules/views_ui/src/Form/Ajax/Rearrange.php, line 17

Namespace

Drupal\views_ui\Form\Ajax
View source 
class Rearrange extends ViewsFormBase {
    
    /**
     * Constructs a new Rearrange object.
     */
    public function __construct($type = NULL) {
        $this->setType($type);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormKey() {
        return 'rearrange';
    }
    
    /**
     * {@inheritdoc}
     */
    public function getForm(ViewEntityInterface $view, $display_id, $js, $type = NULL) {
        $this->setType($type);
        return parent::getForm($view, $display_id, $js);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'views_ui_rearrange_form';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $view = $form_state->get('view');
        $display_id = $form_state->get('display_id');
        $type = $form_state->get('type');
        $types = ViewExecutable::getHandlerTypes();
        $executable = $view->getExecutable();
        if (!$executable->setDisplay($display_id)) {
            $form['markup'] = [
                '#markup' => $this->t('Invalid display id @display', [
                    '@display' => $display_id,
                ]),
            ];
            return $form;
        }
        $display =& $executable->displayHandlers
            ->get($display_id);
        $form['#title'] = $this->t('Rearrange @type', [
            '@type' => $types[$type]['ltitle'],
        ]);
        $form['#section'] = $display_id . 'rearrange-item';
        if ($display->defaultableSections($types[$type]['plural'])) {
            $section = $types[$type]['plural'];
            $form_state->set('section', $section);
            views_ui_standard_display_dropdown($form, $form_state, $section);
        }
        $count = 0;
        // Get relationship labels
        $relationships = [];
        foreach ($display->getHandlers('relationship') as $id => $handler) {
            $relationships[$id] = $handler->adminLabel();
        }
        $form['fields'] = [
            '#type' => 'table',
            '#header' => [
                '',
                $this->t('Weight'),
                $this->t('Remove'),
            ],
            '#empty' => $this->t('No fields available.'),
            '#tabledrag' => [
                [
                    'action' => 'order',
                    'relationship' => 'sibling',
                    'group' => 'weight',
                ],
            ],
            '#tree' => TRUE,
            '#prefix' => '<div class="scroll" data-drupal-views-scroll>',
            '#suffix' => '</div>',
        ];
        foreach ($display->getOption($types[$type]['plural']) as $id => $field) {
            $form['fields'][$id] = [];
            $form['fields'][$id]['#attributes'] = [
                'class' => [
                    'draggable',
                ],
                'id' => 'views-row-' . $id,
            ];
            $handler = $display->getHandler($type, $id);
            if ($handler) {
                $name = $handler->adminLabel() . ' ' . $handler->adminSummary();
                if (!empty($field['relationship']) && !empty($relationships[$field['relationship']])) {
                    $name = '(' . $relationships[$field['relationship']] . ') ' . $name;
                }
                $markup = $name;
            }
            else {
                $name = $id;
                $markup = $this->t('Broken field @id', [
                    '@id' => $id,
                ]);
            }
            $form['fields'][$id]['name'] = [
                '#markup' => $markup,
            ];
            $form['fields'][$id]['weight'] = [
                '#type' => 'textfield',
                '#default_value' => ++$count,
                '#attributes' => [
                    'class' => [
                        'weight',
                    ],
                ],
                '#title' => $this->t('Weight for @title', [
                    '@title' => $name,
                ]),
                '#title_display' => 'invisible',
            ];
            $form['fields'][$id]['removed'] = [
                '#type' => 'checkbox',
                '#title' => $this->t('Remove @title', [
                    '@title' => $name,
                ]),
                '#title_display' => 'invisible',
                '#id' => 'views-removed-' . $id,
                '#attributes' => [
                    'class' => [
                        'views-remove-checkbox',
                    ],
                ],
                '#default_value' => 0,
                '#suffix' => Link::fromTextAndUrl(new FormattableMarkup('<span>@text</span>', [
                    '@text' => $this->t('Remove'),
                ]), Url::fromRoute('<none>', [], [
                    'attributes' => [
                        'id' => 'views-remove-link-' . $id,
                        'class' => [
                            'views-hidden',
                            'views-button-remove',
                            'views-remove-link',
                        ],
                        'alt' => $this->t('Remove this item'),
                        'title' => $this->t('Remove this item'),
                    ],
                ]))
                    ->toString(),
            ];
        }
        $view->getStandardButtons($form, $form_state, 'views_ui_rearrange_form');
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $view = $form_state->get('view');
        $display_id = $form_state->get('display_id');
        $type = $form_state->get('type');
        $types = ViewExecutable::getHandlerTypes();
        $display =& $view->getExecutable()->displayHandlers
            ->get($display_id);
        $old_fields = $display->getOption($types[$type]['plural']);
        $new_fields = $order = [];
        // Make an array with the weights
        foreach ($form_state->getValue('fields') as $field => $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'])) {
                $order[$field] = $info['weight'];
            }
        }
        // Sort the array
        asort($order);
        // Create a new list of fields in the new order.
        foreach (array_keys($order) as $field) {
            $new_fields[$field] = $old_fields[$field];
        }
        $display->setOption($types[$type]['plural'], $new_fields);
        // Store in cache
        $view->cacheSet();
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 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 105
FormBase::currentUser protected function Gets the current user.
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. 17
MessengerTrait::messenger public function Gets the messenger. 17
MessengerTrait::setMessenger public function Sets the messenger.
Rearrange::buildForm public function Form constructor. Overrides FormInterface::buildForm
Rearrange::getForm public function Creates a new instance of this form. Overrides ViewsFormBase::getForm
Rearrange::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
Rearrange::getFormKey public function Returns the key that represents this form. Overrides ViewsFormInterface::getFormKey
Rearrange::submitForm public function Form submission handler. Overrides ViewsFormBase::submitForm
Rearrange::__construct public function Constructs a new Rearrange object.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a &#039;destination&#039; 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.
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::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.