class WebformAdminConfigFormsForm in Webform 6.x

Same name and namespace in other branches

8.5 src/Form/AdminConfig/WebformAdminConfigFormsForm.php \Drupal\webform\Form\AdminConfig\WebformAdminConfigFormsForm

Configure webform admin settings for forms.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\webform\Form\AdminConfig\WebformAdminConfigBaseForm
    class \Drupal\webform\Form\AdminConfig\WebformAdminConfigFormsForm uses WebformEntityStorageTrait

Expanded class hierarchy of WebformAdminConfigFormsForm

1 string reference to 'WebformAdminConfigFormsForm'

webform.routing.yml in ./webform.routing.yml: webform.routing.yml

File

src/Form/AdminConfig/WebformAdminConfigFormsForm.php, line 19

Namespace

Drupal\webform\Form\AdminConfig

View source

class WebformAdminConfigFormsForm extends WebformAdminConfigBaseForm {
  use WebformEntityStorageTrait;

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The webform token manager.
   *
   * @var \Drupal\webform\WebformTokenManagerInterface
   */
  protected $tokenManager;

  /**
   * The webform third party settings manager.
   *
   * @var \Drupal\webform\WebformThirdPartySettingsManagerInterface
   */
  protected $thirdPartySettingsManager;

  /**
   * The webform add-ons manager.
   *
   * @var \Drupal\webform\WebformAddonsManagerInterface
   */
  protected $addonsManager;

  /**
   * The webform theme manager.
   *
   * @var \Drupal\webform\WebformThemeManagerInterface
   */
  protected $themeManager;

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

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $instance = parent::create($container);
    $instance->entityTypeManager = $container
      ->get('entity_type.manager');
    $instance->moduleHandler = $container
      ->get('module_handler');
    $instance->tokenManager = $container
      ->get('webform.token_manager');
    $instance->thirdPartySettingsManager = $container
      ->get('webform.third_party_settings_manager');
    $instance->addonsManager = $container
      ->get('webform.addons_manager');
    $instance->themeManager = $container
      ->get('webform.theme_manager');
    return $instance;
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('webform.settings');
    $settings = $config
      ->get('settings');

    // Forms overview settings.
    $t_args = [
      ':href' => Url::fromRoute('entity.webform.collection')
        ->toString(),
    ];
    $form['filter_settings'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Form overview settings'),
      '#open' => TRUE,
      '#tree' => TRUE,
    ];
    $form['filter_settings']['filter_category'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Filter webforms default category'),
      '#description' => $this
        ->t('Select the filter webforms default category selected on the <a href=":href">webform overview page</a>.', $t_args),
      '#options' => $this
        ->getWebformStorage()
        ->getCategories(FALSE),
      '#empty_option' => $this
        ->t('Show all webforms'),
      '#parents' => [
        'form',
        'filter_category',
      ],
      '#default_value' => $config
        ->get('form.filter_category'),
    ];
    $form['filter_settings']['filter_state'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Filter webforms default state'),
      '#description' => $this
        ->t('Select the filter webforms default state selected on the <a href=":href">webform overview page</a>.', $t_args),
      '#options' => [
        WebformInterface::STATUS_OPEN => $this
          ->t('Open'),
        WebformInterface::STATUS_CLOSED => $this
          ->t('Closed'),
        WebformInterface::STATUS_SCHEDULED => $this
          ->t('Scheduled'),
        WebformInterface::STATUS_ARCHIVED => $this
          ->t('Archived'),
      ],
      '#empty_option' => $this
        ->t('All'),
      '#parents' => [
        'form',
        'filter_state',
      ],
      '#default_value' => $config
        ->get('form.filter_state'),
    ];

    // Page settings.
    $form['page_settings'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Form URL path settings'),
      '#open' => TRUE,
      '#tree' => TRUE,
    ];
    $form['page_settings']['default_page_base_path'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Default base path for webform URLs'),
      '#description' => $this
        ->t('Leave blank to disable the automatic generation of URL aliases for all webforms.') . ' ' . $this
        ->t('The base path has to start with a slash and cannot end with a slash.'),
      '#pattern' => '^/.+(?<!/)$',
      '#default_value' => $settings['default_page_base_path'],
    ];
    $form['page_settings']['default_page_base_path_message'] = [
      '#type' => 'webform_message',
      '#message_message' => $this
        ->t('All URL aliases for all webforms have to be manually created.'),
      '#message_type' => 'warning',
      '#states' => [
        'visible' => [
          ':input[name="page_settings[default_page_base_path]"]' => [
            'empty' => TRUE,
          ],
        ],
      ],
    ];

    // Form settings.
    $form['form_settings'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Form general settings'),
      '#open' => TRUE,
      '#tree' => TRUE,
    ];
    $form['form_settings']['default_status'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Default status'),
      '#default_value' => $settings['default_status'],
      '#options' => [
        WebformInterface::STATUS_OPEN => $this
          ->t('Open'),
        WebformInterface::STATUS_CLOSED => $this
          ->t('Closed'),
      ],
      '#options_display' => 'side_by_side',
    ];
    $form['form_settings']['default_form_open_message'] = [
      '#type' => 'webform_html_editor',
      '#title' => $this
        ->t('Default open message'),
      '#default_value' => $settings['default_form_open_message'],
    ];
    $form['form_settings']['default_form_close_message'] = [
      '#type' => 'webform_html_editor',
      '#title' => $this
        ->t('Default closed message'),
      '#default_value' => $settings['default_form_close_message'],
    ];
    $form['form_settings']['default_form_exception_message'] = [
      '#type' => 'webform_html_editor',
      '#title' => $this
        ->t('Default exception message'),
      '#required' => TRUE,
      '#default_value' => $settings['default_form_exception_message'],
    ];
    $form['form_settings']['default_form_confidential_message'] = [
      '#type' => 'webform_html_editor',
      '#title' => $this
        ->t('Default confidential message'),
      '#required' => TRUE,
      '#default_value' => $settings['default_form_confidential_message'],
    ];
    $form['form_settings']['default_form_access_denied_message'] = [
      '#type' => 'webform_html_editor',
      '#title' => $this
        ->t('Default access denied message'),
      '#required' => TRUE,
      '#default_value' => $settings['default_form_access_denied_message'],
    ];
    $form['form_settings']['default_form_required_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Default required indicator label'),
      '#required' => TRUE,
      '#size' => 20,
      '#default_value' => $settings['default_form_required_label'],
    ];
    $form['form_settings']['default_submit_button_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Default submit button label'),
      '#required' => TRUE,
      '#size' => 20,
      '#default_value' => $settings['default_submit_button_label'],
    ];
    $form['form_settings']['default_reset_button_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Default reset button label'),
      '#required' => TRUE,
      '#size' => 20,
      '#default_value' => $settings['default_reset_button_label'],
    ];
    $form['form_settings']['default_delete_button_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Default delete button label'),
      '#required' => TRUE,
      '#size' => 20,
      '#default_value' => $settings['default_delete_button_label'],
    ];
    $form['form_settings']['form_classes'] = [
      '#type' => 'webform_codemirror',
      '#title' => $this
        ->t('Form CSS classes'),
      '#description' => $this
        ->t('A list of classes that will be provided in the "Form CSS classes" dropdown. Enter one or more classes on each line. These styles should be available in your theme\'s CSS file.'),
      '#default_value' => $settings['form_classes'],
    ];
    $form['form_settings']['button_classes'] = [
      '#type' => 'webform_codemirror',
      '#title' => $this
        ->t('Button CSS classes'),
      '#description' => $this
        ->t('A list of classes that will be provided in "Button CSS classes" dropdown. Enter one or more classes on each line. These styles should be available in your theme\'s CSS file.'),
      '#default_value' => $settings['button_classes'],
    ];
    $form['form_settings']['token_tree_link'] = $this->tokenManager
      ->buildTreeElement();

    // Form Behaviors.
    $form['form_behaviors'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Form behaviors'),
      '#open' => TRUE,
      '#tree' => TRUE,
    ];
    $behavior_elements = [
      // Form.
      'default_form_submit_once' => [
        'group' => $this
          ->t('Form'),
        'title' => $this
          ->t('Prevent duplicate submissions for all webforms'),
        'description' => $this
          ->t('If checked, the submit button will be disabled immediately after it is clicked.'),
      ],
      // Navigation.
      'default_form_disable_back' => [
        'group' => $this
          ->t('Navigation'),
        'title' => $this
          ->t('Disable back button for all webforms'),
        'description' => $this
          ->t("If checked, users will not be allowed to navigate back to the webform using the browser's back button."),
      ],
      'default_form_submit_back' => [
        'group' => $this
          ->t('Navigation'),
        'title' => $this
          ->t('Submit previous page when browser back button is clicked for all webforms'),
        'description' => $this
          ->t("If checked, the browser back button will submit the previous page and navigate back emulating the behaviour of user clicking a wizard or preview page's back button."),
      ],
      'default_form_unsaved' => [
        'group' => $this
          ->t('Navigation'),
        'title' => $this
          ->t('Warn users about unsaved changes for all webforms'),
        'description' => $this
          ->t('If checked, users will be displayed a warning message when they navigate away from a webform with unsaved changes.'),
      ],
      // Validation.
      'default_form_novalidate' => [
        'group' => $this
          ->t('Validation'),
        'title' => $this
          ->t('Disable client-side validation for all webforms'),
        'description' => $this
          ->t('If checked, the <a href=":href">novalidate</a> attribute, which disables client-side validation, will be added to all webforms.', [
          ':href' => 'https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form',
        ]),
      ],
      'default_form_disable_inline_errors' => [
        'group' => $this
          ->t('Validation'),
        'title' => $this
          ->t('Disable inline form errors for all webforms'),
        'description' => $this
          ->t('If checked, <a href=":href">inline form errors</a>  will be disabled for all webforms.', [
          ':href' => 'https://www.drupal.org/docs/8/core/modules/inline-form-errors/inline-form-errors-module-overview',
        ]),
        'access' => $this->moduleHandler
          ->moduleExists('inline_form_errors'),
      ],
      'default_form_required' => [
        'group' => $this
          ->t('Validation'),
        'title' => $this
          ->t('Display required indicator on all webforms'),
        'description' => $this
          ->t('If checked, a required elements indicator will be added to all webforms.'),
      ],
      // Elements.
      'default_form_details_toggle' => [
        'group' => $this
          ->t('Elements'),
        'title' => $this
          ->t('Display collapse/expand all details link on all webforms'),
        'description' => $this
          ->t('If checked, an expand/collapse all details link will be added to all webforms which contain two or more details elements.'),
      ],
    ];
    foreach ($behavior_elements as $behavior_key => $behavior_element) {

      // Add group.
      if (isset($behavior_element['group'])) {
        $group = (string) $behavior_element['group'];
        if (!isset($form['form_behaviors'][$group])) {
          $form['form_behaviors'][$group] = [
            '#markup' => $group,
            '#prefix' => '<div><strong>',
            '#suffix' => '</strong></div>',
          ];
        }
      }

      // Add behavior checkbox.
      $form['form_behaviors'][$behavior_key] = [
        '#type' => 'checkbox',
        '#title' => $behavior_element['title'],
        '#description' => $behavior_element['description'],
        '#return_value' => TRUE,
        '#default_value' => $settings[$behavior_key],
      ];
      if (isset($behavior_element['access'])) {
        $form['form_behaviors'][$behavior_key]['#access'] = $behavior_element['access'];
      }
    }

    // Wizard settings.
    $form['wizard_settings'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Form wizard settings'),
      '#open' => TRUE,
      '#tree' => TRUE,
    ];
    $form['wizard_settings']['default_wizard_prev_button_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Default wizard previous page button label'),
      '#required' => TRUE,
      '#size' => 20,
      '#default_value' => $settings['default_wizard_prev_button_label'],
    ];
    $form['wizard_settings']['default_wizard_next_button_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Default wizard next page button label'),
      '#required' => TRUE,
      '#size' => 20,
      '#default_value' => $settings['default_wizard_next_button_label'],
    ];
    $form['wizard_settings']['default_wizard_start_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Default wizard start label'),
      '#required' => TRUE,
      '#size' => 20,
      '#default_value' => $settings['default_wizard_start_label'],
    ];
    $form['wizard_settings']['default_wizard_confirmation_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Default wizard end label'),
      '#required' => TRUE,
      '#size' => 20,
      '#default_value' => $settings['default_wizard_confirmation_label'],
    ];
    $form['wizard_settings']['default_wizard_toggle_show_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Default wizard show all elements label'),
      '#required' => TRUE,
      '#size' => 20,
      '#default_value' => $settings['default_wizard_toggle_show_label'],
    ];
    $form['wizard_settings']['default_wizard_toggle_hide_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Default wizard hide all elements label'),
      '#required' => TRUE,
      '#size' => 20,
      '#default_value' => $settings['default_wizard_toggle_hide_label'],
    ];

    // Preview settings.
    $form['preview_settings'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Form preview settings'),
      '#open' => TRUE,
      '#tree' => TRUE,
    ];
    $form['preview_settings']['default_preview_next_button_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Default preview button label'),
      '#required' => TRUE,
      '#size' => 20,
      '#default_value' => $settings['default_preview_next_button_label'],
    ];
    $form['preview_settings']['default_preview_prev_button_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Default preview previous page button label'),
      '#required' => TRUE,
      '#size' => 20,
      '#default_value' => $settings['default_preview_prev_button_label'],
    ];
    $form['preview_settings']['default_preview_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Default preview label'),
      '#required' => TRUE,
      '#default_value' => $settings['default_preview_label'],
    ];
    $form['preview_settings']['default_preview_title'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Default preview page title'),
      '#required' => TRUE,
      '#default_value' => $settings['default_preview_title'],
    ];
    $form['preview_settings']['default_preview_message'] = [
      '#type' => 'webform_html_editor',
      '#title' => $this
        ->t('Default preview message'),
      '#description' => $this
        ->t('Leave blank to not automatically include a preview message on all forms.'),
      '#default_value' => $settings['default_preview_message'],
    ];
    $form['preview_settings']['preview_classes'] = [
      '#type' => 'webform_codemirror',
      '#title' => $this
        ->t('Preview CSS classes'),
      '#description' => $this
        ->t('A list of classes that will be provided in the "Preview CSS classes" dropdown. Enter one or more classes on each line. These styles should be available in your theme\'s CSS file.'),
      '#default_value' => $config
        ->get('settings.preview_classes'),
    ];
    $form['preview_settings']['token_tree_link'] = $this->tokenManager
      ->buildTreeElement();

    // Confirmation settings.
    $form['confirmation_settings'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Form confirmation settings'),
      '#open' => TRUE,
      '#tree' => TRUE,
    ];
    $form['confirmation_settings']['default_confirmation_message'] = [
      '#type' => 'webform_html_editor',
      '#title' => $this
        ->t('Default confirmation message'),
      '#default_value' => $settings['default_confirmation_message'],
    ];
    $form['confirmation_settings']['default_confirmation_back_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Default confirmation back label'),
      '#required' => TRUE,
      '#default_value' => $settings['default_confirmation_back_label'],
    ];
    $form['confirmation_settings']['confirmation_classes'] = [
      '#type' => 'webform_codemirror',
      '#title' => $this
        ->t('Confirmation CSS classes'),
      '#description' => $this
        ->t('A list of classes that will be provided in the "Confirmation CSS classes" dropdown. Enter one or more classes on each line. These styles should be available in your theme\'s CSS file.'),
      '#default_value' => $settings['confirmation_classes'],
    ];
    $form['confirmation_settings']['confirmation_back_classes'] = [
      '#type' => 'webform_codemirror',
      '#title' => $this
        ->t('Confirmation back link CSS classes'),
      '#description' => $this
        ->t('A list of classes that will be provided in the "Confirmation back link CSS classes" dropdown. Enter one or more classes on each line. These styles should be available in your theme\'s CSS file.'),
      '#default_value' => $settings['confirmation_back_classes'],
    ];
    $form['confirmation_settings']['token_tree_link'] = $this->tokenManager
      ->buildTreeElement();

    // Ajax settings.
    $form['ajax_settings'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Form Ajax settings'),
      '#open' => TRUE,
      '#tree' => TRUE,
    ];
    $form['ajax_settings']['default_ajax'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Use Ajax for all webforms'),
      '#description' => $this
        ->t('If checked, paging, saving of drafts, previews, submissions, and confirmations will not initiate a page refresh on all webforms.'),
      '#return_value' => TRUE,
      '#default_value' => $settings['default_ajax'],
    ];
    $form['ajax_settings']['default_ajax_progress_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Default Ajax progress type'),
      '#description' => $this
        ->t("Select the default progress indicator displayed when Ajax is triggered."),
      '#options' => [
        'throbber' => $this
          ->t('Throbber'),
        'fullscreen' => $this
          ->t('Full screen'),
      ],
      '#default_value' => $settings['default_ajax_progress_type'],
      '#required' => TRUE,
    ];
    $form['ajax_settings']['default_ajax_effect'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Default Ajax effect'),
      '#description' => $this
        ->t("Select the default effect displayed when Ajax is triggered."),
      '#options' => [
        'none' => $this
          ->t('None'),
        'fade' => $this
          ->t('Fade'),
        'slide' => $this
          ->t('Slide'),
      ],
      '#default_value' => $settings['default_ajax_effect'],
      '#required' => TRUE,
    ];
    $form['ajax_settings']['default_ajax_speed'] = [
      '#type' => 'webform_select_other',
      '#title' => $this
        ->t('Default Ajax speed'),
      '#description' => $this
        ->t("Select the default effect speed."),
      '#other__type' => 'number',
      '#other__placeholder' => '',
      '#other__field_suffix' => $this
        ->t('milliseconds'),
      '#options' => [
        '500' => $this
          ->t('@number milliseconds', [
          '@number' => '500',
        ]),
        '1000' => $this
          ->t('@number milliseconds', [
          '@number' => '1000',
        ]),
        '1500' => $this
          ->t('@number milliseconds', [
          '@number' => '1500',
        ]),
      ],
      '#states' => [
        'visible' => [
          ':input[name="ajax_settings[default_ajax_effect]"]' => [
            '!value' => 'none',
          ],
        ],
      ],
      '#default_value' => $settings['default_ajax_speed'],
    ];

    // Share settings.
    $form['share_settings'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Form share settings'),
      '#open' => TRUE,
      '#tree' => TRUE,
      '#access' => $this->moduleHandler
        ->moduleExists('webform_share'),
    ];
    $form['share_settings']['default_share'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable form sharing'),
      '#description' => $this
        ->t('If checking, form sharing will be enabled for all webforms.'),
      '#return_value' => TRUE,
      '#default_value' => $settings['default_share'],
    ];
    $form['share_settings']['default_share_node'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable form sharing for webform nodes'),
      '#description' => $this
        ->t('If checking, form sharing will be enabled for all webform nodes.'),
      '#return_value' => TRUE,
      '#default_value' => $settings['default_share_node'],
      '#access' => $this->moduleHandler
        ->moduleExists('webform_node'),
    ];
    $form['share_settings']['default_share_theme_name'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Default shared form theme'),
      '#description' => $this
        ->t('Select the theme that will be used to render all shared webforms.'),
      '#options' => $this->themeManager
        ->getThemeNames(),
      '#default_value' => $settings['default_share_theme_name'],
    ];

    // Bulk operation settings.
    $form['bulk_form_settings'] = $this
      ->buildBulkOperations($settings, 'webform');

    // Dialog settings.
    $form['dialog_settings'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Form dialog settings'),
      '#open' => TRUE,
      '#tree' => TRUE,
    ];
    $form['dialog_settings']['dialog_options'] = [
      '#title' => $this
        ->t('Dialog options'),
      '#description' => [
        '#markup' => $this
          ->t('Enter preset dialog options available to all webforms.'),
        'options' => [
          '#theme' => 'item_list',
          '#items' => [
            $this
              ->t('Name must be lower-case and contain only letters, numbers, and underscores.'),
            $this
              ->t('Width and height are optional.'),
          ],
        ],
      ],
      '#type' => 'webform_multiple',
      '#key' => 'name',
      '#header' => [
        [
          'data' => $this
            ->t('Machine name'),
          'width' => '40%',
        ],
        [
          'data' => $this
            ->t('Title'),
          'width' => '40%',
        ],
        [
          'data' => $this
            ->t('Width'),
          'width' => '10%',
        ],
        [
          'data' => $this
            ->t('Height'),
          'width' => '10%',
        ],
      ],
      '#element' => [
        'name' => [
          '#type' => 'textfield',
          '#title' => $this
            ->t('Dialog machine name'),
          '#title_display' => 'invisible',
          '#placeholder' => $this
            ->t('Enter machine name…'),
          '#pattern' => '^[a-z0-9_]*$',
          '#error_no_message' => TRUE,
        ],
        'title' => [
          '#type' => 'textfield',
          '#title' => $this
            ->t('Dialog title'),
          '#placeholder' => $this
            ->t('Enter title…'),
          '#title_display' => 'invisible',
          '#error_no_message' => TRUE,
        ],
        'width' => [
          '#type' => 'number',
          '#title' => $this
            ->t('Dialog width'),
          '#title_display' => 'invisible',
          '#field_suffix' => 'px',
          '#error_no_message' => TRUE,
        ],
        'height' => [
          '#type' => 'number',
          '#title' => $this
            ->t('Dialog height'),
          '#title_display' => 'invisible',
          '#field_suffix' => 'px',
          '#error_no_message' => TRUE,
        ],
      ],
      '#error_no_message' => TRUE,
      '#default_value' => $settings['dialog_options'],
      '#parents' => [
        'dialog_settings',
        'dialog_options',
      ],
    ];
    $form['dialog_settings']['dialog'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable site-wide dialog support'),
      '#description' => $this
        ->t('If checked, the webform dialog library will be added to every page on your website, this allows any webform to be opened in a modal dialog.') . '<br /><br />' . $this
        ->t('Webform specific dialog links will be included on all webform settings form.'),
      '#return_value' => TRUE,
      '#default_value' => $settings['dialog'],
    ];
    $form['dialog_settings']['dialog_messages'] = [
      '#type' => 'container',
      '#states' => [
        'visible' => [
          ':input[name="dialog_settings[dialog]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];

    // Display warning when text formats do not support adding the class
    // attribute to links.
    if ($this->moduleHandler
      ->moduleExists('filter')) {

      /** @var \Drupal\filter\FilterFormatInterface[] $filter_formats */
      $filter_formats = FilterFormat::loadMultiple();
      $dialog_not_allowed = [];
      foreach ($filter_formats as $filter_format) {
        $html_restrictions = $filter_format
          ->getHtmlRestrictions();
        if ($html_restrictions && isset($html_restrictions['allowed']) && isset($html_restrictions['allowed']['a']) && !isset($html_restrictions['allowed']['a']['class'])) {
          $dialog_not_allowed[] = $filter_format
            ->label();
        }
      }
      if ($dialog_not_allowed) {
        $t_args = [
          '@labels' => WebformArrayHelper::toString($dialog_not_allowed),
          '@tag' => '<a href hreflang class>',
          ':href' => Url::fromRoute('filter.admin_overview')
            ->toString(),
        ];
        $form['dialog_settings']['dialog_messages']['filter_formats_message'] = [
          '#type' => 'webform_message',
          '#message_message' => $this
            ->t('<strong>IMPORTANT:</strong> To insert dialog links using the @labels <a href=":href">text formats</a> the @tag must be added to the allowed HTML tags.', $t_args),
          '#message_type' => 'warning',
        ];
      }
    }

    // Display install link module message.
    if (!$this->moduleHandler
      ->moduleExists('editor_advanced_link') && !$this->moduleHandler
      ->moduleExists('menu_link_attributes')) {
      $t_args = [
        ':editor_advanced_link_href' => 'https://www.drupal.org/project/editor_advanced_link',
        ':menu_link_attributes_href' => 'https://www.drupal.org/project/menu_link_attributes',
      ];
      $form['dialog_settings']['dialog_messages']['module_message'] = [
        '#type' => 'webform_message',
        '#message_message' => $this
          ->t('To add the .webform-dialog class to a link\'s attributes, please use the <a href=":editor_advanced_link_href">D8 Editor Advanced link</a> or <a href=":menu_link_attributes_href">Menu Link Attributes</a> modules.', $t_args),
        '#message_type' => 'info',
        '#message_close' => TRUE,
        '#message_storage' => WebformMessage::STORAGE_SESSION,
      ];
    }

    // Third party settings.
    $form['third_party_settings'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Third party settings'),
      '#description' => $this
        ->t('Third party settings allow contrib and custom modules to define global settings that are applied to all webforms and submissions.'),
      '#open' => TRUE,
      '#tree' => TRUE,
    ];
    $this->thirdPartySettingsManager
      ->alter('webform_admin_third_party_settings_form', $form, $form_state);
    if (!Element::children($form['third_party_settings'])) {
      $form['third_party_settings']['message'] = [
        '#type' => 'webform_message',
        '#message_message' => $this
          ->t('There are no third party settings available. Please install a contributed module that integrates with the Webform module.'),
        '#message_type' => 'info',
      ];
      $form['third_party_settings']['supported'] = [
        'title' => [
          '#markup' => $this
            ->t('Supported modules'),
          '#prefix' => '<h3>',
          '#suffix' => '</h3>',
        ],
        'modules' => [
          '#theme' => 'admin_block_content',
          '#content' => $this->addonsManager
            ->getThirdPartySettings(),
        ],
      ];
    }
    else {
      ksort($form['third_party_settings']);
    }
    $this->tokenManager
      ->elementValidate($form);
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $settings = $form_state
      ->getValue('page_settings') + $form_state
      ->getValue('form_settings') + $form_state
      ->getValue('form_behaviors') + $form_state
      ->getValue('wizard_settings') + $form_state
      ->getValue('preview_settings') + $form_state
      ->getValue('confirmation_settings') + $form_state
      ->getValue('share_settings') + $form_state
      ->getValue('ajax_settings') + $form_state
      ->getValue('bulk_form_settings') + $form_state
      ->getValue('dialog_settings');

    // Track if we need to trigger an update of all webform paths
    // because the 'default_page_base_path' changed.
    $update_paths = $settings['default_page_base_path'] !== $this
      ->config('webform.settings')
      ->get('settings.default_page_base_path') ? TRUE : FALSE;

    // Filter empty dialog options.
    foreach ($settings['dialog_options'] as $dialog_name => $dialog_options) {
      $settings['dialog_options'][$dialog_name] = array_filter($dialog_options);
    }

    // Update config and submit form.
    $config = $this
      ->config('webform.settings');
    $config
      ->set('settings', $settings + $config
      ->get('settings'));
    $config
      ->set('form', $form_state
      ->getValue('form') ?: []);
    $config
      ->set('third_party_settings', $form_state
      ->getValue('third_party_settings') ?: []);
    parent::submitForm($form, $form_state);

    /* Update paths */
    if ($update_paths) {

      /** @var \Drupal\webform\WebformInterface[] $webforms */
      $webforms = Webform::loadMultiple();
      foreach ($webforms as $webform) {
        $webform
          ->updatePaths();
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBase::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object.	16
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
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	72
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.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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.	4
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.
WebformAdminConfigBaseForm::buildBulkOperations	protected	function	Build bulk operation settings for webforms and submissions.
WebformAdminConfigBaseForm::buildExcludedPlugins	protected	function	Build excluded plugins element.
WebformAdminConfigBaseForm::convertIncludedToExcludedPluginIds	protected	function	Convert included ids returned from table select element to excluded ids.
WebformAdminConfigBaseForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
WebformAdminConfigBaseForm::getPluginDefinitions	protected	function	Get plugin definitions.
WebformAdminConfigBaseForm::validateBulkFormActions	public static	function	Form API callback. Validate bulk form actions.
WebformAdminConfigFormsForm::$addonsManager	protected	property	The webform add-ons manager.
WebformAdminConfigFormsForm::$moduleHandler	protected	property	The module handler.
WebformAdminConfigFormsForm::$themeManager	protected	property	The webform theme manager.
WebformAdminConfigFormsForm::$thirdPartySettingsManager	protected	property	The webform third party settings manager.
WebformAdminConfigFormsForm::$tokenManager	protected	property	The webform token manager.
WebformAdminConfigFormsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
WebformAdminConfigFormsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
WebformAdminConfigFormsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
WebformAdminConfigFormsForm::submitForm	public	function	Form submission handler. Overrides WebformAdminConfigBaseForm::submitForm
WebformEntityStorageTrait::$entityStorageToTypeMappings	protected	property	An associate array of entity type storage aliases.
WebformEntityStorageTrait::$entityTypeManager	protected	property	The entity type manager.	5
WebformEntityStorageTrait::getEntityStorage	protected	function	Retrieves the entity storage.
WebformEntityStorageTrait::getSubmissionStorage	protected	function	Retrieves the webform submission storage.
WebformEntityStorageTrait::getWebformStorage	protected	function	Retrieves the webform storage.
WebformEntityStorageTrait::__get	public	function	Implements the magic __get() method.

You are here

class WebformAdminConfigFormsForm in Webform 6.x

Hierarchy

File

Namespace

Members

API Navigation