class ViewUI

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

Stores UI related temporary settings.

Hierarchy

Expanded class hierarchy of ViewUI

8 files declare their use of ViewUI
ViewsUIController.php in core/modules/views_ui/src/Controller/ViewsUIController.php
views_ui_test_theme.theme in core/modules/views_ui/tests/themes/views_ui_test_theme/views_ui_test_theme.theme
Implements Views UI alter hooks in a theme to provide test coverage.
ViewUIConverter.php in core/modules/views_ui/src/ParamConverter/ViewUIConverter.php
ViewUIObjectTest.php in core/modules/views_ui/tests/src/Unit/ViewUIObjectTest.php
WizardPluginBase.php in core/modules/views/src/Plugin/views/wizard/WizardPluginBase.php

... See full list

File

core/modules/views_ui/src/ViewUI.php, line 27

Namespace

Drupal\views_ui
View source
class ViewUI implements ViewEntityInterface {
    
    /**
     * Indicates if a view is currently being edited.
     *
     * @var bool
     */
    public $editing = FALSE;
    
    /**
     * Stores an array of displays that have been changed.
     *
     * @var array
     */
    // phpcs:ignore Drupal.NamingConventions.ValidVariableName.LowerCamelName
    public $changed_display;
    
    /**
     * How long the view takes to render in microseconds.
     *
     * @var float
     */
    // phpcs:ignore Drupal.NamingConventions.ValidVariableName.LowerCamelName
    public $render_time;
    
    /**
     * If this view is locked for editing.
     *
     * If this view is locked it will contain the result of
     * \Drupal\Core\TempStore\SharedTempStore::getMetadata().
     *
     * @var \Drupal\Core\TempStore\Lock|null
     */
    private $lock;
    
    /**
     * If this view has been changed.
     *
     * @var bool
     */
    public $changed;
    
    /**
     * Stores options temporarily while editing.
     *
     * @var array
     */
    // phpcs:ignore Drupal.NamingConventions.ValidVariableName.LowerCamelName
    public $temporary_options;
    
    /**
     * Stores a stack of UI forms to display.
     *
     * @var array
     */
    public $stack;
    
    /**
     * Is the view run in a context of the preview in the admin interface.
     *
     * @var bool
     */
    // phpcs:ignore Drupal.NamingConventions.ValidVariableName.LowerCamelName
    public $live_preview;
    public $renderPreview = FALSE;
    
    /**
     * The View storage object.
     *
     * @var \Drupal\views\ViewEntityInterface
     */
    protected $storage;
    
    /**
     * Stores a list of database queries run beside the main one from views.
     *
     * @var array
     *
     * @see \Drupal\Core\Database\Log
     */
    protected $additionalQueries;
    
    /**
     * Contains an array of form keys and their respective classes.
     *
     * @var array
     */
    public static $forms = [
        'add-handler' => '\\Drupal\\views_ui\\Form\\Ajax\\AddItem',
        'analyze' => '\\Drupal\\views_ui\\Form\\Ajax\\Analyze',
        'handler' => '\\Drupal\\views_ui\\Form\\Ajax\\ConfigHandler',
        'handler-extra' => '\\Drupal\\views_ui\\Form\\Ajax\\ConfigHandlerExtra',
        'handler-group' => '\\Drupal\\views_ui\\Form\\Ajax\\ConfigHandlerGroup',
        'display' => '\\Drupal\\views_ui\\Form\\Ajax\\Display',
        'edit-details' => '\\Drupal\\views_ui\\Form\\Ajax\\EditDetails',
        'rearrange' => '\\Drupal\\views_ui\\Form\\Ajax\\Rearrange',
        'rearrange-filter' => '\\Drupal\\views_ui\\Form\\Ajax\\RearrangeFilter',
        'reorder-displays' => '\\Drupal\\views_ui\\Form\\Ajax\\ReorderDisplays',
    ];
    
    /**
     * Whether the config is being synced through the import process.
     *
     * This is the case with create, update or delete.
     *
     * @var bool
     */
    private $isSyncing = FALSE;
    
    /**
     * Whether the config is being deleted through the uninstall process.
     *
     * @var bool
     */
    private $isUninstalling = FALSE;
    
    /**
     * The entity type.
     */
    protected string $entityType;
    
    /**
     * Constructs a View UI object.
     *
     * @param \Drupal\views\ViewEntityInterface $storage
     *   The View storage object to wrap.
     */
    public function __construct(ViewEntityInterface $storage) {
        $this->entityType = 'view';
        $this->storage = $storage;
    }
    
    /**
     * {@inheritdoc}
     */
    public function get($property_name, $langcode = NULL) {
        if (property_exists($this->storage, $property_name)) {
            return $this->storage
                ->get($property_name, $langcode);
        }
        return $this->{$property_name} ?? NULL;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setStatus($status) {
        return $this->storage
            ->setStatus($status);
    }
    
    /**
     * {@inheritdoc}
     */
    public function set($property_name, $value, $notify = TRUE) {
        if (property_exists($this->storage, $property_name)) {
            $this->storage
                ->set($property_name, $value);
        }
        else {
            $this->{$property_name} = $value;
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function setSyncing($syncing) {
        $this->isSyncing = $syncing;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setUninstalling($isUninstalling) {
        $this->isUninstalling = $isUninstalling;
    }
    
    /**
     * {@inheritdoc}
     */
    public function isSyncing() {
        return $this->isSyncing;
    }
    
    /**
     * {@inheritdoc}
     */
    public function isUninstalling() {
        return $this->isUninstalling;
    }
    
    /**
     * Basic submit handler applicable to all 'standard' forms.
     *
     * This submit handler determines whether the user wants the submitted changes
     * to apply to the default display or to the current display, and dispatches
     * control appropriately.
     */
    public function standardSubmit($form, FormStateInterface $form_state) {
        // Determine whether the values the user entered are intended to apply to
        // the current display or the default display.
        [
            $was_defaulted,
            $is_defaulted,
            $revert,
        ] = $this->getOverrideValues($form, $form_state);
        // Based on the user's choice in the display dropdown, determine which display
        // these changes apply to.
        $display_id = $form_state->get('display_id');
        if ($revert) {
            // If it's revert just change the override and return.
            $display =& $this->getExecutable()->displayHandlers
                ->get($display_id);
            $display->optionsOverride($form, $form_state);
            // Don't execute the normal submit handling but still store the changed view into cache.
            $this->cacheSet();
            return;
        }
        elseif ($was_defaulted === $is_defaulted) {
            // We're not changing which display these form values apply to.
            // Run the regular submit handler for this form.
        }
        elseif ($was_defaulted && !$is_defaulted) {
            // We were using the default display's values, but we're now overriding
            // the default display and saving values specific to this display.
            $display =& $this->getExecutable()->displayHandlers
                ->get($display_id);
            // optionsOverride toggles the override of this section.
            $display->optionsOverride($form, $form_state);
            $display->submitOptionsForm($form, $form_state);
        }
        elseif (!$was_defaulted && $is_defaulted) {
            // We used to have an override for this display, but the user now wants
            // to go back to the default display.
            // Overwrite the default display with the current form values, and make
            // the current display use the new default values.
            $display =& $this->getExecutable()->displayHandlers
                ->get($display_id);
            // optionsOverride toggles the override of this section.
            $display->optionsOverride($form, $form_state);
            $display->submitOptionsForm($form, $form_state);
        }
        $submit_handler = [
            $form_state->getFormObject(),
            'submitForm',
        ];
        call_user_func_array($submit_handler, [
            &$form,
            $form_state,
        ]);
    }
    
    /**
     * Submit handler for cancel button.
     */
    public function standardCancel($form, FormStateInterface $form_state) {
        if (!empty($this->changed) && isset($this->form_cache)) {
            unset($this->form_cache);
            $this->cacheSet();
        }
        $form_state->setRedirectUrl($this->toUrl('edit-form'));
    }
    
    /**
     * Provides a standard set of Apply/Cancel/OK buttons for the forms.
     *
     * This will also provide a hidden op operator because the forms plugin
     * doesn't seem to properly provide which button was clicked.
     *
     * @todo Is the hidden op operator still here somewhere, or is that part of
     *   the docblock outdated?
     */
    public function getStandardButtons(&$form, FormStateInterface $form_state, $form_id, $name = NULL) {
        $form['actions'] = [
            '#type' => 'actions',
        ];
        if (empty($name)) {
            $name = t('Apply');
            if (!empty($this->stack) && count($this->stack) > 1) {
                $name = t('Apply and continue');
            }
            $names = [
                t('Apply'),
                t('Apply and continue'),
            ];
        }
        // Forms that are purely informational set an ok_button flag, so we know not
        // to create an "Apply" button for them.
        if (!$form_state->get('ok_button')) {
            $form['actions']['submit'] = [
                '#type' => 'submit',
                '#value' => $name,
                '#id' => 'edit-submit-' . Html::getUniqueId($form_id),
                // The regular submit handler ($form_id . '_submit') does not apply if
                // we're updating the default display. It does apply if we're updating
                // the current display. Since we have no way of knowing at this point
                // which display the user wants to update, views_ui_standard_submit will
                // take care of running the regular submit handler as appropriate.
'#submit' => [
                    [
                        $this,
                        'standardSubmit',
                    ],
                ],
                '#button_type' => 'primary',
            ];
            // Form API button click detection requires the button's #value to be the
            // same between the form build of the initial page request, and the
            // initial form build of the request processing the form submission.
            // Ideally, the button's #value shouldn't change until the form rebuild
            // step. However, \Drupal\views_ui\Form\Ajax\ViewsFormBase::getForm()
            // implements a different multistep form workflow than the Form API does,
            // and adjusts $view->stack prior to form processing, so we compensate by
            // extending button click detection code to support any of the possible
            // button labels.
            if (isset($names)) {
                $form['actions']['submit']['#values'] = $names;
                $form['actions']['submit']['#process'] = array_merge([
                    'views_ui_form_button_was_clicked',
                ], \Drupal::service('element_info')->getInfoProperty($form['actions']['submit']['#type'], '#process', []));
            }
            // If a validation handler exists for the form, assign it to this button.
            $form['actions']['submit']['#validate'][] = [
                $form_state->getFormObject(),
                'validateForm',
            ];
        }
        // Create a "Cancel" button. For purely informational forms, label it "OK".
        $cancel_submit = function_exists($form_id . '_cancel') ? $form_id . '_cancel' : [
            $this,
            'standardCancel',
        ];
        $form['actions']['cancel'] = [
            '#type' => 'submit',
            '#value' => !$form_state->get('ok_button') ? t('Cancel') : t('Ok'),
            '#submit' => [
                $cancel_submit,
            ],
            '#validate' => [],
            '#limit_validation_errors' => [],
        ];
        // Compatibility, to be removed later: // TODO: When is "later"?
        // We used to set these items on the form, but now we want them on the $form_state:
        if (isset($form['#title'])) {
            $form_state->set('title', $form['#title']);
        }
        if (isset($form['#section'])) {
            $form_state->set('#section', $form['#section']);
        }
        // Finally, we never want these cached -- our object cache does that for us.
        $form['#no_cache'] = TRUE;
    }
    
    /**
     * Return the was_defaulted, is_defaulted and revert state of a form.
     */
    public function getOverrideValues($form, FormStateInterface $form_state) {
        // Make sure the dropdown exists in the first place.
        if ($form_state->hasValue([
            'override',
            'dropdown',
        ])) {
            // #default_value is used to determine whether it was the default value or not.
            // So the available options are: $display, 'default' and 'default_revert', not 'defaults'.
            $was_defaulted = $form['override']['dropdown']['#default_value'] === 'defaults';
            $dropdown = $form_state->getValue([
                'override',
                'dropdown',
            ]);
            $is_defaulted = $dropdown === 'default';
            $revert = $dropdown === 'default_revert';
            if ($was_defaulted !== $is_defaulted && isset($form['#section'])) {
                // We're changing which display these values apply to.
                // Update the #section so it knows what to mark changed.
                $form['#section'] = str_replace('default-', $form_state->get('display_id') . '-', $form['#section']);
            }
        }
        else {
            // The user didn't get the dropdown for overriding the default display.
            $was_defaulted = FALSE;
            $is_defaulted = FALSE;
            $revert = FALSE;
        }
        return [
            $was_defaulted,
            $is_defaulted,
            $revert,
        ];
    }
    
    /**
     * Adds another form to the stack.
     *
     * Clicking 'apply' will go to this form rather than closing the ajax popup.
     */
    public function addFormToStack($key, $display_id, $type, $id = NULL, $top = FALSE, $rebuild_keys = FALSE) {
        // 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.
        Html::resetSeenIds();
        if (empty($this->stack)) {
            $this->stack = [];
        }
        $stack = [
            implode('-', array_filter([
                $key,
                $this->id(),
                $display_id,
                $type,
                $id,
            ])),
            $key,
            $display_id,
            $type,
            $id,
        ];
        // If we're being asked to add this form to the bottom of the stack, no
        // special logic is required. Our work is equally easy if we were asked to add
        // to the top of the stack, but there's nothing in it yet.
        if (!$top || empty($this->stack)) {
            $this->stack[] = $stack;
        }
        else {
            $keys = array_keys($this->stack);
            $first = current($keys);
            $last = end($keys);
            for ($i = $last; $i >= $first; $i--) {
                if (!isset($this->stack[$i])) {
                    continue;
                }
                // Move form number $i to the next position in the stack.
                $this->stack[$i + 1] = $this->stack[$i];
                unset($this->stack[$i]);
            }
            // Now that the previously $first slot is free, move the new form into it.
            $this->stack[$first] = $stack;
            ksort($this->stack);
            // Start the keys from 0 again, if requested.
            if ($rebuild_keys) {
                $this->stack = array_values($this->stack);
            }
        }
    }
    
    /**
     * Submit handler for adding new item(s) to a view.
     */
    public function submitItemAdd($form, FormStateInterface $form_state) {
        $type = $form_state->get('type');
        $types = ViewExecutable::getHandlerTypes();
        $section = $types[$type]['plural'];
        $display_id = $form_state->get('display_id');
        // Handle the override select.
        [
            $was_defaulted,
            $is_defaulted,
        ] = $this->getOverrideValues($form, $form_state);
        if ($was_defaulted && !$is_defaulted) {
            // We were using the default display's values, but we're now overriding
            // the default display and saving values specific to this display.
            $display =& $this->getExecutable()->displayHandlers
                ->get($display_id);
            // setOverride toggles the override of this section.
            $display->setOverride($section);
        }
        elseif (!$was_defaulted && $is_defaulted) {
            // We used to have an override for this display, but the user now wants
            // to go back to the default display.
            // Overwrite the default display with the current form values, and make
            // the current display use the new default values.
            $display =& $this->getExecutable()->displayHandlers
                ->get($display_id);
            // optionsOverride toggles the override of this section.
            $display->setOverride($section);
        }
        if (!$form_state->isValueEmpty('name') && is_array($form_state->getValue('name'))) {
            // Loop through each of the items that were checked and add them to the view.
            foreach (array_keys(array_filter($form_state->getValue('name'))) as $field) {
                [
                    $table,
                    $field,
                ] = explode('.', $field, 2);
                if ($cut = strpos($field, '$')) {
                    $field = substr($field, 0, $cut);
                }
                $id = $this->getExecutable()
                    ->addHandler($display_id, $type, $table, $field);
                // Check to see if we have group by settings
                $key = $type;
                // Footer,header and empty text have a different internal handler type(area).
                if (isset($types[$type]['type'])) {
                    $key = $types[$type]['type'];
                }
                $item = [
                    'table' => $table,
                    'field' => $field,
                ];
                $handler = Views::handlerManager($key)->getHandler($item);
                if ($this->getExecutable()->displayHandlers
                    ->get('default')
                    ->useGroupBy() && $handler->usesGroupBy()) {
                    $this->addFormToStack('handler-group', $display_id, $type, $id);
                }
                // Check to see if this type has settings, if so add the settings form first
                if ($handler && $handler->hasExtraOptions()) {
                    $this->addFormToStack('handler-extra', $display_id, $type, $id);
                }
                // Then add the form to the stack
                $this->addFormToStack('handler', $display_id, $type, $id);
            }
        }
        if (isset($this->form_cache)) {
            unset($this->form_cache);
        }
        // Store in cache
        $this->cacheSet();
    }
    
    /**
     * Set up query capturing.
     *
     * \Drupal\Core\Database\Database stores the queries that it runs, if logging
     * is enabled.
     *
     * @see ViewUI::endQueryCapture()
     */
    public function startQueryCapture() {
        Database::startLog('views');
    }
    
    /**
     * Add the list of queries run during render to build info.
     *
     * @see ViewUI::startQueryCapture()
     */
    public function endQueryCapture() {
        $queries = Database::getLog('views');
        $this->additionalQueries = $queries;
    }
    public function renderPreview($display_id, $args = []) {
        // Save the current path so it can be restored before returning from this function.
        $request_stack = \Drupal::requestStack();
        $current_request = $request_stack->getCurrentRequest();
        $executable = $this->getExecutable();
        // Determine where the query and performance statistics should be output.
        $config = \Drupal::config('views.settings');
        $show_query = $config->get('ui.show.sql_query.enabled');
        $show_info = $config->get('ui.show.preview_information');
        $show_location = $config->get('ui.show.sql_query.where');
        $show_stats = $config->get('ui.show.performance_statistics');
        if ($show_stats) {
            $show_stats = $config->get('ui.show.sql_query.where');
        }
        $combined = $show_query && $show_stats;
        $rows = [
            'query' => [],
            'statistics' => [],
        ];
        $errors = $executable->validate();
        $executable->destroy();
        if (empty($errors)) {
            $executable->live_preview = TRUE;
            // AJAX can happen via HTTP POST but everything expects exposed data to
            // be in GET. If we're clicking on links in a preview, though, we could
            // actually have some input in the query parameters, so we merge request()
            // and query() to ensure we get have all the values exposed.
            // We also make sure to remove ajax-framework specific keys and form
            // tokens to avoid any problems.
            $exposed_input = array_merge(\Drupal::request()->request
                ->all(), \Drupal::request()->query
                ->all());
            foreach (array_merge(ViewAjaxController::FILTERED_QUERY_PARAMETERS, [
                'form_id',
                'form_build_id',
                'form_token',
            ]) as $key) {
                if (isset($exposed_input[$key])) {
                    unset($exposed_input[$key]);
                }
            }
            $executable->setExposedInput($exposed_input);
            if (!$executable->setDisplay($display_id)) {
                return [
                    '#markup' => t('Invalid display id @display', [
                        '@display' => $display_id,
                    ]),
                ];
            }
            $executable->setArguments($args);
            // Store the current view URL for later use:
            if ($executable->hasUrl() && $executable->display_handler
                ->getOption('path')) {
                $path = $executable->getUrl();
            }
            // Make view links come back to preview.
            // Also override the current path so we get the pager, and make sure the
            // Request object gets all of the proper values from $_SERVER.
            $request = Request::createFromGlobals();
            $request->attributes
                ->set(RouteObjectInterface::ROUTE_NAME, 'entity.view.preview_form');
            $request->attributes
                ->set(RouteObjectInterface::ROUTE_OBJECT, \Drupal::service('router.route_provider')->getRouteByName('entity.view.preview_form'));
            $request->attributes
                ->set('view', $this->storage);
            $request->attributes
                ->set('display_id', $display_id);
            $raw_parameters = new InputBag();
            $raw_parameters->set('view', $this->id());
            $raw_parameters->set('display_id', $display_id);
            $request->attributes
                ->set('_raw_variables', $raw_parameters);
            foreach ($args as $key => $arg) {
                $request->attributes
                    ->set('arg_' . $key, $arg);
            }
            $request->setSession($request_stack->getSession());
            $request_stack->push($request);
            // Suppress contextual links of entities within the result set during a
            // Preview.
            // @todo We'll want to add contextual links specific to editing the View, so
            //   the suppression may need to be moved deeper into the Preview pipeline.
            views_ui_contextual_links_suppress_push();
            $show_additional_queries = $config->get('ui.show.additional_queries');
            Timer::start('entity.view.preview_form');
            if ($show_additional_queries) {
                $this->startQueryCapture();
            }
            // Execute/get the view preview.
            $preview = $executable->preview($display_id, $args);
            if ($show_additional_queries) {
                $this->endQueryCapture();
            }
            $this->render_time = Timer::stop('entity.view.preview_form')['time'];
            views_ui_contextual_links_suppress_pop();
            // Prepare the query information and statistics to show either above or
            // below the view preview.
            // Initialize the empty rows arrays so we can safely merge them later.
            $rows['query'] = [];
            $rows['statistics'] = [];
            if ($show_info || $show_query || $show_stats) {
                // Get information from the preview for display.
                if (!empty($executable->build_info['query'])) {
                    if ($show_query) {
                        $query_string = $executable->build_info['query'];
                        // Only the sql default class has a method getArguments.
                        $quoted = [];
                        if ($executable->query instanceof Sql) {
                            $quoted = $query_string->getArguments();
                            $connection = Database::getConnection();
                            foreach ($quoted as $key => $val) {
                                if (is_array($val)) {
                                    $quoted[$key] = implode(', ', array_map([
                                        $connection,
                                        'quote',
                                    ], $val));
                                }
                                else {
                                    $quoted[$key] = $connection->quote($val);
                                }
                            }
                        }
                        $rows['query'][] = [
                            [
                                'data' => [
                                    '#type' => 'inline_template',
                                    '#template' => "<strong>{% trans 'Query' %}</strong>",
                                ],
                            ],
                            [
                                'data' => [
                                    '#type' => 'inline_template',
                                    '#template' => '<pre>{{ query }}</pre>',
                                    '#context' => [
                                        'query' => strtr($query_string, $quoted),
                                    ],
                                ],
                            ],
                        ];
                        if (!empty($this->additionalQueries)) {
                            $queries[] = [
                                '#prefix' => '<strong>',
                                '#markup' => t('These queries were run during view rendering:'),
                                '#suffix' => '</strong>',
                            ];
                            foreach ($this->additionalQueries as $query) {
                                $query_string = strtr($query['query'], $query['args']);
                                $queries[] = [
                                    '#prefix' => "\n",
                                    '#markup' => t('[@time ms] @query', [
                                        '@time' => round($query['time'] * 100000, 1) / 100000.0,
                                        '@query' => $query_string,
                                    ]),
                                ];
                            }
                            $rows['query'][] = [
                                [
                                    'data' => [
                                        '#type' => 'inline_template',
                                        '#template' => "<strong>{% trans 'Other queries' %}</strong>",
                                    ],
                                ],
                                [
                                    'data' => [
                                        '#prefix' => '<pre>',
                                        'queries' => $queries,
                                        '#suffix' => '</pre>',
                                    ],
                                ],
                            ];
                        }
                    }
                    if ($show_info) {
                        $rows['query'][] = [
                            [
                                'data' => [
                                    '#type' => 'inline_template',
                                    '#template' => "<strong>{% trans 'Title' %}</strong>",
                                ],
                            ],
                            [
                                'data' => [
                                    '#markup' => $executable->getTitle(),
                                    '#allowed_tags' => Xss::getHtmlTagList(),
                                ],
                            ],
                        ];
                        if (isset($path)) {
                            // @todo Views should expect and store a leading /. See:
                            //   https://www.drupal.org/node/2423913
                            $path = Link::fromTextAndUrl($path->toString(), $path)
                                ->toString();
                        }
                        else {
                            $path = t('This display has no path.');
                        }
                        $rows['query'][] = [
                            [
                                'data' => [
                                    '#prefix' => '<strong>',
                                    '#markup' => t('Path'),
                                    '#suffix' => '</strong>',
                                ],
                            ],
                            [
                                'data' => [
                                    '#markup' => $path,
                                ],
                            ],
                        ];
                    }
                    if ($show_stats) {
                        $rows['statistics'][] = [
                            [
                                'data' => [
                                    '#type' => 'inline_template',
                                    '#template' => "<strong>{% trans 'Query build time' %}</strong>",
                                ],
                            ],
                            t('@time ms', [
                                '@time' => intval($executable->build_time * 100000) / 100,
                            ]),
                        ];
                        $rows['statistics'][] = [
                            [
                                'data' => [
                                    '#type' => 'inline_template',
                                    '#template' => "<strong>{% trans 'Query execute time' %}</strong>",
                                ],
                            ],
                            t('@time ms', [
                                '@time' => intval($executable->execute_time * 100000) / 100,
                            ]),
                        ];
                        $rows['statistics'][] = [
                            [
                                'data' => [
                                    '#type' => 'inline_template',
                                    '#template' => "<strong>{% trans 'View render time' %}</strong>",
                                ],
                            ],
                            t('@time ms', [
                                '@time' => intval($this->render_time * 100) / 100,
                            ]),
                        ];
                    }
                    \Drupal::moduleHandler()->alter('views_preview_info', $rows, $executable);
                }
                else {
                    // No query was run. Display that information in place of either the
                    // query or the performance statistics, whichever comes first.
                    if ($combined || $show_location === 'above') {
                        $rows['query'][] = [
                            [
                                'data' => [
                                    '#prefix' => '<strong>',
                                    '#markup' => t('Query'),
                                    '#suffix' => '</strong>',
                                ],
                            ],
                            [
                                'data' => [
                                    '#markup' => t('No query was run'),
                                ],
                            ],
                        ];
                    }
                    else {
                        $rows['statistics'][] = [
                            [
                                'data' => [
                                    '#prefix' => '<strong>',
                                    '#markup' => t('Query'),
                                    '#suffix' => '</strong>',
                                ],
                            ],
                            [
                                'data' => [
                                    '#markup' => t('No query was run'),
                                ],
                            ],
                        ];
                    }
                }
            }
        }
        else {
            foreach ($errors as $display_errors) {
                foreach ($display_errors as $error) {
                    \Drupal::messenger()->addError($error);
                }
            }
            $preview = [
                '#markup' => t('Unable to preview due to validation errors.'),
            ];
        }
        // Assemble the preview, the query info, and the query statistics in the
        // requested order.
        $table = [
            '#type' => 'table',
            '#prefix' => '<div class="views-query-info">',
            '#suffix' => '</div>',
            '#rows' => array_merge($rows['query'], $rows['statistics']),
        ];
        if ($show_location == 'above') {
            $output = [
                'table' => $table,
                'preview' => $preview,
            ];
        }
        else {
            $output = [
                'preview' => $preview,
                'table' => $table,
            ];
        }
        // Ensure that we just remove an additional request we pushed earlier.
        // This could happen if $errors was not empty.
        if ($request_stack->getCurrentRequest() != $current_request) {
            $request_stack->pop();
        }
        return $output;
    }
    
    /**
     * Get the user's current progress through the form stack.
     *
     * @return array|bool
     *   FALSE if the user is not currently in a multiple-form stack. Otherwise,
     *   an associative array with the following keys:
     *   - current: The number of the current form on the stack.
     *   - total: The total number of forms originally on the stack.
     */
    public function getFormProgress() {
        $progress = FALSE;
        if (!empty($this->stack)) {
            // The forms on the stack have integer keys that don't change as the forms
            // are completed, so we can see which ones are still left.
            $keys = array_keys($this->stack);
            // Add 1 to the array keys for the benefit of humans, who start counting
            // from 1 and not 0.
            $current = reset($keys) + 1;
            $total = end($keys) + 1;
            if ($total > 1) {
                $progress = [];
                $progress['current'] = $current;
                $progress['total'] = $total;
            }
        }
        return $progress;
    }
    
    /**
     * Sets a cached view object in the shared tempstore.
     */
    public function cacheSet() {
        if ($this->isLocked()) {
            \Drupal::messenger()->addError(t('Changes cannot be made to a locked view.'));
            return;
        }
        // Let any future object know that this view has changed.
        $this->changed = TRUE;
        $executable = $this->getExecutable();
        if (isset($executable->current_display)) {
            // Add the knowledge of the changed display, too.
            $this->changed_display[$executable->current_display] = TRUE;
            $executable->current_display = NULL;
        }
        // Unset handlers. We don't want to write these into the cache.
        $executable->display_handler = NULL;
        $executable->default_display = NULL;
        $executable->query = NULL;
        $executable->displayHandlers = NULL;
        \Drupal::service('tempstore.shared')->get('views')
            ->set($this->id(), $this);
    }
    
    /**
     * Returns whether the current view is locked.
     *
     * @return bool
     *   TRUE if the view is locked, FALSE otherwise.
     */
    public function isLocked() {
        $lock = $this->getLock();
        return $lock && $lock->getOwnerId() != \Drupal::currentUser()->id();
    }
    
    /**
     * Passes through all unknown calls onto the storage object.
     */
    public function __call($method, $args) {
        return call_user_func_array([
            $this->storage,
            $method,
        ], $args);
    }
    
    /**
     * {@inheritdoc}
     */
    public function &getDisplay($display_id) {
        return $this->storage
            ->getDisplay($display_id);
    }
    
    /**
     * {@inheritdoc}
     */
    public function id() {
        return $this->storage
            ->id();
    }
    
    /**
     * {@inheritdoc}
     */
    public function uuid() {
        return $this->storage
            ->uuid();
    }
    
    /**
     * {@inheritdoc}
     */
    public function isNew() {
        return $this->storage
            ->isNew();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getEntityTypeId() {
        return $this->storage
            ->getEntityTypeId();
    }
    
    /**
     * {@inheritdoc}
     */
    public function bundle() {
        return $this->storage
            ->bundle();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getEntityType() {
        return $this->storage
            ->getEntityType();
    }
    
    /**
     * {@inheritdoc}
     */
    public function createDuplicate() {
        return $this->storage
            ->createDuplicate();
    }
    
    /**
     * {@inheritdoc}
     */
    public static function load($id) {
        return View::load($id);
    }
    
    /**
     * {@inheritdoc}
     */
    public static function loadMultiple(?array $ids = NULL) {
        return View::loadMultiple($ids);
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(array $values = []) {
        return View::create($values);
    }
    
    /**
     * {@inheritdoc}
     */
    public function delete() {
        return $this->storage
            ->delete();
    }
    
    /**
     * {@inheritdoc}
     */
    public function save() {
        return $this->storage
            ->save();
    }
    
    /**
     * {@inheritdoc}
     */
    public function toUrl($rel = NULL, array $options = []) {
        return $this->storage
            ->toUrl($rel, $options);
    }
    
    /**
     * {@inheritdoc}
     */
    public function toLink($text = NULL, $rel = 'edit-form', array $options = []) {
        return $this->storage
            ->toLink($text, $rel, $options);
    }
    
    /**
     * {@inheritdoc}
     */
    public function label() {
        return $this->storage
            ->label();
    }
    
    /**
     * {@inheritdoc}
     */
    public function enforceIsNew($value = TRUE) {
        return $this->storage
            ->enforceIsNew($value);
    }
    
    /**
     * {@inheritdoc}
     */
    public function toArray() {
        return $this->storage
            ->toArray();
    }
    
    /**
     * {@inheritdoc}
     */
    public function language() {
        return $this->storage
            ->language();
    }
    
    /**
     * {@inheritdoc}
     */
    public function access($operation = 'view', ?AccountInterface $account = NULL, $return_as_object = FALSE) {
        return $this->storage
            ->access($operation, $account, $return_as_object);
    }
    
    /**
     * {@inheritdoc}
     */
    public function enable() {
        return $this->storage
            ->enable();
    }
    
    /**
     * {@inheritdoc}
     */
    public function disable() {
        return $this->storage
            ->disable();
    }
    
    /**
     * {@inheritdoc}
     */
    public function status() {
        return $this->storage
            ->status();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getOriginalId() {
        return $this->storage
            ->getOriginalId();
    }
    
    /**
     * {@inheritdoc}
     */
    public function setOriginalId($id) {
        return $this->storage
            ->setOriginalId($id);
    }
    
    /**
     * {@inheritdoc}
     */
    public function preSave(EntityStorageInterface $storage) {
        $this->storage
            ->presave($storage);
    }
    
    /**
     * {@inheritdoc}
     */
    public function postSave(EntityStorageInterface $storage, $update = TRUE) {
        $this->storage
            ->postSave($storage, $update);
    }
    
    /**
     * {@inheritdoc}
     */
    public static function preCreate(EntityStorageInterface $storage, array &$values) {
    }
    
    /**
     * {@inheritdoc}
     */
    public function postCreate(EntityStorageInterface $storage) {
        $this->storage
            ->postCreate($storage);
    }
    
    /**
     * {@inheritdoc}
     */
    public static function preDelete(EntityStorageInterface $storage, array $entities) {
    }
    
    /**
     * {@inheritdoc}
     */
    public static function postDelete(EntityStorageInterface $storage, array $entities) {
    }
    
    /**
     * {@inheritdoc}
     */
    public static function postLoad(EntityStorageInterface $storage, array &$entities) {
    }
    
    /**
     * {@inheritdoc}
     */
    public function getExecutable() {
        return $this->storage
            ->getExecutable();
    }
    
    /**
     * {@inheritdoc}
     */
    public function duplicateDisplayAsType($old_display_id, $new_display_type) {
        return $this->storage
            ->duplicateDisplayAsType($old_display_id, $new_display_type);
    }
    
    /**
     * {@inheritdoc}
     */
    public function mergeDefaultDisplaysOptions() {
        $this->storage
            ->mergeDefaultDisplaysOptions();
    }
    
    /**
     * {@inheritdoc}
     */
    public function uriRelationships() {
        return $this->storage
            ->uriRelationships();
    }
    
    /**
     * {@inheritdoc}
     */
    public function referencedEntities() {
        return $this->storage
            ->referencedEntities();
    }
    
    /**
     * {@inheritdoc}
     */
    public function hasLinkTemplate($key) {
        return $this->storage
            ->hasLinkTemplate($key);
    }
    
    /**
     * {@inheritdoc}
     */
    public function calculateDependencies() {
        $this->storage
            ->calculateDependencies();
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getConfigDependencyKey() {
        return $this->storage
            ->getConfigDependencyKey();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getConfigDependencyName() {
        return $this->storage
            ->getConfigDependencyName();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getConfigTarget() {
        return $this->storage
            ->getConfigTarget();
    }
    
    /**
     * {@inheritdoc}
     */
    public function onDependencyRemoval(array $dependencies) {
        return $this->storage
            ->onDependencyRemoval($dependencies);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDependencies() {
        return $this->storage
            ->getDependencies();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheContexts() {
        return $this->storage
            ->getCacheContexts();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheTags() {
        return $this->storage
            ->getCacheTags();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheMaxAge() {
        return $this->storage
            ->getCacheMaxAge();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getTypedData() {
        $this->storage
            ->getTypedData();
    }
    
    /**
     * {@inheritdoc}
     */
    public function addDisplay($plugin_id = 'page', $title = NULL, $id = NULL) {
        return $this->storage
            ->addDisplay($plugin_id, $title, $id);
    }
    
    /**
     * {@inheritdoc}
     */
    public function isInstallable() {
        return $this->storage
            ->isInstallable();
    }
    
    /**
     * {@inheritdoc}
     */
    public function setThirdPartySetting($module, $key, $value) {
        return $this->storage
            ->setThirdPartySetting($module, $key, $value);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getThirdPartySetting($module, $key, $default = NULL) {
        return $this->storage
            ->getThirdPartySetting($module, $key, $default);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getThirdPartySettings($module) {
        return $this->storage
            ->getThirdPartySettings($module);
    }
    
    /**
     * {@inheritdoc}
     */
    public function unsetThirdPartySetting($module, $key) {
        return $this->storage
            ->unsetThirdPartySetting($module, $key);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getThirdPartyProviders() {
        return $this->storage
            ->getThirdPartyProviders();
    }
    
    /**
     * {@inheritdoc}
     */
    public function trustData() {
        return $this->storage
            ->trustData();
    }
    
    /**
     * {@inheritdoc}
     */
    public function hasTrustedData() {
        return $this->storage
            ->hasTrustedData();
    }
    
    /**
     * {@inheritdoc}
     */
    public function addCacheableDependency($other_object) {
        $this->storage
            ->addCacheableDependency($other_object);
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function addCacheContexts(array $cache_contexts) {
        return $this->storage
            ->addCacheContexts($cache_contexts);
    }
    
    /**
     * {@inheritdoc}
     */
    public function mergeCacheMaxAge($max_age) {
        return $this->storage
            ->mergeCacheMaxAge($max_age);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheTagsToInvalidate() {
        return $this->storage
            ->getCacheTagsToInvalidate();
    }
    
    /**
     * {@inheritdoc}
     */
    public function addCacheTags(array $cache_tags) {
        return $this->storage
            ->addCacheTags($cache_tags);
    }
    
    /**
     * Gets the lock on this View.
     *
     * @return \Drupal\Core\TempStore\Lock|null
     *   The lock, if one exists.
     */
    public function getLock() {
        return $this->lock;
    }
    
    /**
     * Sets a lock on this View.
     *
     * @param \Drupal\Core\TempStore\Lock $lock
     *   The lock object.
     *
     * @return $this
     */
    public function setLock(Lock $lock) {
        $this->lock = $lock;
        return $this;
    }
    
    /**
     * Unsets the lock on this View.
     *
     * @return $this
     */
    public function unsetLock() {
        $this->lock = NULL;
        return $this;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
ViewUI::$additionalQueries protected property Stores a list of database queries run beside the main one from views.
ViewUI::$changed public property If this view has been changed.
ViewUI::$changed_display public property
ViewUI::$editing public property Indicates if a view is currently being edited.
ViewUI::$entityType protected property The entity type.
ViewUI::$forms public static property Contains an array of form keys and their respective classes.
ViewUI::$isSyncing private property Whether the config is being synced through the import process.
ViewUI::$isUninstalling private property Whether the config is being deleted through the uninstall process.
ViewUI::$live_preview public property
ViewUI::$lock private property If this view is locked for editing.
ViewUI::$renderPreview public property
ViewUI::$render_time public property
ViewUI::$stack public property Stores a stack of UI forms to display.
ViewUI::$storage protected property The View storage object.
ViewUI::$temporary_options public property
ViewUI::access public function Checks data value access. Overrides AccessibleInterface::access
ViewUI::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata. Overrides RefinableCacheableDependencyInterface::addCacheableDependency
ViewUI::addCacheContexts public function Adds cache contexts. Overrides RefinableCacheableDependencyInterface::addCacheContexts
ViewUI::addCacheTags public function Adds cache tags. Overrides RefinableCacheableDependencyInterface::addCacheTags
ViewUI::addDisplay public function Adds a new display handler to the view, automatically creating an ID. Overrides ViewEntityInterface::addDisplay
ViewUI::addFormToStack public function Adds another form to the stack.
ViewUI::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle
ViewUI::cacheSet public function Sets a cached view object in the shared tempstore.
ViewUI::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies
ViewUI::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
ViewUI::createDuplicate public function Creates a duplicate of the entity. Overrides EntityInterface::createDuplicate
ViewUI::delete public function Deletes an entity permanently. Overrides EntityInterface::delete
ViewUI::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable
ViewUI::duplicateDisplayAsType public function Duplicates an existing display into a new display type. Overrides ViewEntityInterface::duplicateDisplayAsType
ViewUI::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ViewUI::endQueryCapture public function Add the list of queries run during render to build info.
ViewUI::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
ViewUI::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ViewUI::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
ViewUI::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
ViewUI::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
ViewUI::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityInterface::getCacheTagsToInvalidate
ViewUI::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
ViewUI::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityInterface::getConfigDependencyName
ViewUI::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityInterface::getConfigTarget
ViewUI::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ViewUI::getDisplay public function Retrieves a specific display&#039;s configuration by reference. Overrides ViewEntityInterface::getDisplay
ViewUI::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
ViewUI::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
ViewUI::getExecutable public function Gets an executable instance for this view. Overrides ViewEntityInterface::getExecutable
ViewUI::getFormProgress public function Get the user&#039;s current progress through the form stack.
ViewUI::getLock public function Gets the lock on this View.
ViewUI::getOriginalId public function Gets the original ID. Overrides EntityInterface::getOriginalId
ViewUI::getOverrideValues public function Return the was_defaulted, is_defaulted and revert state of a form.
ViewUI::getStandardButtons public function Provides a standard set of Apply/Cancel/OK buttons for the forms.
ViewUI::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ViewUI::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ViewUI::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ViewUI::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
ViewUI::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
ViewUI::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ViewUI::id public function Gets the identifier. Overrides EntityInterface::id
ViewUI::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable
ViewUI::isLocked public function Returns whether the current view is locked.
ViewUI::isNew public function Determines whether the entity is new. Overrides EntityInterface::isNew
ViewUI::isSyncing public function Returns whether this entity is being changed as part of a synchronization. Overrides SynchronizableInterface::isSyncing
ViewUI::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ViewUI::label public function Gets the label of the entity. Overrides EntityInterface::label
ViewUI::language public function Gets the language of the entity. Overrides EntityInterface::language
ViewUI::load public static function Loads an entity. Overrides EntityInterface::load
ViewUI::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
ViewUI::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age. Overrides RefinableCacheableDependencyInterface::mergeCacheMaxAge
ViewUI::mergeDefaultDisplaysOptions public function Add defaults to the display options. Overrides ViewEntityInterface::mergeDefaultDisplaysOptions
ViewUI::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval
ViewUI::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate
ViewUI::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete
ViewUI::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad
ViewUI::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave
ViewUI::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate
ViewUI::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityInterface::preDelete
ViewUI::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityInterface::preSave
ViewUI::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities
ViewUI::renderPreview public function
ViewUI::save public function Saves an entity permanently. Overrides EntityInterface::save
ViewUI::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ViewUI::setLock public function Sets a lock on this View.
ViewUI::setOriginalId public function Sets the original ID. Overrides EntityInterface::setOriginalId
ViewUI::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ViewUI::setSyncing public function Sets the status of the synchronization flag. Overrides SynchronizableInterface::setSyncing
ViewUI::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ViewUI::setUninstalling public function
ViewUI::standardCancel public function Submit handler for cancel button.
ViewUI::standardSubmit public function Basic submit handler applicable to all &#039;standard&#039; forms.
ViewUI::startQueryCapture public function Set up query capturing.
ViewUI::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status
ViewUI::submitItemAdd public function Submit handler for adding new item(s) to a view.
ViewUI::toArray public function Gets an array of all property values. Overrides EntityInterface::toArray
ViewUI::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
ViewUI::toUrl public function Gets the URL object for the entity. Overrides EntityInterface::toUrl
ViewUI::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ViewUI::unsetLock public function Unsets the lock on this View.
ViewUI::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ViewUI::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
ViewUI::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid
ViewUI::__call public function Passes through all unknown calls onto the storage object.
ViewUI::__construct public function Constructs a View UI object.

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