class ViewPreviewFormController

Form controller for the Views preview form.

Hierarchy

Expanded class hierarchy of ViewPreviewFormController

File

drupal/core/modules/views/views_ui/lib/Drupal/views_ui/ViewPreviewFormController.php, line 15
Contains Drupal\views_ui\ViewPreviewFormController.

Namespace

Drupal\views_ui
View source
class ViewPreviewFormController extends ViewFormControllerBase {

  /**
   * Overrides Drupal\Core\Entity\EntityFormController::form().
   */
  public function form(array $form, array &$form_state, EntityInterface $view) {
    $form['#prefix'] = '<div id="views-preview-wrapper" class="views-admin clearfix">';
    $form['#suffix'] = '</div>';
    $form['#id'] = 'views-ui-preview-form';

    // 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.
    $seen_ids_init =& drupal_static('drupal_html_id:init');
    $seen_ids_init = array();
    $form_state['no_cache'] = TRUE;
    $form['controls']['#attributes'] = array(
      'class' => array(
        'clearfix',
      ),
    );

    // Add a checkbox controlling whether or not this display auto-previews.
    $form['controls']['live_preview'] = array(
      '#type' => 'checkbox',
      '#id' => 'edit-displays-live-preview',
      '#title' => t('Auto preview'),
      '#default_value' => config('views.settings')
        ->get('ui.always_live_preview'),
    );

    // Add the arguments textfield
    $form['controls']['view_args'] = array(
      '#type' => 'textfield',
      '#title' => t('Preview with contextual filters:'),
      '#description' => t('Separate contextual filter values with a "/". For example, %example.', array(
        '%example' => '40/12/10',
      )),
      '#id' => 'preview-args',
    );
    $args = array();
    if (!empty($form_state['values']['view_args'])) {
      $args = explode('/', $form_state['values']['view_args']);
    }
    if ($view->renderPreview) {
      $form['preview'] = array(
        '#weight' => 110,
        '#theme_wrappers' => array(
          'container',
        ),
        '#attributes' => array(
          'id' => 'views-live-preview',
        ),
        '#markup' => $view
          ->renderPreview($view->displayID, $args),
      );
    }
    $form['#action'] = url('admin/structure/views/view/' . $view
      ->get('name') . '/preview/' . $view->displayID);
    return $form;
  }

  /**
   * Overrides Drupal\Core\Entity\EntityFormController::actions().
   */
  protected function actions(array $form, array &$form_state) {
    $view = $this
      ->getEntity($form_state);
    return array(
      '#attributes' => array(
        'id' => 'preview-submit-wrapper',
      ),
      'button' => array(
        '#type' => 'submit',
        '#value' => t('Update preview'),
        '#attributes' => array(
          'class' => array(
            'arguments-preview',
          ),
        ),
        '#submit' => array(
          array(
            $this,
            'submitPreview',
          ),
        ),
        '#id' => 'preview-submit',
        '#ajax' => array(
          'path' => 'admin/structure/views/view/' . $view
            ->get('name') . '/preview/' . $view->displayID . '/ajax',
          'wrapper' => 'views-preview-wrapper',
          'event' => 'click',
          'progress' => array(
            'type' => 'throbber',
          ),
          'method' => 'replace',
        ),
      ),
    );
  }

  /**
   * Form submission handler for the Preview button.
   */
  public function submitPreview($form, &$form_state) {

    // Rebuild the form with a pristine $view object.
    $view = $this
      ->getEntity($form_state);
    $form_state['build_info']['args'][0] = views_ui_cache_load($view
      ->get('name'));
    $view->renderPreview = TRUE;
    $form_state['show_preview'] = TRUE;
    $form_state['rebuild'] = TRUE;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
EntityFormController::$operation protected property The name of the current operation.
EntityFormController::actionsElement protected function Returns the action form element for the current entity form. 1
EntityFormController::build public function Implements Drupal\Core\Entity\EntityFormControllerInterface::build(). Overrides EntityFormControllerInterface::build
EntityFormController::buildEntity public function Implements Drupal\Core\Entity\EntityFormControllerInterface::buildEntity(). Overrides EntityFormControllerInterface::buildEntity 1
EntityFormController::delete public function Form submission handler for the 'delete' action. 5
EntityFormController::getEntity public function Implements Drupal\Core\Entity\EntityFormControllerInterface::getEntity(). Overrides EntityFormControllerInterface::getEntity 1
EntityFormController::getFormLangcode public function Implements Drupal\Core\Entity\EntityFormControllerInterface::getFormLangcode(). Overrides EntityFormControllerInterface::getFormLangcode
EntityFormController::getOperation public function Implements Drupal\Core\Entity\EntityFormControllerInterface::getOperation(). Overrides EntityFormControllerInterface::getOperation
EntityFormController::init protected function Initialize the form state and the entity before the first form build.
EntityFormController::isDefaultFormLangcode public function Implements EntityFormControllerInterface::isDefaultFormLangcode(). Overrides EntityFormControllerInterface::isDefaultFormLangcode
EntityFormController::save public function Form submission handler for the 'save' action. 11
EntityFormController::setEntity public function Implements Drupal\Core\Entity\EntityFormControllerInterface::setEntity(). Overrides EntityFormControllerInterface::setEntity 1
EntityFormController::submit public function Implements Drupal\Core\Entity\EntityFormControllerInterface::submit(). Overrides EntityFormControllerInterface::submit 9
EntityFormController::submitEntityLanguage protected function Handle possible entity language changes.
EntityFormController::validate public function Implements Drupal\Core\Entity\EntityFormControllerInterface::validate(). Overrides EntityFormControllerInterface::validate 10
EntityFormController::__construct public function Constructs an EntityFormController object.
ViewFormControllerBase::getAdminCSS public static function Creates an array of Views admin CSS for adding or attaching.
ViewFormControllerBase::getDisplayLabel public function Placeholder function for overriding $display['display_title'].
ViewFormControllerBase::getDisplayTabs public function Adds tabs for navigating across Displays when editing a View.
ViewFormControllerBase::isDefaultDisplayShown public function Controls whether or not the default display should have its own tab on edit.
ViewFormControllerBase::prepareEntity protected function Overrides Drupal\Core\Entity\EntityFormController::prepareForm(). Overrides EntityFormController::prepareEntity 2
ViewPreviewFormController::actions protected function Overrides Drupal\Core\Entity\EntityFormController::actions(). Overrides EntityFormController::actions
ViewPreviewFormController::form public function Overrides Drupal\Core\Entity\EntityFormController::form(). Overrides EntityFormController::form
ViewPreviewFormController::submitPreview public function Form submission handler for the Preview button.