class Rearrange

Provides a rearrange form for Views handlers.

Hierarchy

Expanded class hierarchy of Rearrange

1 string reference to 'Rearrange'
ViewEditFormController::getFormBucket in drupal/core/modules/views_ui/lib/Drupal/views_ui/ViewEditFormController.php
Add information about a section to a display.

File

drupal/core/modules/views_ui/lib/Drupal/views_ui/Form/Ajax/Rearrange.php, line 16
Contains \Drupal\views_ui\Form\Ajax\Rearrange.

Namespace

Drupal\views_ui\Form\Ajax
View source
class Rearrange extends ViewsFormBase {

  /**
   * Constucts a new Rearrange object.
   */
  public function __construct($type = NULL) {
    $this
      ->setType($type);
  }

  /**
   * Implements \Drupal\views_ui\Form\Ajax\ViewsFormInterface::getFormKey().
   */
  public function getFormKey() {
    return 'rearrange';
  }

  /**
   * Overrides \Drupal\views_ui\Form\Ajax\ViewsFormBase::getForm().
   */
  public function getForm(ViewStorageInterface $view, $display_id, $js, $type = NULL) {
    $this
      ->setType($type);
    return parent::getForm($view, $display_id, $js);
  }

  /**
   * Implements \Drupal\Core\Form\FormInterface::getFormID().
   */
  public function getFormID() {
    return 'views_ui_rearrange_form';
  }

  /**
   * Implements \Drupal\Core\Form\FormInterface::buildForm().
   */
  public function buildForm(array $form, array &$form_state) {
    $view =& $form_state['view'];
    $display_id = $form_state['display_id'];
    $type = $form_state['type'];
    $types = ViewExecutable::viewsHandlerTypes();
    $executable = $view
      ->get('executable');
    if (!$executable
      ->setDisplay($display_id)) {
      views_ajax_error(t('Invalid display id @display', array(
        '@display' => $display_id,
      )));
    }
    $display =& $executable->displayHandlers
      ->get($display_id);
    $form['#title'] = t('Rearrange @type', array(
      '@type' => $types[$type]['ltitle'],
    ));
    $form['#section'] = $display_id . 'rearrange-item';
    if ($display
      ->defaultableSections($types[$type]['plural'])) {
      $form_state['section'] = $types[$type]['plural'];
      views_ui_standard_display_dropdown($form, $form_state, $form_state['section']);
    }
    $count = 0;

    // Get relationship labels
    $relationships = array();
    foreach ($display
      ->getHandlers('relationship') as $id => $handler) {
      $relationships[$id] = $handler
        ->adminLabel();
    }
    $form['fields'] = array(
      '#type' => 'table',
      '#header' => array(
        '',
        t('Weight'),
        t('Remove'),
      ),
      '#empty' => t('No fields available.'),
      '#tabledrag' => array(
        array(
          'order',
          'sibling',
          'weight',
        ),
      ),
      '#tree' => TRUE,
      '#prefix' => '<div class="scroll">',
      '#suffix' => '</div>',
    );
    foreach ($display
      ->getOption($types[$type]['plural']) as $id => $field) {
      $form['fields'][$id] = array();
      $form['fields'][$id]['#attributes'] = array(
        'class' => array(
          '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;
        }
        $form['fields'][$id]['name'] = array(
          '#markup' => $name,
        );
      }
      else {
        $form['fields'][$id]['name'] = array(
          '#markup' => t('Broken field @id', array(
            '@id' => $id,
          )),
        );
      }
      $form['fields'][$id]['weight'] = array(
        '#type' => 'textfield',
        '#default_value' => ++$count,
        '#attributes' => array(
          'class' => array(
            'weight',
          ),
        ),
      );
      $form['fields'][$id]['removed'] = array(
        '#type' => 'checkbox',
        '#id' => 'views-removed-' . $id,
        '#attributes' => array(
          'class' => array(
            'views-remove-checkbox',
          ),
        ),
        '#default_value' => 0,
        '#suffix' => l('<span>' . t('Remove') . '</span>', 'javascript:void()', array(
          'attributes' => array(
            'id' => 'views-remove-link-' . $id,
            'class' => array(
              'views-hidden',
              'views-button-remove',
              'views-remove-link',
            ),
            'alt' => t('Remove this item'),
            'title' => t('Remove this item'),
          ),
          'html' => TRUE,
        )),
      );
    }
    $name = NULL;
    if (isset($form_state['update_name'])) {
      $name = $form_state['update_name'];
    }
    $view
      ->getStandardButtons($form, $form_state, 'views_ui_rearrange_form');
    return $form;
  }

  /**
   * Overrides \Drupal\views_ui\Form\Ajax\ViewsFormBase::submitForm().
   */
  public function submitForm(array &$form, array &$form_state) {
    $types = ViewExecutable::viewsHandlerTypes();
    $display =& $form_state['view']
      ->get('executable')->displayHandlers
      ->get($form_state['display_id']);
    $old_fields = $display
      ->getOption($types[$form_state['type']]['plural']);
    $new_fields = $order = array();

    // Make an array with the weights
    foreach ($form_state['values']['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[$form_state['type']]['plural'], $new_fields);

    // Store in cache
    $form_state['view']
      ->cacheSet();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Rearrange::buildForm public function Implements \Drupal\Core\Form\FormInterface::buildForm(). Overrides FormInterface::buildForm
Rearrange::getForm public function Overrides \Drupal\views_ui\Form\Ajax\ViewsFormBase::getForm(). Overrides ViewsFormBase::getForm
Rearrange::getFormID public function Implements \Drupal\Core\Form\FormInterface::getFormID(). Overrides FormInterface::getFormID
Rearrange::getFormKey public function Implements \Drupal\views_ui\Form\Ajax\ViewsFormInterface::getFormKey(). Overrides ViewsFormInterface::getFormKey
Rearrange::submitForm public function Overrides \Drupal\views_ui\Form\Ajax\ViewsFormBase::submitForm(). Overrides ViewsFormBase::submitForm
Rearrange::__construct public function Constucts a new Rearrange object.
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::getFormState public function Implements \Drupal\views_ui\Form\Ajax\ViewsFormInterface::getFormState(). 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 Implements \Drupal\Core\Form\FormInterface::validateForm(). Overrides FormInterface::validateForm 3