class AdvancedSettingsForm

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

Form builder for the advanced admin settings page.

@internal

Hierarchy

Expanded class hierarchy of AdvancedSettingsForm

1 string reference to 'AdvancedSettingsForm'
views_ui.routing.yml in core/modules/views_ui/views_ui.routing.yml
core/modules/views_ui/views_ui.routing.yml

File

core/modules/views_ui/src/Form/AdvancedSettingsForm.php, line 14

Namespace

Drupal\views_ui\Form
View source
class AdvancedSettingsForm extends ConfigFormBase {
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'views_ui_admin_settings_advanced';
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getEditableConfigNames() {
        return [
            'views.settings',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $form = parent::buildForm($form, $form_state);
        $config = $this->config('views.settings');
        $form['cache'] = [
            '#type' => 'details',
            '#title' => $this->t('Caching'),
            '#open' => TRUE,
        ];
        $form['cache']['skip_cache'] = [
            '#type' => 'checkbox',
            '#title' => $this->t('Disable views data caching'),
            '#description' => $this->t("Views caches data about tables, modules and views available, to increase performance. By checking this box, Views will skip this cache and always rebuild this data when needed. This can have a serious performance impact on your site."),
            '#default_value' => $config->get('skip_cache'),
        ];
        $form['cache']['clear_cache'] = [
            '#type' => 'submit',
            '#value' => $this->t("Clear Views' cache"),
            '#submit' => [
                '::cacheSubmit',
            ],
        ];
        $form['debug'] = [
            '#type' => 'details',
            '#title' => $this->t('Debugging'),
            '#open' => TRUE,
        ];
        $form['debug']['sql_signature'] = [
            '#type' => 'checkbox',
            '#title' => $this->t('Add Views signature to all SQL queries'),
            '#description' => $this->t("All Views-generated queries will include the name of the views and display 'view-name:display-name' as a string at the end of the SELECT clause. This makes identifying Views queries in database server logs simpler, but should only be used when troubleshooting."),
            '#default_value' => $config->get('sql_signature'),
        ];
        $options = Views::fetchPluginNames('display_extender');
        if (!empty($options)) {
            $form['extenders'] = [
                '#type' => 'details',
                '#title' => $this->t('Display extenders'),
                '#open' => TRUE,
            ];
            $form['extenders']['display_extenders'] = [
                '#default_value' => array_filter($config->get('display_extenders')),
                '#options' => $options,
                '#type' => 'checkboxes',
                '#description' => $this->t('Select extensions of the views interface.'),
            ];
        }
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $this->config('views.settings')
            ->set('skip_cache', $form_state->getValue('skip_cache'))
            ->set('sql_signature', $form_state->getValue('sql_signature'))
            ->set('display_extenders', $form_state->getValue('display_extenders', []))
            ->save();
        parent::submitForm($form, $form_state);
    }
    
    /**
     * Submission handler to clear the Views cache.
     */
    public function cacheSubmit() {
        views_invalidate_cache();
        $this->messenger()
            ->addStatus($this->t('The cache has been cleared.'));
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AdvancedSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
AdvancedSettingsForm::cacheSubmit public function Submission handler to clear the Views cache.
AdvancedSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
AdvancedSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
AdvancedSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 18
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 16
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
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
FormBase::$configFactory protected property The config factory. 3
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::configFactory protected function Gets the config factory for this form. 3
FormBase::container private function Returns the service container.
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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 73
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.

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