LostCharacterCaptchaSettingsForm.php in CAPTCHA Pack 8

Namespace

Drupal\lost_character_captcha\Form

File

text_captcha/modules/lost_character_captcha/src/Form/LostCharacterCaptchaSettingsForm.php

<?php

namespace Drupal\lost_character_captcha\Form;

use Drupal\Core\Form\ConfigFormBase;
use Drupal\Core\Form\FormStateInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Function for the settings form.
 */
class LostCharacterCaptchaSettingsForm extends ConfigFormBase {

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'));
  }

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

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

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

    // Form element for the number of characters to lose.
    $form['lost_character_captcha_quantity'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Number of characters to lose'),
      '#default_value' => $config
        ->get('lost_character_captcha_quantity'),
      '#description' => $this
        ->t('Select how many characters should be lost in the CAPTCHA.'),
      '#options' => array_combine([
        1,
        2,
        3,
      ], [
        1,
        2,
        3,
      ]),
    ];

    // Form element for hinting.
    $form['lost_character_captcha_enable_hint'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Put "%hinter" where the characters are lost as a hint', [
        '%hinter' => LOST_CHARACTER_CAPTCHA_HINTER,
      ]),
      '#default_value' => $config
        ->get('lost_character_captcha_enable_hint'),
      '#description' => $this
        ->t('Enable this option to make it easier to determine the lost characters.'),
    ];

    // Form elements for the word pool.
    _text_captcha_word_pool_form_items($form, 'lost_character_captcha_word_pool', 'Word pool', 'Enter the words to use, separated with spaces. Make sure every word is unambiguously recognizable when characters are lost. Avoid for example verbs, adverbs, plural forms, too short words, names. Also make sure the words are well known to your intended public.', LOST_CHARACTER_CAPTCHA_DEFAULT_WORD_POOL);
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('lost_character_captcha.settings');
    $config
      ->set('lost_character_captcha_enable_hint', $form_state
      ->getValue('lost_character_captcha_enable_hint'))
      ->set('lost_character_captcha_quantity', $form_state
      ->getValue('lost_character_captcha_quantity'));
    foreach ($form_state
      ->getValues() as $label => $value) {
      if (strpos($label, 'lost_character_captcha_word_pool') !== FALSE) {
        $config
          ->set($label, $value);
      }
    }
    $config
      ->save();
    parent::SubmitForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $lost_quantity = (int) $form_state
      ->getValue('lost_character_captcha_quantity');
    $hinting = (int) $form_state
      ->getValue('lost_character_captcha_enable_hint');
    $min_length = 3 + 2 * $lost_quantity + (1 - $hinting);

    // Check the number of words in the pool.
    _text_captcha_word_pool_validate('lost_character_captcha_word_pool', $form_state, 3, $min_length, 'The following words are too short (at least @minimum_length characters needed for the current settings of characters to lose and hinting): <div>@words</div>');
    parent::validateForm($form, $form_state);
  }

}

Classes

Name	Description
LostCharacterCaptchaSettingsForm	Function for the settings form.