class YamlFormEntitySettingsForm in YAML Form 8

Provides a form to manage settings.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
    • class \Drupal\yamlform\YamlFormEntitySettingsForm

File

src/YamlFormEntitySettingsForm.php, line 18

Namespace

Drupal\yamlform

class YamlFormEntitySettingsForm extends EntityForm {

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

  /**
   * The message manager.
   *
   * @var \Drupal\yamlform\YamlFormMessageManagerInterface
   */
  protected $messageManager;

  /**
   * The token manager.
   *
   * @var \Drupal\yamlform\YamlFormTranslationManagerInterface
   */
  protected $tokenManager;

  /**
   * Constructs a new YamlFormUiElementFormBase.
   *
   * @param \Drupal\Core\Session\AccountInterface $current_user
   *   The current user.
   * @param \Drupal\yamlform\YamlFormMessageManagerInterface $message_manager
   *   The message manager.
   * @param \Drupal\yamlform\YamlFormTokenManagerInterface $token_manager
   *   The token manager.
   */
  public function __construct(AccountInterface $current_user, YamlFormMessageManagerInterface $message_manager, YamlFormTokenManagerInterface $token_manager) {
    $this->currentUser = $current_user;
    $this->messageManager = $message_manager;
    $this->tokenManager = $token_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('current_user'), $container
      ->get('yamlform.message_manager'), $container
      ->get('yamlform.token_manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {

    /** @var \Drupal\yamlform\YamlFormInterface $yamlform */
    $yamlform = $this->entity;
    $default_settings = $this
      ->config('yamlform.settings')
      ->get('settings');
    $settings = $yamlform
      ->getSettings();

    // General.
    $form['general'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('General settings'),
      '#open' => TRUE,
    ];
    $form['general']['id'] = [
      '#type' => 'item',
      '#title' => $this
        ->t('ID'),
      '#markup' => $yamlform
        ->id(),
      '#value' => $yamlform
        ->id(),
    ];
    $form['general']['title'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Title'),
      '#maxlength' => 255,
      '#default_value' => $yamlform
        ->label(),
      '#required' => TRUE,
      '#id' => 'title',
    ];
    $form['general']['description'] = [
      '#type' => 'yamlform_html_editor',
      '#title' => $this
        ->t('Administrative description'),
      '#default_value' => $yamlform
        ->get('description'),
    ];
    $form['general']['template'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Allow this form to be used as a template.'),
      '#description' => $this
        ->t('If checked, this form will be available as a template to all users who can create new forms.'),
      '#access' => $this->moduleHandler
        ->moduleExists('yamlform_templates'),
      '#default_value' => $yamlform
        ->isTemplate(),
    ];
    $form['general']['results_disabled'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Disable saving of submissions.'),
      '#description' => $this
        ->t('If saving of submissions is disabled, submission settings, submission limits and the saving of drafts will be disabled.  Submissions must be sent via an email or handled using a custom <a href=":href">form handler</a>.', [
        ':href' => Url::fromRoute('entity.yamlform.handlers_form', [
          'yamlform' => $yamlform
            ->id(),
        ])
          ->toString(),
      ]),
      '#return_value' => TRUE,
      '#default_value' => $settings['results_disabled'],
    ];

    // Display warning when disabling the saving of submissions with no
    // handlers.
    if (!$yamlform
      ->getHandlers(NULL, TRUE, YamlFormHandlerInterface::RESULTS_PROCESSED)
      ->count()) {
      $this->messageManager
        ->setYamlForm($yamlform);
      $form['general']['results_disabled_error'] = [
        '#type' => 'yamlform_message',
        '#message_type' => 'warning',
        '#message_message' => $this->messageManager
          ->get(YamlFormMessageManagerInterface::FORM_SAVE_EXCEPTION),
        '#states' => [
          'visible' => [
            ':input[name="results_disabled"]' => [
              'checked' => TRUE,
            ],
            ':input[name="results_disabled_ignore"]' => [
              'checked' => FALSE,
            ],
          ],
        ],
      ];
      $form['general']['results_disabled_ignore'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Ignore disabled results warning'),
        '#description' => $this
          ->t("If checked, all warnings and log messages about 'This form 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.
    $form['page'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('URL path settings'),
      '#open' => TRUE,
    ];
    $default_page_submit_path = trim($default_settings['default_page_base_path'], '/') . '/' . str_replace('_', '-', $yamlform
      ->id());
    $t_args = [
      ':node_href' => Url::fromRoute('node.add', [
        'node_type' => 'yamlform',
      ])
        ->toString(),
      ':block_href' => Url::fromRoute('block.admin_display')
        ->toString(),
    ];
    $default_settings['default_page_submit_path'] = $default_page_submit_path;
    $default_settings['default_page_confirm_path'] = $default_page_submit_path . '/confirmation';
    $form['page']['page'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Allow users to post submission from a dedicated URL.'),
      '#description' => $this
        ->t('If unchecked, this form must be attached to a <a href=":node_href">node</a> or a <a href=":block_href">block</a> to receive submissions.', $t_args),
      '#default_value' => $settings['page'],
    ];
    if ($this->moduleHandler
      ->moduleExists('path')) {
      $form['page']['page_submit_path'] = [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Form URL alias'),
        '#description' => $this
          ->t('Optionally specify an alternative URL by which the form submit page can be accessed.', $t_args),
        '#default_value' => $settings['page_submit_path'],
        '#states' => [
          'visible' => [
            ':input[name="page"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ];
      $form['page']['page_confirm_path'] = [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Confirmation page URL alias'),
        '#description' => $this
          ->t('Optionally specify an alternative URL by which the form confirmation page can be accessed.', $t_args),
        '#default_value' => $settings['page_confirm_path'],
        '#states' => [
          'visible' => [
            ':input[name="page"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ];
    }

    // Form.
    $form['form'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Form settings'),
      '#open' => TRUE,
    ];
    $form['form']['status'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Form status'),
      '#default_value' => $yamlform
        ->get('status') == 1 ? 1 : 0,
      '#description' => $this
        ->t('Closing a form prevents any further submissions by any users, except submission administrators.'),
      '#options' => [
        1 => $this
          ->t('Open'),
        0 => $this
          ->t('Closed'),
      ],
      '#required' => TRUE,
      '#states' => [
        'visible' => [
          ':input[name="template"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    $form['form']['form_closed_message'] = [
      '#type' => 'yamlform_html_editor',
      '#title' => $this
        ->t('Form closed message'),
      '#description' => $this
        ->t('A message to be displayed notifying the user that the form is closed.'),
      '#default_value' => $settings['form_closed_message'],
    ];
    $form['form']['form_exception_message'] = [
      '#type' => 'yamlform_html_editor',
      '#title' => $this
        ->t('Form exception message'),
      '#description' => $this
        ->t('A message to be displayed if the form breaks.'),
      '#default_value' => $settings['form_exception_message'],
    ];
    $form['form']['form_submit'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Form submit button'),
    ];
    $form['form']['form_submit']['form_submit_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Form submit button label'),
      '#size' => 20,
      '#default_value' => $settings['form_submit_label'],
    ];
    $form['form']['form_submit']['form_submit_attributes'] = [
      '#type' => 'yamlform_element_attributes',
      '#title' => $this
        ->t('Form submit button'),
      '#classes' => $this->configFactory
        ->get('yamlform.settings')
        ->get('settings.button_classes'),
      '#default_value' => $settings['form_submit_attributes'],
    ];
    $form['form']['form_prepopulate'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Allow elements to be populated using query string parameters.'),
      '#description' => $this
        ->t("If checked, elements can be populated using query string parameters. For example, appending ?name=John+Smith to a form's URL would setting an the 'name' element's default value to 'John Smith'."),
      '#return_value' => TRUE,
      '#default_value' => $settings['form_prepopulate'],
    ];
    $form['form']['form_prepopulate_source_entity'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Allow source entity to be populated using query string parameters.'),
      '#description' => $this
        ->t("If checked, source entity can be populated using query string parameters. For example, appending ?source_entity_type=user&source_entity_id=1 to a form's URL would set a submission's 'Submitted to' value to '@user.", [
        '@user' => User::load(1)
          ->label(),
      ]),
      '#return_value' => TRUE,
      '#default_value' => $settings['form_prepopulate_source_entity'],
    ];
    $settings_elements = [
      'form_disable_back' => [
        'title' => $this
          ->t('Disable back button for all forms'),
        'all_description' => $this
          ->t('Back button is disabled for all forms.'),
        'form_description' => $this
          ->t('If checked, users will not be allowed to navigate back to the form using the browsers back button.'),
      ],
      'form_unsaved' => [
        'title' => $this
          ->t('Warn users about unsaved changes'),
        'all_description' => $this
          ->t('Unsaved warning is enabled for all forms.'),
        'form_description' => $this
          ->t('If checked, users will be displayed a warning message when they navigate away from a form with unsaved changes.'),
      ],
      'form_novalidate' => [
        'title' => $this
          ->t('Disable client-side validation'),
        'all_description' => $this
          ->t('Client-side validation is disabled for all forms.'),
        'form_description' => $this
          ->t('If checked, the <a href=":href">novalidate</a> attribute, which disables client-side validation, will be added to this form.', [
          ':href' => 'http://www.w3schools.com/tags/att_form_novalidate.asp',
        ]),
      ],
      'form_details_toggle' => [
        'title' => $this
          ->t('Display collapse/expand all details link'),
        'all_description' => $this
          ->t('Expand/collapse all (details) link is automatically added to all forms.'),
        'form_description' => $this
          ->t('If checked, an expand/collapse all (details) link will be added to this form when there are two or more details elements available on the form.'),
      ],
    ];
    foreach ($settings_elements as $settings_key => $setting_element) {
      if ($default_settings['default_' . $settings_key]) {
        $form['form'][$settings_key . '_disabled'] = [
          '#type' => 'checkbox',
          '#title' => $setting_element['title'],
          '#description' => $setting_element['all_description'],
          '#disabled' => TRUE,
          '#default_value' => TRUE,
        ];
        $form['form'][$settings_key] = [
          '#type' => 'value',
          '#value' => $settings[$settings_key],
        ];
      }
      else {
        $form['form'][$settings_key] = [
          '#type' => 'checkbox',
          '#title' => $setting_element['title'],
          '#description' => $setting_element['form_description'],
          '#return_value' => TRUE,
          '#default_value' => $settings[$settings_key],
        ];
      }
    }
    $form['form']['form_autofocus'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Autofocus'),
      '#description' => $this
        ->t('If checked, the first visible and enabled input will be focused when adding new submissions.'),
      '#return_value' => TRUE,
      '#default_value' => $settings['form_autofocus'],
    ];

    // Attributes.
    $elements = $yamlform
      ->getElementsDecoded();
    $form['attributes'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Form attributes'),
      '#open' => TRUE,
    ];
    $form['attributes']['attributes'] = [
      '#type' => 'yamlform_element_attributes',
      '#title' => $this
        ->t('Form'),
      '#classes' => $this->configFactory
        ->get('yamlform.settings')
        ->get('settings.form_classes'),
      '#default_value' => isset($elements['#attributes']) ? $elements['#attributes'] : [],
    ];

    // Wizard.
    $form['wizard'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Wizard settings'),
      '#open' => TRUE,
      '#states' => [
        'visible' => [
          ':input[name="method"]' => [
            'value' => '',
          ],
        ],
      ],
    ];
    $form['wizard']['wizard_progress_bar'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show wizard progress bar'),
      '#return_value' => TRUE,
      '#default_value' => $settings['wizard_progress_bar'],
    ];
    $form['wizard']['wizard_progress_pages'] = [
      '#type' => 'checkbox',
      '#return_value' => TRUE,
      '#title' => $this
        ->t('Show wizard progress pages'),
      '#default_value' => $settings['wizard_progress_pages'],
    ];
    $form['wizard']['wizard_progress_percentage'] = [
      '#type' => 'checkbox',
      '#return_value' => TRUE,
      '#title' => $this
        ->t('Show wizard progress percentage'),
      '#default_value' => $settings['wizard_progress_percentage'],
    ];
    $form['wizard']['wizard_prev_button'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Previous wizard page button'),
      '#description' => $this
        ->t('This is used for the previous page button within a wizard.'),
    ];
    $form['wizard']['wizard_prev_button']['wizard_prev_button_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Previous wizard page button label'),
      '#size' => 20,
      '#default_value' => $settings['wizard_prev_button_label'],
    ];
    $form['wizard']['wizard_prev_button']['wizard_prev_button_attributes'] = [
      '#type' => 'yamlform_element_attributes',
      '#title' => $this
        ->t('Previous wizard page button'),
      '#classes' => $this->configFactory
        ->get('yamlform.settings')
        ->get('settings.button_classes'),
      '#default_value' => $settings['wizard_prev_button_attributes'],
    ];
    $form['wizard']['wizard_next_button'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Next wizard page button'),
      '#description' => $this
        ->t('This is used for the next page button within a wizard.'),
    ];
    $form['wizard']['wizard_next_button']['wizard_next_button_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Next wizard page button label'),
      '#size' => 20,
      '#default_value' => $settings['wizard_next_button_label'],
    ];
    $form['wizard']['wizard_next_button']['wizard_next_button_attributes'] = [
      '#type' => 'yamlform_element_attributes',
      '#title' => $this
        ->t('Next wizard page button'),
      '#classes' => $this->configFactory
        ->get('yamlform.settings')
        ->get('settings.button_classes'),
      '#default_value' => $settings['wizard_next_button_attributes'],
    ];
    $form['wizard']['wizard_complete'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Include confirmation page in progress'),
      '#return_value' => TRUE,
      '#default_value' => $settings['wizard_complete'],
    ];
    $form['wizard']['wizard_start_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Wizard start label'),
      '#size' => 20,
      '#default_value' => $settings['wizard_start_label'],
    ];
    $form['wizard']['wizard_complete_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Wizard end label'),
      '#size' => 20,
      '#default_value' => $settings['wizard_complete_label'],
      '#states' => [
        'visible' => [
          ':input[name="wizard_complete"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];

    // Preview.
    $form['preview'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Preview settings'),
      '#open' => TRUE,
      '#states' => [
        'visible' => [
          ':input[name="method"]' => [
            'value' => '',
          ],
        ],
      ],
    ];
    $form['preview']['preview'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Enable preview page'),
      '#options' => [
        DRUPAL_DISABLED => $this
          ->t('Disabled'),
        DRUPAL_OPTIONAL => $this
          ->t('Optional'),
        DRUPAL_REQUIRED => $this
          ->t('Required'),
      ],
      '#description' => $this
        ->t('Add a page for previewing the form before submitting.'),
      '#default_value' => $settings['preview'],
    ];
    $form['preview']['settings'] = [
      '#type' => 'container',
      '#states' => [
        'invisible' => [
          ':input[name="preview"]' => [
            'value' => DRUPAL_DISABLED,
          ],
        ],
      ],
    ];

    // Preview next button.
    $form['preview']['settings']['preview_next_button'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Preview button'),
    ];
    $form['preview']['settings']['preview_next_button']['preview_next_button_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Preview button label'),
      '#description' => $this
        ->t('The text for the button that will proceed to the preview page.'),
      '#size' => 20,
      '#default_value' => $settings['preview_next_button_label'],
    ];
    $form['preview']['settings']['preview_next_button']['preview_next_button_attributes'] = [
      '#type' => 'yamlform_element_attributes',
      '#title' => $this
        ->t('Preview button'),
      '#classes' => $this->configFactory
        ->get('yamlform.settings')
        ->get('settings.button_classes'),
      '#default_value' => $settings['preview_next_button_attributes'],
    ];

    // Preview previous button.
    $form['preview']['settings']['preview_prev_button'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Previous page button'),
    ];
    $form['preview']['settings']['preview_prev_button']['preview_prev_button_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Previous page button label'),
      '#description' => $this
        ->t('The text for the button to go backwards from the preview page.'),
      '#size' => 20,
      '#default_value' => $settings['preview_prev_button_label'],
    ];
    $form['preview']['settings']['preview_prev_button']['preview_prev_button_attributes'] = [
      '#type' => 'yamlform_element_attributes',
      '#title' => $this
        ->t('Previous page button'),
      '#classes' => $this->configFactory
        ->get('yamlform.settings')
        ->get('settings.button_classes'),
      '#default_value' => $settings['preview_prev_button_attributes'],
    ];
    $form['preview']['settings']['preview_message'] = [
      '#type' => 'yamlform_html_editor',
      '#title' => $this
        ->t('Preview message'),
      '#description' => $this
        ->t('A message to be displayed on the preview page.'),
      '#default_value' => $settings['preview_message'],
    ];

    // Draft.
    $form['draft'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Draft settings'),
      '#open' => TRUE,
      '#states' => [
        'visible' => [
          ':input[name="results_disabled"]' => [
            'checked' => FALSE,
          ],
          ':input[name="method"]' => [
            'value' => '',
          ],
        ],
      ],
    ];
    $form['draft']['draft'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Allow your users to save and finish the form later.'),
      "#description" => $this
        ->t('This option is available only for authenticated users.'),
      '#return_value' => TRUE,
      '#default_value' => $settings['draft'],
    ];
    $form['draft']['settings'] = [
      '#type' => 'container',
      '#states' => [
        'visible' => [
          ':input[name="draft"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['draft']['settings']['draft_auto_save'] = [
      '#type' => 'checkbox',
      '#return_value' => TRUE,
      '#title' => $this
        ->t('Automatically save as draft when paging, previewing, and when there are validation errors.'),
      "#description" => $this
        ->t('Automatically save partial submissions when users click the "Preview" button or when validation errors prevent a form from being submitted.'),
      '#default_value' => $settings['draft_auto_save'],
    ];
    $form['draft']['settings']['draft_button'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Draft button'),
    ];
    $form['draft']['settings']['draft_button']['draft_button_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Draft button label'),
      '#description' => $this
        ->t('The text for the button that will save a draft.'),
      '#size' => 20,
      '#default_value' => $settings['draft_button_label'],
    ];
    $form['draft']['settings']['draft_button']['draft_button_attributes'] = [
      '#type' => 'yamlform_element_attributes',
      '#title' => $this
        ->t('Draft button'),
      '#classes' => $this->configFactory
        ->get('yamlform.settings')
        ->get('settings.button_classes'),
      '#default_value' => $settings['draft_button_attributes'],
    ];
    $form['draft']['settings']['draft_saved_message'] = [
      '#type' => 'yamlform_html_editor',
      '#title' => $this
        ->t('Draft saved message'),
      '#description' => $this
        ->t('Message to be displayed when a draft is saved.'),
      '#default_value' => $settings['draft_saved_message'],
    ];
    $form['draft']['settings']['draft_loaded_message'] = [
      '#type' => 'yamlform_html_editor',
      '#title' => $this
        ->t('Draft loaded message'),
      '#description' => $this
        ->t('Message to be displayed when a draft is loaded.'),
      '#default_value' => $settings['draft_loaded_message'],
    ];

    // Submission.
    $form['submission'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Submission settings'),
      '#open' => TRUE,
      '#states' => [
        'visible' => [
          ':input[name="results_disabled"]' => [
            'checked' => FALSE,
          ],
          ':input[name="method"]' => [
            'value' => '',
          ],
        ],
      ],
    ];
    $form['submission']['form_confidential'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Confidential submissions'),
      '#description' => $this
        ->t('Confidential submissions have no recorded IP address and must be submitted while logged out.'),
      '#return_value' => TRUE,
      '#default_value' => $settings['form_confidential'],
    ];
    $form['submission']['form_confidential_message'] = [
      '#type' => 'yamlform_html_editor',
      '#title' => $this
        ->t('Form confidential message'),
      '#description' => $this
        ->t('A message to be displayed when authenticated users try to access a confidential form.'),
      '#default_value' => $settings['form_confidential_message'],
      '#states' => [
        'visible' => [
          ':input[name="form_confidential"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['submission']['token_update'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Allow users to update a submission using a secure token.'),
      '#description' => $this
        ->t("If checked users will be able to update a submission using the form's URL appended with the submission's (secure) token.  The URL to update a submission will be available when viewing a submission's information and can be inserted into the an email using the [yamlform_submission:update-url] token."),
      '#return_value' => TRUE,
      '#default_value' => $settings['token_update'],
    ];
    $form['submission']['next_serial'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Next submission number'),
      '#description' => $this
        ->t('The value of the next submission number. This is usually 1 when you start and will go up with each form submission.'),
      '#min' => 1,
      '#default_value' => $yamlform
        ->getState('next_serial') ?: 1,
    ];

    // Limits.
    $form['limits'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Submission limits'),
      '#open' => TRUE,
      '#states' => [
        'visible' => [
          ':input[name="results_disabled"]' => [
            'checked' => FALSE,
          ],
          ':input[name="method"]' => [
            'value' => '',
          ],
        ],
      ],
    ];
    $form['limits']['limit_total'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Total submissions limit'),
      '#min' => 1,
      '#default_value' => $settings['limit_total'],
    ];
    $form['limits']['entity_limit_total'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Total submissions limit per entity'),
      '#min' => 1,
      '#default_value' => $settings['entity_limit_total'],
    ];
    $form['limits']['limit_total_message'] = [
      '#type' => 'yamlform_html_editor',
      '#title' => $this
        ->t('Total submissions limit message'),
      '#min' => 1,
      '#default_value' => $settings['limit_total_message'],
    ];
    $form['limits']['limit_user'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Per user submission limit'),
      '#min' => 1,
      '#default_value' => $settings['limit_user'],
    ];
    $form['limits']['entity_limit_user'] = [
      '#type' => 'number',
      '#min' => 1,
      '#title' => $this
        ->t('Per user submission limit per entity'),
      '#default_value' => $settings['entity_limit_user'],
    ];
    $form['limits']['limit_user_message'] = [
      '#type' => 'yamlform_html_editor',
      '#title' => $this
        ->t('Per user submission limit message'),
      '#default_value' => $settings['limit_user_message'],
    ];

    // Confirmation.
    $form['confirmation'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Confirmation settings'),
      '#open' => TRUE,
      '#states' => [
        'visible' => [
          ':input[name="method"]' => [
            'value' => '',
          ],
        ],
      ],
    ];
    $form['confirmation']['confirmation_type'] = [
      '#title' => $this
        ->t('Confirmation type'),
      '#type' => 'radios',
      '#options' => [
        'page' => $this
          ->t('Page (redirects to new page and displays the confirmation message)'),
        'inline' => $this
          ->t('Inline (reloads the current page and replaces the form with the confirmation message.)'),
        'message' => $this
          ->t('Message (reloads the current page/form and displays the confirmation message at the top of the page.)'),
        'url' => $this
          ->t('URL (redirects to a custom path or URL)'),
        'url_message' => $this
          ->t('URL with message (redirects to a custom path or URL and displays the confirmation message at the top of the page.)'),
      ],
      '#default_value' => $settings['confirmation_type'],
    ];
    $form['confirmation']['confirmation_url'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Confirmation URL'),
      '#description' => $this
        ->t('URL to redirect the user to upon successful submission.'),
      '#default_value' => $settings['confirmation_url'],
      '#maxlength' => NULL,
      '#states' => [
        'visible' => [
          [
            ':input[name="confirmation_type"]' => [
              'value' => 'url',
            ],
          ],
          'or',
          [
            ':input[name="confirmation_type"]' => [
              'value' => 'url_message',
            ],
          ],
        ],
      ],
    ];
    $form['confirmation']['confirmation_message'] = [
      '#type' => 'yamlform_html_editor',
      '#title' => $this
        ->t('Confirmation message'),
      '#description' => $this
        ->t('Message to be shown upon successful submission.'),
      '#default_value' => $settings['confirmation_message'],
      '#states' => [
        'invisible' => [
          ':input[name="confirmation_type"]' => [
            'value' => 'url',
          ],
        ],
      ],
    ];
    $form['confirmation']['page'] = [
      '#type' => 'container',
      '#states' => [
        'visible' => [
          [
            ':input[name="confirmation_type"]' => [
              'value' => 'page',
            ],
          ],
          'or',
          [
            ':input[name="confirmation_type"]' => [
              'value' => 'inline',
            ],
          ],
        ],
      ],
    ];
    $form['confirmation']['page']['confirmation_attributes'] = [
      '#type' => 'yamlform_element_attributes',
      '#title' => $this
        ->t('Confirmation'),
      '#classes' => $this->configFactory
        ->get('yamlform.settings')
        ->get('settings.confirmation_classes'),
      '#default_value' => $settings['confirmation_attributes'],
    ];
    $form['confirmation']['page']['confirmation_back'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display back to form link'),
      '#return_value' => TRUE,
      '#default_value' => $settings['confirmation_back'],
    ];
    $form['confirmation']['page']['back'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Confirmation back link'),
      '#states' => [
        'visible' => [
          [
            ':input[name="confirmation_back"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ],
    ];
    $form['confirmation']['page']['back']['confirmation_back_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Confirmation back link label'),
      '#size' => 20,
      '#default_value' => $settings['confirmation_back_label'],
    ];
    $form['confirmation']['page']['back']['confirmation_back_attributes'] = [
      '#type' => 'yamlform_element_attributes',
      '#title' => $this
        ->t('Confirmation back link'),
      '#classes' => $this->configFactory
        ->get('yamlform.settings')
        ->get('settings.confirmation_back_classes'),
      '#default_value' => $settings['confirmation_back_attributes'],
    ];
    $form['confirmation']['token_tree_link'] = $this->tokenManager
      ->buildTreeLink();

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

    // Custom.
    $properties = YamlFormElementHelper::getProperties($yamlform
      ->getElementsDecoded());

    // Set default properties.
    $properties += [
      '#method' => '',
      '#action' => '',
    ];
    $form['custom'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Custom settings'),
      '#open' => $properties ? TRUE : FALSE,
      '#access' => !$this->moduleHandler
        ->moduleExists('yamlform_ui') || $this
        ->currentUser()
        ->hasPermission('edit yamlform source'),
    ];
    $form['custom']['method'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Method'),
      '#description' => $this
        ->t('The HTTP method with which the form will be submitted.') . '<br/>' . '<em>' . $this
        ->t('Selecting a custom POST or GET method will automatically disable wizards, previews, drafts, submissions, limits, and confirmations.') . '</em>',
      '#options' => [
        '' => $this
          ->t('POST (Default)'),
        'post' => $this
          ->t('POST (Custom)'),
        'get' => $this
          ->t('GET (Custom)'),
      ],
      '#default_value' => $properties['#method'],
    ];
    $form['custom']['method_message'] = [
      '#type' => 'yamlform_message',
      '#message_type' => 'warning',
      '#message_message' => $this
        ->t("Please make sure this form's action URL or path is setup to handle the form's submission."),
      '#states' => [
        'invisible' => [
          ':input[name="method"]' => [
            'value' => '',
          ],
        ],
      ],
    ];
    $form['custom']['action'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Action'),
      '#description' => $this
        ->t('The URL or path to which the form will be submitted.'),
      '#states' => [
        'invisible' => [
          ':input[name="method"]' => [
            'value' => '',
          ],
        ],
        'optional' => [
          ':input[name="method"]' => [
            'value' => '',
          ],
        ],
      ],
      '#default_value' => $properties['#action'],
    ];

    // Unset properties that are form settings.
    unset($properties['#method'], $properties['#action'], $properties['#novalidate'], $properties['#attributes']);
    $form['custom']['custom'] = [
      '#type' => 'yamlform_codemirror',
      '#mode' => 'yaml',
      '#title' => $this
        ->t('Custom properties'),
      '#description' => $this
        ->t('Properties do not have to prepended with a hash (#) character, the hash character will be automatically added upon submission.') . '<br/>' . $this
        ->t('These properties and callbacks are not allowed: @properties', [
        '@properties' => YamlFormArrayHelper::toString(YamlFormArrayHelper::addPrefix(YamlFormElementHelper::$ignoredProperties)),
      ]),
      '#default_value' => YamlFormArrayHelper::removePrefix($properties),
    ];
    $this
      ->appendDefaultValueToElementDescriptions($form, $default_settings);
    return parent::form($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function save(array $form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();

    /** @var \Drupal\yamlform\YamlFormInterface $yamlform */
    $yamlform = $this
      ->getEntity();

    // Set custom properties, class, and style.
    $elements = $yamlform
      ->getElementsDecoded();
    $elements = YamlFormElementHelper::removeProperties($elements);
    $properties = [];
    if (!empty($values['method'])) {
      $properties['#method'] = $values['method'];
    }
    if (!empty($values['action'])) {
      $properties['#action'] = $values['action'];
    }
    if (!empty($values['custom'])) {
      $properties += YamlFormArrayHelper::addPrefix($values['custom']);
    }
    if (!empty($values['attributes'])) {
      $properties['#attributes'] = $values['attributes'];
    }
    $elements = $properties + $elements;
    $yamlform
      ->setElements($elements);

    // Remove custom properties and attributes.
    unset($values['method'], $values['action'], $values['attributes'], $values['custom']);

    /** @var \Drupal\yamlform\YamlFormSubmissionStorageInterface $submission_storage */
    $submission_storage = $this->entityTypeManager
      ->getStorage('yamlform_submission');

    // Set next serial number.
    $next_serial = (int) $values['next_serial'];
    $max_serial = $submission_storage
      ->getMaxSerial($yamlform);
    if ($next_serial < $max_serial) {
      drupal_set_message($this
        ->t('The next submission number was increased to @min to make it higher than existing submissions.', [
        '@min' => $max_serial,
      ]));
      $next_serial = $max_serial;
    }
    $yamlform
      ->setState('next_serial', $next_serial);

    // Remove main properties.
    unset($values['id'], $values['title'], $values['description'], $values['template'], $values['status'], $values['uid'], $values['next_serial']);

    // Remove disabled properties.
    unset($values['form_novalidate_disabled'], $values['form_unsaved_disabled'], $values['form_details_toggle_disabled']);

    // Set settings.
    $yamlform
      ->setSettings($values);

    // Save the form.
    $yamlform
      ->save();
    $this
      ->logger('yamlform')
      ->notice('Form settings @label saved.', [
      '@label' => $yamlform
        ->label(),
    ]);
    drupal_set_message($this
      ->t('Form settings %label saved.', [
      '%label' => $yamlform
        ->label(),
    ]));
  }

  /**
   * Append default value to an element's description.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param array $default_settings
   *   An associative array container default yamlform settings.
   */
  protected function appendDefaultValueToElementDescriptions(array &$form, array $default_settings) {
    foreach ($form as $key => &$element) {

      // Skip if not a FAPI element.
      if (Element::property($key) || !is_array($element)) {
        continue;
      }
      if (isset($element['#type']) && !empty($default_settings["default_{$key}"]) && empty($element['#disabled'])) {
        if (!isset($element['#description'])) {
          $element['#description'] = '';
        }
        $element['#description'] .= $element['#description'] ? '<br/>' : '';
        $element['#description'] .= $this
          ->t('Defaults to: %value', [
          '%value' => $default_settings["default_{$key}"],
        ]);
      }
      $this
        ->appendDefaultValueToElementDescriptions($element, $default_settings);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
EntityForm::$entity	protected	property	The entity being used by this form.	7
EntityForm::$entityTypeManager	protected	property	The entity type manager.	3
EntityForm::$moduleHandler	protected	property	The module handler service.
EntityForm::$operation	protected	property	The name of the current operation.
EntityForm::$privateEntityManager	private	property	The entity manager.
EntityForm::actions	protected	function	Returns an array of supported actions for the current entity form.	29
EntityForm::actionsElement	protected	function	Returns the action form element for the current entity form.
EntityForm::afterBuild	public	function	Form element #after_build callback: Updates the entity with submitted data.
EntityForm::buildEntity	public	function	Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface::buildEntity	2
EntityForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm	10
EntityForm::copyFormValuesToEntity	protected	function	Copies top-level form values to entity properties	7
EntityForm::getBaseFormId	public	function	Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId	5
EntityForm::getEntity	public	function	Gets the form entity. Overrides EntityFormInterface::getEntity
EntityForm::getEntityFromRouteMatch	public	function	Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface::getEntityFromRouteMatch	1
EntityForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId	10
EntityForm::getOperation	public	function	Gets the operation identifying the form. Overrides EntityFormInterface::getOperation
EntityForm::init	protected	function	Initialize the form state and the entity before the first form build.	3
EntityForm::prepareEntity	protected	function	Prepares the entity object before the form is built first.	3
EntityForm::prepareInvokeAll	protected	function	Invokes the specified prepare hook variant.
EntityForm::processForm	public	function	Process callback: assigns weights and hides extra fields.
EntityForm::setEntity	public	function	Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::setEntityManager	public	function	Sets the entity manager for this form. Overrides EntityFormInterface::setEntityManager
EntityForm::setEntityTypeManager	public	function	Sets the entity type manager for this form. Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler	public	function	Sets the module handler for this form. Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation	public	function	Sets the operation for this form. Overrides EntityFormInterface::setOperation
EntityForm::submitForm	public	function	This is the default entity object builder function. It is called before any other submit handler to build the new entity object to be used by the following submit handlers. At this point of the form workflow the entity is validated and the form state… Overrides FormInterface::submitForm	17
EntityForm::__get	public	function
EntityForm::__set	public	function
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::config	protected	function	Retrieves a configuration object.
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.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
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.
YamlFormEntitySettingsForm::$currentUser	protected	property	The current user.
YamlFormEntitySettingsForm::$messageManager	protected	property	The message manager.
YamlFormEntitySettingsForm::$tokenManager	protected	property	The token manager.
YamlFormEntitySettingsForm::appendDefaultValueToElementDescriptions	protected	function	Append default value to an element's description.
YamlFormEntitySettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
YamlFormEntitySettingsForm::form	public	function	Gets the actual form array to be built. Overrides EntityForm::form
YamlFormEntitySettingsForm::save	public	function	Form submission handler for the 'save' action. Overrides EntityForm::save
YamlFormEntitySettingsForm::__construct	public	function	Constructs a new YamlFormUiElementFormBase.