public function WebformEntitySettingsGeneralForm::form in Webform 6.x

Same name and namespace in other branches
8.5 src/EntitySettings/WebformEntitySettingsGeneralForm.php \Drupal\webform\EntitySettings\WebformEntitySettingsGeneralForm::form()
Gets the actual form array to be built.
Overrides WebformEntitySettingsBaseForm::form
Code

public function form(array $form, FormStateInterface $form_state) {

  /** @var \Drupal\webform\WebformInterface $webform */
  $webform = $this->entity;

  // Set message manager's webform.
  $this->messageManager
    ->setWebform($webform);
  $default_settings = $this
    ->config('webform.settings')
    ->get('settings');
  $settings = $webform
    ->getSettings();

  // General settings.
  $form['general_settings'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('General settings'),
    '#open' => TRUE,
  ];
  $form['general_settings']['id'] = [
    '#type' => 'item',
    '#title' => $this
      ->t('ID'),
    '#markup' => $webform
      ->id(),
    '#value' => $webform
      ->id(),
  ];
  $form['general_settings']['title'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Title'),
    '#maxlength' => 255,
    '#default_value' => $webform
      ->label(),
    '#required' => TRUE,
    '#id' => 'title',
  ];
  $form['general_settings']['description'] = [
    '#type' => 'webform_html_editor',
    '#title' => $this
      ->t('Administrative description'),
    '#default_value' => $webform
      ->get('description'),
  ];

  /** @var \Drupal\webform\WebformEntityStorageInterface $webform_storage */
  $webform_storage = $this->entityTypeManager
    ->getStorage('webform');
  $form['general_settings']['category'] = [
    '#type' => 'webform_select_other',
    '#title' => $this
      ->t('Category'),
    '#options' => $webform_storage
      ->getCategories(),
    '#empty_option' => $this
      ->t('- None -'),
    '#default_value' => $webform
      ->get('category'),
  ];
  $form['general_settings']['template'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Allow this webform to be used as a template'),
    '#description' => $this
      ->t('If checked, this webform will be available as a template to all users who can create new webforms.'),
    '#return_value' => TRUE,
    '#access' => $this->moduleHandler
      ->moduleExists('webform_templates'),
    '#default_value' => $webform
      ->isTemplate(),
  ];
  $form['general_settings']['archive'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Archive this webform'),
    '#description' => $this
      ->t('If checked, this webform will be closed and unavailable to webform blocks and fields.'),
    '#return_value' => TRUE,
    '#default_value' => $webform
      ->isArchived(),
  ];
  $form['general_settings']['results_disabled'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Disable saving of submissions'),
    '#description' => $this
      ->t('If saving of submissions is disabled, submission settings, submission limits, purging and the saving of drafts will be disabled. Submissions must be sent via an email or processed using a custom <a href=":href">webform handler</a>.', [
      ':href' => Url::fromRoute('entity.webform.handlers', [
        'webform' => $webform
          ->id(),
      ])
        ->toString(),
    ]),
    '#return_value' => TRUE,
    '#default_value' => $settings['results_disabled'],
  ];

  // Display warning when submission handler requires submissions to be saved
  // to the database.
  $is_submission_required = $webform
    ->getHandlers(NULL, TRUE, NULL, WebformHandlerInterface::SUBMISSION_REQUIRED)
    ->count();
  if ($is_submission_required) {
    $form['general_settings']['results_disabled']['#default_value'] = FALSE;
    $form['general_settings']['results_disabled']['#disabled'] = TRUE;
    unset($form['general_settings']['results_disabled']['#description']);
    $form['general_settings']['results_disabled_required'] = [
      '#type' => 'webform_message',
      '#message_type' => 'warning',
      '#message_message' => $this->messageManager
        ->get(WebformMessageManagerInterface::HANDLER_SUBMISSION_REQUIRED),
    ];
  }

  // Display warning when disabling the saving of submissions with no
  // handlers.
  $is_results_processed = $webform
    ->getHandlers(NULL, TRUE, WebformHandlerInterface::RESULTS_PROCESSED)
    ->count();
  if (!$is_results_processed) {
    $form['general_settings']['results_disabled_error'] = [
      '#type' => 'webform_message',
      '#message_type' => 'warning',
      '#message_message' => $this->messageManager
        ->get(WebformMessageManagerInterface::FORM_SAVE_EXCEPTION),
      '#states' => [
        'visible' => [
          ':input[name="results_disabled"]' => [
            'checked' => TRUE,
          ],
          ':input[name="results_disabled_ignore"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    $form['general_settings']['results_disabled_ignore'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Ignore disabled results warning'),
      '#description' => $this
        ->t("If checked, all warnings and log messages about 'This webform is currently not saving any submitted data.' will be suppressed."),
      '#return_value' => TRUE,
      '#default_value' => $settings['results_disabled_ignore'],
      '#states' => [
        'visible' => [
          ':input[name="results_disabled"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
  }

  // Page settings.
  $form['page_settings'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('URL path settings'),
    '#open' => TRUE,
  ];
  $default_page_base_path = $default_settings['default_page_base_path'];
  if ($default_page_base_path) {
    $default_page_submit_path = $default_page_base_path . '/' . str_replace('_', '-', $webform
      ->id());
    $default_settings['default_page_submit_path'] = $default_page_submit_path;
    $default_settings['default_page_confirm_path'] = $default_page_submit_path . '/confirmation';
    $form_state
      ->set('default_settings', $default_settings);
  }
  $t_args = [
    ':node_href' => $this->moduleHandler
      ->moduleExists('node') ? Url::fromRoute('node.add', [
      'node_type' => 'webform',
    ])
      ->toString() : '',
    ':block_href' => $this->moduleHandler
      ->moduleExists('block') ? Url::fromRoute('block.admin_display')
      ->toString() : '',
    ':view_href' => $webform
      ->toUrl()
      ->toString(),
    ':test_href' => $webform
      ->toUrl('test-form')
      ->toString(),
  ];
  $form['page_settings']['page'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Allow users to post submissions from a dedicated URL'),
    '#description' => $this
      ->t('If unchecked, this webform must be attached to a <a href=":node_href">node</a> or a <a href=":block_href">block</a> to receive submissions.', $t_args),
    '#return_value' => TRUE,
    '#default_value' => $settings['page'],
  ];
  if ($this->moduleHandler
    ->moduleExists('path') && $settings['page']) {
    $t_args[':path_alias'] = Url::fromRoute('entity.path_alias.collection')
      ->toString();
    $form['page_settings']['page_message_warning'] = [
      '#type' => 'webform_message',
      '#message_type' => 'warning',
      '#message_message' => $this
        ->t('Unchecking this box will delete ALL aliases you may have created for this form via the <a href=":path_alias">path</a> module.', $t_args),
      '#states' => [
        'visible' => [
          ':input[name="page"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
  }
  $form['page_settings']['page_message'] = [
    '#type' => 'webform_message',
    '#message_type' => 'warning',
    '#message_message' => $this
      ->t('Any user who can update this webform will still be able to <a href=":view_href">view</a> and <a href=":test_href">test</a> this webform with the administrative theme.', $t_args),
    '#states' => [
      'visible' => [
        ':input[name="page"]' => [
          'checked' => FALSE,
        ],
      ],
    ],
  ];
  if ($this->moduleHandler
    ->moduleExists('path')) {
    $t_args[':path_alias'] = Url::fromRoute('entity.path_alias.collection')
      ->toString();
    $form['page_settings']['page_submit_path'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Webform URL alias'),
      '#description' => $this
        ->t('Optionally specify an alternative URL by which the webform submit page can be accessed. Any value entered here will overwrite ALL aliases you may have created for this form via the <a href=":path_alias">path</a> module.', $t_args) . ' ' . $this
        ->t('The URL alias has to start with a slash and cannot end with a slash.'),
      '#pattern' => '^/.+(?<!/)$',
      '#default_value' => $settings['page_submit_path'],
      '#states' => [
        'visible' => [
          ':input[name="page"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['page_settings']['page_confirm_path'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Confirmation page URL alias'),
      '#description' => $this
        ->t('Optionally specify an alternative URL by which the webform confirmation page can be accessed.', $t_args) . ' ' . $this
        ->t('The URL alias has to start with a slash and cannot end with a slash.'),
      '#pattern' => '^/.+(?<!/)$',
      '#default_value' => $settings['page_confirm_path'],
      '#states' => [
        'visible' => [
          ':input[name="page"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
  }
  $form['page_settings']['page_theme_name'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Page theme'),
    '#description' => $this
      ->t('Select the theme that will be used when the webform is displayed as a page with a dedicated URL.'),
    '#options' => $this->themeManager
      ->getThemeNames(),
    '#default_value' => $settings['page_theme_name'],
    '#states' => [
      'visible' => [
        ':input[name="page"]' => [
          'checked' => TRUE,
        ],
      ],
    ],
  ];

  // Ajax settings.
  $elements = $webform
    ->getElementsDecoded();
  $form['ajax_settings'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Ajax settings'),
    '#open' => TRUE,
    '#access' => empty($elements['#method']),
  ];
  $ajax_behaviors = [
    'ajax' => [
      'title' => $this
        ->t('Use Ajax'),
      'all_description' => $this
        ->t('Ajax is enabled for all forms.'),
      'form_description' => $this
        ->t('If checked, paging, saving of drafts, previews, submissions, and confirmations will not initiate a page refresh.'),
    ],
  ];
  $this
    ->appendBehaviors($form['ajax_settings'], $ajax_behaviors, $settings, $default_settings);
  $form['ajax_settings']['ajax_container'] = [
    '#type' => 'container',
    '#states' => [
      'visible' => [
        ':input[name="ajax"]' => [
          'checked' => TRUE,
        ],
      ],
    ],
  ];
  $form['ajax_settings']['ajax_container']['ajax_progress_type'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Ajax progress type'),
    '#description' => $this
      ->t("Select the progress indicator displayed when Ajax is triggered."),
    '#options' => [
      '' => '',
      'throbber' => $this
        ->t('Throbber'),
      'fullscreen' => $this
        ->t('Full screen'),
    ],
    '#default_value' => $settings['ajax_progress_type'],
  ];
  $form['ajax_settings']['ajax_container']['ajax_scroll_top'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('On Ajax load, scroll to the top of the…'),
    '#description' => $this
      ->t("Select where the page should be scrolled to when paging, saving of drafts, previews, submissions, and confirmations. Select 'None' to disable scrolling."),
    '#options' => [
      '' => $this
        ->t('None'),
      'form' => $this
        ->t('Form'),
      'page' => $this
        ->t('Page'),
    ],
    '#default_value' => $settings['ajax_scroll_top'],
    '#attributes' => [
      'data-webform-states-no-clear' => TRUE,
    ],
  ];
  $form['ajax_settings']['ajax_container']['ajax_effect'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Ajax effect'),
    '#description' => $this
      ->t("Select the effect displayed when Ajax is triggered."),
    '#options' => [
      '' => '',
      'none' => $this
        ->t('None'),
      'fade' => $this
        ->t('Fade'),
      'slide' => $this
        ->t('Slide'),
    ],
    '#default_value' => $settings['ajax_effect'],
  ];
  $form['ajax_settings']['ajax_container']['ajax_speed'] = [
    '#type' => 'webform_select_other',
    '#title' => $this
      ->t('Ajax speed'),
    '#description' => $this
      ->t("Select the 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_effect]"]' => [
          '!value' => 'none',
        ],
      ],
    ],
    '#default_value' => $settings['ajax_speed'],
  ];

  // Dialog settings.
  if ($default_settings['dialog']) {
    $rows = [];

    // Preset examples.
    foreach ($default_settings['dialog_options'] as $dialog_name => $dialog_options) {
      $dialog_options += [
        'width' => $this
          ->t('auto'),
        'height' => $this
          ->t('auto'),
      ];
      $dialog_link = [
        '#type' => 'link',
        '#url' => $webform
          ->toUrl(),
        '#title' => $this
          ->t('Test @title', [
          '@title' => $dialog_options['title'],
        ]),
        '#attributes' => [
          'class' => [
            'webform-dialog',
            'webform-dialog-' . $dialog_name,
            'button',
          ],
        ],
      ];
      $row = [];
      $row['title'] = $dialog_options['title'];
      $row['dimensions'] = $dialog_options['width'] . ' x ' . $dialog_options['height'];
      $row['link'] = [
        'data' => $dialog_link,
        'nowrap' => 'nowrap',
      ];
      $row['source'] = $this
        ->buildDialogSource($dialog_link);
      $rows[$dialog_name] = $row;
    }

    // Custom example.
    $dialog_link = [
      '#type' => 'link',
      '#title' => $this
        ->t('Test Custom'),
      '#url' => $webform
        ->toUrl(),
      '#attributes' => [
        'class' => [
          'webform-dialog',
          'button',
        ],
        'data-dialog-options' => Json::encode([
          'width' => 400,
          'height' => 400,
        ]),
      ],
    ];
    $row = [];
    $row['title'] = $this
      ->t('Custom');
    $row['dimensions'] = '400 x 400';
    $row['link'] = [
      'data' => $dialog_link,
    ];
    $row['source'] = $this
      ->buildDialogSource($dialog_link);
    $rows['custom'] = $row;
    $form['dialog_settings'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Dialog settings'),
      '#description' => $this
        ->t('Below are links and code snippets that can be inserted into your website to open this form in a modal dialog.'),
      '#open' => TRUE,
      'table' => [
        '#type' => 'table',
        '#header' => [
          [
            'data' => $this
              ->t('Title'),
            'width' => '10%',
            'class' => [
              RESPONSIVE_PRIORITY_LOW,
            ],
          ],
          [
            'data' => $this
              ->t('Dimensions'),
            'width' => '10%',
            'class' => [
              RESPONSIVE_PRIORITY_LOW,
            ],
          ],
          [
            'data' => $this
              ->t('Example'),
            'width' => '10%',
            'class' => [
              RESPONSIVE_PRIORITY_LOW,
            ],
          ],
          [
            'data' => $this
              ->t('Source'),
            'width' => '70%',
          ],
        ],
        '#rows' => $rows,
      ],
    ];
    $form['dialog_settings']['form_prepopulate_source_entity'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Allow (dialog) source entity to be populated using query string parameters'),
      '#description' => $this
        ->t("If checked, source entity can be populated using query string parameters.") . '<br/><br/>' . $this
        ->t("For example, appending <code>?source_entity_type=node&source_entity_id=1</code> to a webform's URL would set a submission's 'Submitted to' value to 'node:1'.") . '<br/><br/>' . $this
        ->t("You can also append <code>?source_entity_type=ENTITY_TYPE&amp;source_entity_id=ENTITY_ID</code> and the <code>ENTITY_TYPE</code> and <code>ENTITY_ID</code> parameters will automatically be replaced based on the current page's source entity."),
      '#return_value' => TRUE,
      '#default_value' => $settings['form_prepopulate_source_entity'],
    ];
  }
  if ($this
    ->currentUser()
    ->hasPermission('administer webform')) {

    // Author information.
    $form['author_information'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Author information'),
    ];
    $form['author_information']['uid'] = [
      '#type' => 'entity_autocomplete',
      '#title' => $this
        ->t('Authored by'),
      '#description' => $this
        ->t("The username of the webform author/owner."),
      '#target_type' => 'user',
      '#settings' => [
        'match_operator' => 'CONTAINS',
      ],
      '#selection_settings' => [
        'include_anonymous' => TRUE,
      ],
      '#default_value' => $webform
        ->getOwner(),
    ];
  }

  // Share settings.
  $form['share_settings'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Share settings'),
    '#open' => TRUE,
    '#access' => $this->moduleHandler
      ->moduleExists('webform_share'),
  ];
  $share_behaviors = [
    'share' => [
      'title' => $this
        ->t('Form sharing enabled'),
      'all_description' => $this
        ->t('Form sharing is enabled for all webforms.'),
      'form_description' => $this
        ->t('If checked, form sharing will be enabled for this webform.'),
    ],
    'share_node' => [
      'title' => $this
        ->t('Form sharing enabled for webform nodes'),
      'all_description' => $this
        ->t('Form sharing is enabled for all webforms node.'),
      'form_description' => $this
        ->t('If checked, form sharing will be enabled for webform nodes that use this webform.'),
      'access' => $this->moduleHandler
        ->moduleExists('webform_node'),
    ],
    'share_title' => [
      'title' => $this
        ->t('Display title on shared form'),
      'form_description' => $this
        ->t('If checked, the page title will displayed on this shared webform.'),
    ],
  ];
  $form['share_settings']['behaviors'] = [];
  $this
    ->appendBehaviors($form['share_settings']['behaviors'], $share_behaviors, $settings, $default_settings);
  $form['share_settings']['share_theme_name'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Shared form theme'),
    '#description' => $this
      ->t('Select the theme that will be used to render this shared webform.'),
    '#options' => $this->themeManager
      ->getThemeNames(),
    '#default_value' => $settings['share_theme_name'],
  ];
  $form['share_settings']['share_page_body_attributes_container'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Page body attributes'),
  ];
  $form['share_settings']['share_page_body_attributes_container']['share_page_body_attributes'] = [
    '#type' => 'webform_element_attributes',
    '#title' => $this
      ->t('Page body attributes'),
    '#default_value' => $settings['share_page_body_attributes'],
  ];

  // Advanced settings.
  $form['advanced_settings'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Advanced settings'),
    '#open' => TRUE,
    '#access' => $this->moduleHandler
      ->moduleExists('webform_node'),
  ];
  $form['advanced_settings']['weight'] = [
    '#type' => 'weight',
    '#title' => $this
      ->t('Weight'),
    '#description' => $this
      ->t('Weight is used when multiple webforms are associated to the same webform node.'),
    '#default_value' => $webform
      ->get('weight'),
    '#access' => $this->moduleHandler
      ->moduleExists('webform_node'),
  ];

  // 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 webform specific customization settings.'),
    '#tree' => TRUE,
  ];
  $this->thirdPartySettingsManager
    ->alter('webform_third_party_settings_form', $form, $form_state);
  if (!Element::children($form['third_party_settings'])) {
    $form['third_party_settings']['#access'] = FALSE;
  }
  else {
    ksort($form['third_party_settings']);
  }
  $form['#attached']['library'][] = 'webform/webform.admin.settings';
  return parent::form($form, $form_state);
}
You are here

public function WebformEntitySettingsGeneralForm::form in Webform 6.x

See also

File

Class

Namespace

Code

API Navigation
