class Display

Same name in other branches
  1. 9 core/modules/views_ui/src/Form/Ajax/Display.php \Drupal\views_ui\Form\Ajax\Display
  2. 10 core/modules/views_ui/src/Form/Ajax/Display.php \Drupal\views_ui\Form\Ajax\Display
  3. 11.x core/modules/views_ui/src/Form/Ajax/Display.php \Drupal\views_ui\Form\Ajax\Display

Provides a form for editing the Views display.

@internal

Hierarchy

Expanded class hierarchy of Display

111 string references to 'Display'
Attachment::buildOptionsForm in core/modules/views/src/Plugin/views/display/Attachment.php
Provide the default form for setting options.
BasicTest::testWizardDefaultValues in core/modules/views/tests/src/Functional/Wizard/BasicTest.php
Tests default plugin values are populated from the wizard form.
block_content_post_update_add_views_reusable_filter in core/modules/block_content/block_content.post_update.php
Adds a 'reusable' filter to all Custom Block views.
CacheabilityMetadataUpdateTest::testUpdateHookN in core/modules/views/tests/src/Functional/Update/CacheabilityMetadataUpdateTest.php
Tests that views cacheability metadata updated properly.
content_moderation_post_update_views_field_plugin_id in core/modules/content_moderation/content_moderation.post_update.php
Update the moderation state views field plugin ID.

... See full list

File

core/modules/views_ui/src/Form/Ajax/Display.php, line 13

Namespace

Drupal\views_ui\Form\Ajax
View source
class Display extends ViewsFormBase {
    
    /**
     * Constructs a new Display object.
     */
    public function __construct($type = NULL) {
        $this->setType($type);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormKey() {
        return 'display';
    }
    
    /**
     * {@inheritdoc}
     *
     * @todo Remove this and switch all usage of $form_state->get('section') to
     *   $form_state->get('type').
     */
    public function getFormState(ViewEntityInterface $view, $display_id, $js) {
        $form_state = parent::getFormState($view, $display_id, $js);
        $form_state->set('section', $this->type);
        return $form_state;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getForm(ViewEntityInterface $view, $display_id, $js, $type = NULL) {
        $this->setType($type);
        return parent::getForm($view, $display_id, $js);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'views_ui_edit_display_form';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $view = $form_state->get('view');
        $display_id = $form_state->get('display_id');
        $executable = $view->getExecutable();
        if (!$executable->setDisplay($display_id)) {
            $form['markup'] = [
                '#markup' => $this->t('Invalid display id @display', [
                    '@display' => $display_id,
                ]),
            ];
            return $form;
        }
        // Get form from the handler.
        $form['options'] = [
            '#theme_wrappers' => [
                'container',
            ],
            '#attributes' => [
                'class' => [
                    'scroll',
                ],
                'data-drupal-views-scroll' => TRUE,
            ],
        ];
        $executable->display_handler
            ->buildOptionsForm($form['options'], $form_state);
        // The handler options form sets $form['#title'], which we need on the entire
        // $form instead of just the ['options'] section.
        $form['#title'] = $form['options']['#title'];
        unset($form['options']['#title']);
        // Move the override dropdown out of the scrollable section of the form.
        if (isset($form['options']['override'])) {
            $form['override'] = $form['options']['override'];
            unset($form['options']['override']);
        }
        $name = $form_state->get('update_name');
        $view->getStandardButtons($form, $form_state, 'views_ui_edit_display_form', $name);
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function validateForm(array &$form, FormStateInterface $form_state) {
        $view = $form_state->get('view');
        $display_id = $form_state->get('display_id');
        $view->getExecutable()->displayHandlers
            ->get($display_id)
            ->validateOptionsForm($form['options'], $form_state);
        if ($form_state->getErrors()) {
            $form_state->set('rerender', TRUE);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $view = $form_state->get('view');
        $display_id = $form_state->get('display_id');
        $view->getExecutable()->displayHandlers
            ->get($display_id)
            ->submitOptionsForm($form['options'], $form_state);
        $view->cacheSet();
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
Display::buildForm public function Form constructor. Overrides FormInterface::buildForm
Display::getForm public function Creates a new instance of this form. Overrides ViewsFormBase::getForm
Display::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
Display::getFormKey public function Returns the key that represents this form. Overrides ViewsFormInterface::getFormKey
Display::getFormState public function @todo Remove this and switch all usage of $form_state->get('section') to
$form_state->get('type').
Overrides ViewsFormBase::getFormState
Display::submitForm public function Form submission handler. Overrides ViewsFormBase::submitForm
Display::validateForm public function Form validation handler. Overrides ViewsFormBase::validateForm
Display::__construct public function Constructs a new Display object.
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 105
FormBase::currentUser protected function Gets the current user.
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. Overrides UrlGeneratorTrait::redirect
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.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
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. 17
MessengerTrait::messenger public function Gets the messenger. 17
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' 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.
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.
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::ajaxFormWrapper protected function Wrapper for handling AJAX forms.
ViewsFormBase::setID protected function Sets the ID for this form.
ViewsFormBase::setType protected function Sets the type for this form.

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