You are here

Home » API reference » Layout Builder Modal 8 » LayoutBuilderModalSettingsForm.php

class LayoutBuilderModalSettingsForm in Layout Builder Modal 8

Provides the layout builder modal configuration form.

Hierarchy

Expanded class hierarchy of LayoutBuilderModalSettingsForm

1 string reference to 'LayoutBuilderModalSettingsForm'
layout_builder_modal.routing.yml in ./layout_builder_modal.routing.yml
layout_builder_modal.routing.yml

File

src/Form/LayoutBuilderModalSettingsForm.php, line 11

Namespace

Drupal\layout_builder_modal\Form
View source 
class LayoutBuilderModalSettingsForm extends ConfigFormBase {

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'layout_builder_modal_settings';
  }

  /**
   * {@inheritdoc}
   */
  public function getEditableConfigNames() {
    return [
      'layout_builder_modal.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this->configFactory
      ->get('layout_builder_modal.settings');
    $form['options'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Options'),
    ];
    $form['options']['modal_width'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Width'),
      '#default_value' => $config
        ->get('modal_width'),
      '#description' => $this
        ->t('Width in pixels with no units (e.g. "<code>768</code>"). See <a href=":link">the jQuery Dialog documentation</a> for more details.', [
        ':link' => 'https://api.jqueryui.com/dialog/#option-width',
      ]),
      '#min' => 1,
      '#required' => TRUE,
    ];
    $form['options']['modal_height'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Height'),
      '#default_value' => $config
        ->get('modal_height'),
      '#description' => $this
        ->t('Height in pixels with no units (e.g. "<code>768</code>") or "auto" for automatic height. See <a href=":link">the jQuery Dialog documentation</a> for more details.', [
        ':link' => 'https://api.jqueryui.com/dialog/#option-height',
      ]),
      '#size' => 20,
      '#required' => TRUE,
    ];
    $form['options']['modal_autoresize'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Auto resize'),
      '#default_value' => $config
        ->get('modal_autoresize'),
      '#description' => $this
        ->t('Allow modal to automatically resize and enable scrolling for dialog content. If enabled, the ability to drag and resize the dialog will be disabled.'),
    ];
    $theme_config = \Drupal::config('system.theme');
    $theme_handler = \Drupal::service('theme_handler');
    $theme_options = [
      'default_theme' => $this
        ->t('Default (%default_theme)', [
        '%default_theme' => $theme_handler
          ->getName($theme_config
          ->get('default')),
      ]),
      'seven' => $this
        ->t("Administrative (Seven)"),
    ];
    $form['options']['theme_display'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Theme'),
      '#options' => $theme_options,
      '#default_value' => $config
        ->get('theme_display') ?? 'default_theme',
      '#description' => $this
        ->t('Choose whether the default theme should display on its own, or whether to add administrative form CSS.'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $height = $form_state
      ->getValue('modal_height');
    if ((!is_numeric($height) || $height < 1) && $height !== 'auto') {
      $form_state
        ->setErrorByName('modal_height', $this
        ->t('Height must be a positive number or "auto".'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('layout_builder_modal.settings')
      ->set('modal_width', $form_state
      ->getValue('modal_width'))
      ->set('modal_height', $form_state
      ->getValue('modal_height'))
      ->set('modal_autoresize', $form_state
      ->getValue('modal_autoresize'))
      ->set('theme_display', $form_state
      ->getValue('theme_display'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 13
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 11
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. 1
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. 1
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.
LayoutBuilderModalSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
LayoutBuilderModalSettingsForm::getEditableConfigNames public function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
LayoutBuilderModalSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
LayoutBuilderModalSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
LayoutBuilderModalSettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
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. 29
MessengerTrait::messenger public function Gets the messenger. 29
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. 1
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.