public function HoneypotSettingsController::buildForm in Honeypot 2.0.x

Same name and namespace in other branches

1. 8 src/Controller/HoneypotSettingsController.php \Drupal\honeypot\Controller\HoneypotSettingsController::buildForm()

Form constructor.

Parameters

array $form: An associative array containing the structure of the form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Return value

array The form structure.

Overrides ConfigFormBase::buildForm

File

src/Controller/HoneypotSettingsController.php, line 129

Class

HoneypotSettingsController

Returns responses for Honeypot module routes.

Namespace

Drupal\honeypot\Controller

Code

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

  // Honeypot Configuration.
  $form['configuration'] = [
    '#type' => 'fieldset',
    '#title' => $this
      ->t('Honeypot Configuration'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
  ];
  $form['configuration']['protect_all_forms'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Protect all forms with Honeypot'),
    '#description' => $this
      ->t('Enable Honeypot protection for ALL forms on this site (it is best to only enable Honeypot for the forms you need below).'),
    '#default_value' => $this
      ->config('honeypot.settings')
      ->get('protect_all_forms'),
  ];
  $form['configuration']['protect_all_forms']['#description'] .= '<br />' . $this
    ->t('<strong>Page caching will be disabled on any page where a form is present if the Honeypot time limit is not set to 0.</strong>');
  $form['configuration']['log'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Log blocked form submissions'),
    '#description' => $this
      ->t('Log submissions that are blocked due to Honeypot protection.'),
    '#default_value' => $this
      ->config('honeypot.settings')
      ->get('log'),
  ];
  $form['configuration']['element_name'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Honeypot element name'),
    '#description' => $this
      ->t("The name of the Honeypot form field. It's usually most effective to use a generic name like email, homepage, or link, but this should be changed if it interferes with fields that are already in your forms. Must not contain spaces or special characters."),
    '#default_value' => $this
      ->config('honeypot.settings')
      ->get('element_name'),
    '#required' => TRUE,
    '#size' => 30,
  ];
  $form['configuration']['time_limit'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Honeypot time limit'),
    '#description' => $this
      ->t('Minimum time required before form should be considered entered by a human instead of a bot. Set to 0 to disable.'),
    '#default_value' => $this
      ->config('honeypot.settings')
      ->get('time_limit'),
    '#required' => TRUE,
    '#size' => 5,
    '#field_suffix' => $this
      ->t('seconds'),
  ];
  $form['configuration']['time_limit']['#description'] .= '<br />' . $this
    ->t('<strong>Page caching will be disabled if there is a form protected by time limit on the page.</strong>');

  // Honeypot Enabled forms.
  $form_settings = $this
    ->config('honeypot.settings')
    ->get('form_settings');
  $form['form_settings'] = [
    '#type' => 'fieldset',
    '#title' => $this
      ->t('Honeypot Enabled Forms'),
    '#description' => $this
      ->t("Check the boxes next to individual forms on which you'd like Honeypot protection enabled."),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
    '#tree' => TRUE,
    '#states' => [
      // Hide this fieldset when all forms are protected.
      'invisible' => [
        'input[name="protect_all_forms"]' => [
          'checked' => TRUE,
        ],
      ],
    ],
  ];

  // Generic forms.
  $form['form_settings']['general_forms'] = [
    '#markup' => '<h5>' . $this
      ->t('General Forms') . '</h5>',
  ];

  // User register form.
  $form['form_settings']['user_register_form'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('User Registration form'),
    '#default_value' => $this
      ->getFormSettingsValue($form_settings, 'user_register_form'),
  ];

  // User password form.
  $form['form_settings']['user_pass'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('User Password Reset form'),
    '#default_value' => $this
      ->getFormSettingsValue($form_settings, 'user_pass'),
  ];

  // If contact.module enabled, add contact forms.
  if ($this->moduleHandler
    ->moduleExists('contact')) {
    $form['form_settings']['contact_forms'] = [
      '#markup' => '<h5>' . $this
        ->t('Contact Forms') . '</h5>',
    ];
    $bundles = $this->entityTypeBundleInfo
      ->getBundleInfo('contact_message');
    $formController = $this->entityTypeManager
      ->getFormObject('contact_message', 'default');
    foreach ($bundles as $bundle_key => $bundle) {
      $stub = $this->entityTypeManager
        ->getStorage('contact_message')
        ->create([
        'contact_form' => $bundle_key,
      ]);
      $formController
        ->setEntity($stub);
      $form_id = $formController
        ->getFormId();
      $form['form_settings'][$form_id] = [
        '#type' => 'checkbox',
        '#title' => Html::escape($bundle['label']),
        '#default_value' => $this
          ->getFormSettingsValue($form_settings, $form_id),
      ];
    }
  }

  // Node types for node forms.
  if ($this->moduleHandler
    ->moduleExists('node')) {
    $types = NodeType::loadMultiple();
    if (!empty($types)) {

      // Node forms.
      $form['form_settings']['node_forms'] = [
        '#markup' => '<h5>' . $this
          ->t('Node Forms') . '</h5>',
      ];
      foreach ($types as $type) {
        $id = 'node_' . $type
          ->get('type') . '_form';
        $form['form_settings'][$id] = [
          '#type' => 'checkbox',
          '#title' => $this
            ->t('@name node form', [
            '@name' => $type
              ->label(),
          ]),
          '#default_value' => $this
            ->getFormSettingsValue($form_settings, $id),
        ];
      }
    }
  }

  // Comment types for comment forms.
  if ($this->moduleHandler
    ->moduleExists('comment')) {
    $types = CommentType::loadMultiple();
    if (!empty($types)) {
      $form['form_settings']['comment_forms'] = [
        '#markup' => '<h5>' . $this
          ->t('Comment Forms') . '</h5>',
      ];
      foreach ($types as $type) {
        $id = 'comment_' . $type
          ->id() . '_form';
        $form['form_settings'][$id] = [
          '#type' => 'checkbox',
          '#title' => $this
            ->t('@name comment form', [
            '@name' => $type
              ->label(),
          ]),
          '#default_value' => $this
            ->getFormSettingsValue($form_settings, $id),
        ];
      }
    }
  }

  // Store the keys we want to save in configuration when form is submitted.
  $keys_to_save = array_keys($form['configuration']);
  foreach ($keys_to_save as $key => $key_to_save) {
    if (strpos($key_to_save, '#') !== FALSE) {
      unset($keys_to_save[$key]);
    }
  }
  $form_state
    ->setStorage([
    'keys' => $keys_to_save,
  ]);

  // For now, manually add submit button. Hopefully, by the time D8 is
  // released, there will be something like system_settings_form() in D7.
  $form['actions']['#type'] = 'container';
  $form['actions']['submit'] = [
    '#type' => 'submit',
    '#value' => $this
      ->t('Save configuration'),
  ];
  return $form;
}