class BasicSettingsForm
Same name in other branches
- 8.9.x core/modules/views_ui/src/Form/BasicSettingsForm.php \Drupal\views_ui\Form\BasicSettingsForm
- 10 core/modules/views_ui/src/Form/BasicSettingsForm.php \Drupal\views_ui\Form\BasicSettingsForm
- 11.x core/modules/views_ui/src/Form/BasicSettingsForm.php \Drupal\views_ui\Form\BasicSettingsForm
Form builder for the admin display defaults page.
@internal
Hierarchy
- class \Drupal\Core\Form\FormBase implements \Drupal\Core\Form\FormInterface, \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase extends \Drupal\Core\Form\FormBase uses \Drupal\Core\Form\ConfigFormBaseTrait
- class \Drupal\views_ui\Form\BasicSettingsForm extends \Drupal\Core\Form\ConfigFormBase
- class \Drupal\Core\Form\ConfigFormBase extends \Drupal\Core\Form\FormBase uses \Drupal\Core\Form\ConfigFormBaseTrait
Expanded class hierarchy of BasicSettingsForm
1 string reference to 'BasicSettingsForm'
- 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/ BasicSettingsForm.php, line 16
Namespace
Drupal\views_ui\FormView source
class BasicSettingsForm extends ConfigFormBase {
/**
* The theme handler.
*
* @var \Drupal\Core\Extension\ThemeHandlerInterface
*/
protected $themeHandler;
/**
* Constructs a \Drupal\views_ui\Form\BasicSettingsForm object.
*
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
* The factory for configuration objects.
* @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler
* The theme handler.
*/
public function __construct(ConfigFactoryInterface $config_factory, ThemeHandlerInterface $theme_handler) {
parent::__construct($config_factory);
$this->themeHandler = $theme_handler;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container->get('config.factory'), $container->get('theme_handler'));
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'views_ui_admin_settings_basic';
}
/**
* {@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');
$options = [];
foreach ($this->themeHandler
->listInfo() as $name => $theme) {
if ($theme->status) {
$options[$name] = $theme->info['name'];
}
}
// This is not currently a fieldset but we may want it to be later,
// so this will make it easier to change if we do.
$form['basic'] = [];
$form['basic']['ui_show_default_display'] = [
'#type' => 'checkbox',
'#title' => $this->t('Always show the default display'),
'#default_value' => $config->get('ui.show.default_display'),
];
$form['basic']['ui_show_advanced_column'] = [
'#type' => 'checkbox',
'#title' => $this->t('Always show advanced display settings'),
'#default_value' => $config->get('ui.show.advanced_column'),
];
$form['basic']['ui_show_display_embed'] = [
'#type' => 'checkbox',
'#title' => $this->t('Allow embedded displays'),
'#description' => $this->t('Embedded displays can be used in code via views_embed_view().'),
'#default_value' => $config->get('ui.show.display_embed'),
];
$form['basic']['ui_exposed_filter_any_label'] = [
'#type' => 'select',
'#title' => $this->t('Label for "Any" value on non-required single-select exposed filters'),
'#options' => [
'old_any' => '<Any>',
'new_any' => $this->t('- Any -'),
],
'#default_value' => $config->get('ui.exposed_filter_any_label'),
];
$form['live_preview'] = [
'#type' => 'details',
'#title' => $this->t('Live preview settings'),
'#open' => TRUE,
];
$form['live_preview']['ui_always_live_preview'] = [
'#type' => 'checkbox',
'#title' => $this->t('Automatically update preview on changes'),
'#default_value' => $config->get('ui.always_live_preview'),
];
$form['live_preview']['ui_show_preview_information'] = [
'#type' => 'checkbox',
'#title' => $this->t('Show information and statistics about the view during live preview'),
'#default_value' => $config->get('ui.show.preview_information'),
];
$form['live_preview']['options'] = [
'#type' => 'container',
'#states' => [
'visible' => [
':input[name="ui_show_preview_information"]' => [
'checked' => TRUE,
],
],
],
];
$form['live_preview']['options']['ui_show_sql_query_enabled'] = [
'#type' => 'checkbox',
'#title' => $this->t('Show the SQL query'),
'#default_value' => $config->get('ui.show.sql_query.enabled'),
];
$form['live_preview']['options']['ui_show_sql_query_where'] = [
'#type' => 'radios',
'#states' => [
'visible' => [
':input[name="ui_show_sql_query_enabled"]' => [
'checked' => TRUE,
],
],
],
'#title' => $this->t('Show SQL query'),
'#options' => [
'above' => $this->t('Above the preview'),
'below' => $this->t('Below the preview'),
],
'#default_value' => $config->get('ui.show.sql_query.where'),
];
$form['live_preview']['options']['ui_show_performance_statistics'] = [
'#type' => 'checkbox',
'#title' => $this->t('Show performance statistics'),
'#default_value' => $config->get('ui.show.performance_statistics'),
];
$form['live_preview']['options']['ui_show_additional_queries'] = [
'#type' => 'checkbox',
'#title' => $this->t('Show other queries run during render during live preview'),
'#description' => $this->t("Drupal has the potential to run many queries while a view is being rendered. Checking this box will display every query run during view render as part of the live preview."),
'#default_value' => $config->get('ui.show.additional_queries'),
];
return $form;
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$this->config('views.settings')
->set('ui.show.default_display', $form_state->getValue('ui_show_default_display'))
->set('ui.show.advanced_column', $form_state->getValue('ui_show_advanced_column'))
->set('ui.show.display_embed', $form_state->getValue('ui_show_display_embed'))
->set('ui.exposed_filter_any_label', $form_state->getValue('ui_exposed_filter_any_label'))
->set('ui.always_live_preview', $form_state->getValue('ui_always_live_preview'))
->set('ui.show.preview_information', $form_state->getValue('ui_show_preview_information'))
->set('ui.show.sql_query.where', $form_state->getValue('ui_show_sql_query_where'))
->set('ui.show.sql_query.enabled', $form_state->getValue('ui_show_sql_query_enabled'))
->set('ui.show.performance_statistics', $form_state->getValue('ui_show_performance_statistics'))
->set('ui.show.additional_queries', $form_state->getValue('ui_show_additional_queries'))
->save();
parent::submitForm($form, $form_state);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
BasicSettingsForm::$themeHandler | protected | property | The theme handler. | ||
BasicSettingsForm::buildForm | public | function | Form constructor. | Overrides ConfigFormBase::buildForm | |
BasicSettingsForm::create | public static | function | Instantiates a new instance of this class. | Overrides ConfigFormBase::create | |
BasicSettingsForm::getEditableConfigNames | protected | function | Gets the configuration names that will be editable. | Overrides ConfigFormBaseTrait::getEditableConfigNames | |
BasicSettingsForm::getFormId | public | function | Returns a unique string identifying the form. | Overrides FormInterface::getFormId | |
BasicSettingsForm::submitForm | public | function | Form submission handler. | Overrides ConfigFormBase::submitForm | |
BasicSettingsForm::__construct | public | function | Constructs a \Drupal\views_ui\Form\BasicSettingsForm object. | Overrides ConfigFormBase::__construct | |
ConfigFormBaseTrait::config | protected | function | Retrieves a configuration object. | ||
DependencySerializationTrait::$_entityStorages | protected | property | |||
DependencySerializationTrait::$_serviceIds | protected | property | |||
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. | ||
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 |
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. | 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. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.