ViewsFormBase.php 8.78 KB
Newer Older
1 2 3 4 5 6 7 8 9
<?php

/**
 * @file
 * Contains \Drupal\views_ui\Form\Ajax\ViewsFormBase.
 */

namespace Drupal\views_ui\Form\Ajax;

10
use Drupal\Component\Utility\Html;
11
use Drupal\Core\Ajax\OpenModalDialogCommand;
12
use Drupal\Core\Form\FormBase;
13 14
use Drupal\Core\Form\FormState;
use Drupal\Core\Form\FormStateInterface;
15 16
use Drupal\views_ui\ViewUI;
use Drupal\views\ViewEntityInterface;
17 18
use Drupal\views\Ajax;
use Drupal\Core\Ajax\AjaxResponse;
19
use Drupal\Core\Ajax\CloseModalDialogCommand;
20 21 22 23 24
use Symfony\Component\HttpFoundation\RedirectResponse;

/**
 * Provides a base class for Views UI AJAX forms.
 */
25
abstract class ViewsFormBase extends FormBase implements ViewsFormInterface {
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65

  /**
   * The ID of the item this form is manipulating.
   *
   * @var string
   */
  protected $id;

  /**
   * The type of item this form is manipulating.
   *
   * @var string
   */
  protected $type;

  /**
   * Sets the ID for this form.
   *
   * @param string $id
   *   The ID of the item this form is manipulating.
   */
  protected function setID($id) {
    if ($id) {
      $this->id = $id;
    }
  }

  /**
   * Sets the type for this form.
   *
   * @param string $type
   *   The type of the item this form is manipulating.
   */
  protected function setType($type) {
    if ($type) {
      $this->type = $type;
    }
  }

  /**
66
   * {@inheritdoc}
67
   */
68
  public function getFormState(ViewEntityInterface $view, $display_id, $js) {
69 70
    // $js may already have been converted to a Boolean.
    $ajax = is_string($js) ? $js === 'ajax' : $js;
71 72 73 74 75 76 77 78 79 80
    return (new FormState())
      ->set('form_id', $this->getFormId())
      ->set('form_key', $this->getFormKey())
      ->set('ajax', $ajax)
      ->set('display_id', $display_id)
      ->set('view', $view)
      ->set('type', $this->type)
      ->set('id', $this->id)
      ->disableRedirect()
      ->addBuildInfo('callback_object', $this);
81 82 83
  }

  /**
84
   * {@inheritdoc}
85
   */
86
  public function getForm(ViewEntityInterface $view, $display_id, $js) {
87
    $form_state = $this->getFormState($view, $display_id, $js);
88 89
    $view = $form_state->get('view');
    $key = $form_state->get('form_key');
90 91

    // @todo Remove the need for this.
92
    \Drupal::moduleHandler()->loadInclude('views_ui', 'inc', 'admin');
93 94 95 96

    // Reset the cache of IDs. Drupal rather aggressively prevents ID
    // duplication but this causes it to remember IDs that are no longer even
    // being used.
97
    Html::resetSeenIds();
98 99 100 101 102

    // check to see if this is the top form of the stack. If it is, pop
    // it off; if it isn't, the user clicked somewhere else and the stack is
    // now irrelevant.
    if (!empty($view->stack)) {
103
      $identifier = implode('-', array_filter([$key, $view->id(), $display_id, $form_state->get('type'), $form_state->get('id')]));
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
      // Retrieve the first form from the stack without changing the integer keys,
      // as they're being used for the "2 of 3" progress indicator.
      reset($view->stack);
      list($key, $top) = each($view->stack);
      unset($view->stack[$key]);

      if (array_shift($top) != $identifier) {
        $view->stack = array();
      }
    }

    // Automatically remove the form cache if it is set and the key does
    // not match. This way navigating away from the form without hitting
    // update will work.
    if (isset($view->form_cache) && $view->form_cache['key'] != $key) {
      unset($view->form_cache);
    }

    // With the below logic, we may end up rendering a form twice (or two forms
    // each sharing the same element ids), potentially resulting in
124
    // _drupal_add_js() being called twice to add the same setting. drupal_get_js()
125 126 127
    // is ok with that, but until \Drupal\Core\Ajax\AjaxResponse::ajaxRender()
    // is (http://drupal.org/node/208611), reset the _drupal_add_js() static
    // before rendering the second time.
128 129
    $drupal_add_js_original = _drupal_add_js();
    $drupal_add_js = &drupal_static('_drupal_add_js');
130
    $form_class = get_class($form_state->getFormObject());
131
    $response = $this->ajaxFormWrapper($form_class, $form_state);
132 133

    // If the form has not been submitted, or was not set for rerendering, stop.
134
    if (!$form_state->isSubmitted() || $form_state->get('rerender')) {
135 136 137 138 139 140 141 142 143 144 145
      return $response;
    }

    // Sometimes we need to re-generate the form for multi-step type operations.
    if (!empty($view->stack)) {
      $drupal_add_js = $drupal_add_js_original;
      $stack = $view->stack;
      $top = array_shift($stack);

      // Build the new form state for the next form in the stack.
      $reflection = new \ReflectionClass($view::$forms[$top[1]]);
146
      /** @var $form_state \Drupal\Core\Form\FormStateInterface */
147 148
      $form_state = $reflection->newInstanceArgs(array_slice($top, 3, 2))->getFormState($view, $top[2], $form_state->get('ajax'));
      $form_class = get_class($form_state->getFormObject());
149

150
      $form_state->setUserInput(array());
151
      $form_url = views_ui_build_form_url($form_state);
152
      if (!$form_state->get('ajax')) {
153
        return new RedirectResponse($form_url->setAbsolute()->toString());
154
      }
155
      $form_state->set('url', $form_url);
156
      $response = $this->ajaxFormWrapper($form_class, $form_state);
157
    }
158
    elseif (!$form_state->get('ajax')) {
159
      // if nothing on the stack, non-js forms just go back to the main view editor.
160
      $display_id = $form_state->get('display_id');
161
      return new RedirectResponse($this->url('entity.view.edit_display_form', ['view' => $view->id(), 'display_id' => $display_id], ['absolute' => TRUE]));
162 163 164
    }
    else {
      $response = new AjaxResponse();
165
      $response->addCommand(new CloseModalDialogCommand());
166
      $response->addCommand(new Ajax\ShowButtonsCommand(!empty($view->changed)));
167
      $response->addCommand(new Ajax\TriggerPreviewCommand());
168
      if ($page_title = $form_state->get('page_title')) {
169
        $response->addCommand(new Ajax\ReplaceTitleCommand($page_title));
170 171 172 173 174
      }
    }
    // If this form was for view-wide changes, there's no need to regenerate
    // the display section of the form.
    if ($display_id !== '') {
175
      \Drupal::entityManager()->getFormObject('view', 'edit')->rebuildCurrentTab($view, $response, $display_id);
176 177 178 179 180
    }

    return $response;
  }

181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
  /**
   * Wrapper for handling AJAX forms.
   *
   * Wrapper around \Drupal\Core\Form\FormBuilderInterface::buildForm() to
   * handle some AJAX stuff automatically.
   * This makes some assumptions about the client.
   *
   * @param \Drupal\Core\Form\FormInterface|string $form_class
   *   The value must be one of the following:
   *   - The name of a class that implements \Drupal\Core\Form\FormInterface.
   *   - An instance of a class that implements \Drupal\Core\Form\FormInterface.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return \Drupal\Core\Ajax\AjaxResponse|string|array
   *   Returns one of three possible values:
   *   - A \Drupal\Core\Ajax\AjaxResponse object.
   *   - The rendered form, as a string.
   *   - A render array with the title in #title and the rendered form in the
   *   #markup array.
   */
  protected function ajaxFormWrapper($form_class, FormStateInterface &$form_state) {
    // This won't override settings already in.
    if (!$form_state->has('rerender')) {
      $form_state->set('rerender', FALSE);
    }
    $ajax = $form_state->get('ajax');
    // Do not overwrite if the redirect has been disabled.
    if (!$form_state->isRedirectDisabled()) {
      $form_state->disableRedirect($ajax);
    }
    $form_state->disableCache();

    $form = \Drupal::formBuilder()->buildForm($form_class, $form_state);
    $output = drupal_render($form);
    drupal_process_attached($form);

    // These forms have the title built in, so set the title here:
    $title = $form_state->get('title') ?: '';

    if ($ajax && (!$form_state->isExecuted() || $form_state->get('rerender'))) {
      // If the form didn't execute and we're using ajax, build up an
      // Ajax command list to execute.
      $response = new AjaxResponse();

      $display = '';
      $status_messages = array('#theme' => 'status_messages');
      if ($messages = drupal_render($status_messages)) {
        $display = '<div class="views-messages">' . $messages . '</div>';
      }
      $display .= $output;

      $options = array(
        'dialogClass' => 'views-ui-dialog',
        'width' => '50%',
      );

      $response->addCommand(new OpenModalDialogCommand($title, $display, $options));

      if ($section = $form_state->get('#section')) {
        $response->addCommand(new Ajax\HighlightCommand('.' . Html::cleanCssIdentifier($section)));
      }

      return $response;
    }

    return $title ? ['#title' => $title, '#markup' => $output] : $output;
  }

250
  /**
251
   * {@inheritdoc}
252
   */
253
  public function validateForm(array &$form, FormStateInterface $form_state) {
254 255 256
  }

  /**
257
   * {@inheritdoc}
258
   */
259
  public function submitForm(array &$form, FormStateInterface $form_state) {
260 261 262
  }

}