class ViewPreviewForm

Same name in other branches
  1. 9 core/modules/views_ui/src/ViewPreviewForm.php \Drupal\views_ui\ViewPreviewForm
  2. 8.9.x core/modules/views_ui/src/ViewPreviewForm.php \Drupal\views_ui\ViewPreviewForm
  3. 11.x core/modules/views_ui/src/ViewPreviewForm.php \Drupal\views_ui\ViewPreviewForm

Form controller for the Views preview form.

@internal

Hierarchy

Expanded class hierarchy of ViewPreviewForm

File

core/modules/views_ui/src/ViewPreviewForm.php, line 14

Namespace

Drupal\views_ui
View source 
class ViewPreviewForm extends ViewFormBase implements WorkspaceSafeFormInterface {
    
    /**
     * {@inheritdoc}
     */
    public function form(array $form, FormStateInterface $form_state) {
        $view = $this->entity;
        $form['#prefix'] = '<div id="views-preview-wrapper" class="views-preview-wrapper views-admin clearfix">';
        $form['#suffix'] = '</div>';
        $form['#id'] = 'views-ui-preview-form';
        $form_state->disableCache();
        $form['controls']['#attributes'] = [
            'class' => [
                'clearfix',
            ],
        ];
        $form['controls']['title'] = [
            '#prefix' => '<h2 class="view-preview-form__title">',
            '#markup' => $this->t('Preview'),
            '#suffix' => '</h2>',
        ];
        // Add a checkbox controlling whether or not this display auto-previews.
        $form['controls']['live_preview'] = [
            '#type' => 'checkbox',
            '#id' => 'edit-displays-live-preview',
            '#title' => $this->t('Auto preview'),
            '#default_value' => \Drupal::config('views.settings')->get('ui.always_live_preview'),
        ];
        // Add the arguments textfield.
        $form['controls']['view_args'] = [
            '#type' => 'textfield',
            '#title' => $this->t('Preview with contextual filters:'),
            '#description' => $this->t('Separate contextual filter values with a "/". For example, %example.', [
                '%example' => '40/12/10',
            ]),
            '#id' => 'preview-args',
        ];
        $args = [];
        if ($form_state->getValue('view_args', '') !== '') {
            $args = explode('/', $form_state->getValue('view_args'));
        }
        $user_input = $form_state->getUserInput();
        if ($form_state->get('show_preview') || !empty($user_input['js'])) {
            $form['preview'] = [
                '#weight' => 110,
                '#theme_wrappers' => [
                    'container',
                ],
                '#attributes' => [
                    'id' => 'views-live-preview',
                    'class' => [
                        'views-live-preview',
                    ],
                ],
                'preview' => $view->renderPreview($this->displayID, $args),
            ];
        }
        $uri = $view->toUrl('preview-form');
        $uri->setRouteParameter('display_id', $this->displayID);
        $form['#action'] = $uri->toString();
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function actions(array $form, FormStateInterface $form_state) {
        $view = $this->entity;
        return [
            '#attributes' => [
                'id' => 'preview-submit-wrapper',
                'class' => [
                    'preview-submit-wrapper',
                ],
            ],
            'button' => [
                '#type' => 'submit',
                '#value' => $this->t('Update preview'),
                '#attributes' => [
                    'class' => [
                        'arguments-preview',
                    ],
                ],
                '#submit' => [
                    '::submitPreview',
                ],
                '#id' => 'preview-submit',
                '#ajax' => [
                    'url' => Url::fromRoute('entity.view.preview_form', [
                        'view' => $view->id(),
                        'display_id' => $this->displayID,
                    ]),
                    'wrapper' => 'views-preview-wrapper',
                    'event' => 'click',
                    'progress' => [
                        'type' => 'fullscreen',
                    ],
                    'method' => 'replaceWith',
                    'disable-refocus' => TRUE,
                ],
            ],
        ];
    }
    
    /**
     * Form submission handler for the Preview button.
     */
    public function submitPreview($form, FormStateInterface $form_state) {
        $form_state->set('show_preview', TRUE);
        $form_state->setRebuild();
    }

}

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
EntityForm::$entity protected property The entity being used by this form. 11
EntityForm::$entityTypeManager protected property The entity type manager. 3
EntityForm::$moduleHandler protected property The module handler service. 2
EntityForm::$operation protected property The name of the current operation.
EntityForm::actionsElement protected function Returns the action form element for the current entity form.
EntityForm::afterBuild public function Form element #after_build callback: Updates the entity with submitted data. 1
EntityForm::buildEntity public function Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface::buildEntity 5
EntityForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties. 11
EntityForm::getBaseFormId public function Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId 4
EntityForm::getEntity public function Gets the form entity. Overrides EntityFormInterface::getEntity
EntityForm::getEntityFromRouteMatch public function Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface::getEntityFromRouteMatch 3
EntityForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId 13
EntityForm::getOperation public function Gets the operation identifying the form. Overrides EntityFormInterface::getOperation
EntityForm::prepareInvokeAll protected function Invokes the specified prepare hook variant.
EntityForm::processForm public function Process callback: assigns weights and hides extra fields.
EntityForm::save public function Form submission handler for the &#039;save&#039; action. Overrides EntityFormInterface::save 47
EntityForm::setEntity public function Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::setEntityTypeManager public function Sets the entity type manager for this form. Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler public function Sets the module handler for this form. Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation public function Sets the operation for this form. Overrides EntityFormInterface::setOperation
EntityForm::submitForm public function This is the default entity object builder function. It is called before any
other submit handler to build the new entity object to be used by the
following submit handlers. At this point of the form workflow the entity is
validated and the form state… 		Overrides FormInterface::submitForm 20
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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 57
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. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
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.
ViewFormBase::$displayID protected property The name of the display used by the form.
ViewFormBase::buildForm public function Form constructor. Overrides EntityForm::buildForm
ViewFormBase::getDisplayLabel public function Placeholder function for overriding $display[&#039;display_title&#039;].
ViewFormBase::getDisplayTabs public function Adds tabs for navigating across Displays when editing a View.
ViewFormBase::init public function Initialize the form state and the entity before the first form build. Overrides EntityForm::init
ViewFormBase::isDefaultDisplayShown public function Controls whether or not the default display should have its own tab on edit.
ViewFormBase::prepareEntity protected function Prepares the entity object before the form is built first. Overrides EntityForm::prepareEntity 2
ViewPreviewForm::actions protected function Returns an array of supported actions for the current entity form. Overrides EntityForm::actions
ViewPreviewForm::form public function Gets the actual form array to be built. Overrides EntityForm::form
ViewPreviewForm::submitPreview public function Form submission handler for the Preview button.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.