You are here

Home » API reference » CAPTCHA Pack 8 » MathCaptchaSettingsForm.php

class MathCaptchaSettingsForm in CAPTCHA Pack 8

Math CAPTCHA settings form.

Hierarchy

Expanded class hierarchy of MathCaptchaSettingsForm

1 string reference to 'MathCaptchaSettingsForm'
math_captcha.routing.yml in math_captcha/math_captcha.routing.yml
math_captcha/math_captcha.routing.yml

File

math_captcha/src/Form/MathCaptchaSettingsForm.php, line 11

Namespace

Drupal\math_captcha\Form
View source 
class MathCaptchaSettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('math_captcha.settings');
    $form = [];
    $enabled_challenges = _math_captcha_enabled_challenges();
    $form['math_captcha_enabled_challenges'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Enabled math challenges'),
      '#options' => [
        'addition' => $this
          ->t('Addition: x + y = z'),
        'subtraction' => $this
          ->t('Subtraction: x - y = z'),
        'multiplication' => $this
          ->t('Multiplication: x * y = z'),
      ],
      '#default_value' => $enabled_challenges,
      '#description' => $this
        ->t('Select the math challenges you want to enable.'),
    ];
    $form['math_captcha_textual_numbers'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Textual representation of numbers'),
      '#default_value' => $config
        ->get('math_captcha_textual_numbers'),
      '#description' => $this
        ->t('When enabled, the numbers in the challenge will get a textual representation if available. E.g. "four" instead of "4".'),
    ];
    $form['math_captcha_textual_operators'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Textual representation of operators'),
      '#default_value' => $config
        ->get('math_captcha_textual_operators'),
      '#description' => $this
        ->t('When enabled, the operators in the challenge will get a textual representation if available. E.g. "plus" instead of "+".'),
    ];

    // Addition challenge.
    $form['math_captcha_addition'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Addition challenge: x + y = z'),
      '#states' => [
        'invisible' => [
          ':input[name="math_captcha_enabled_challenges[addition]"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    $form['math_captcha_addition']['math_captcha_addition_argmax'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Maximum value for x and y'),
      '#default_value' => $config
        ->get('math_captcha_addition_argmax'),
      '#maxlength' => 3,
      '#size' => 3,
      '#states' => [
        'required' => [
          ':input[name="math_captcha_enabled_challenges[addition]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['math_captcha_addition']['math_captcha_addition_allow_negative'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Allow negative values.'),
      '#default_value' => $config
        ->get('math_captcha_addition_allow_negative'),
    ];

    // Subtraction challenge.
    $form['math_captcha_subtraction'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Subtraction challenge: x - y = z'),
      '#states' => [
        'invisible' => [
          ':input[name="math_captcha_enabled_challenges[subtraction]"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    $form['math_captcha_subtraction']['math_captcha_subtraction_argmax'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Maximum value for x and y'),
      '#default_value' => $config
        ->get('math_captcha_subtraction_argmax'),
      '#maxlength' => 3,
      '#size' => 3,
      '#states' => [
        'required' => [
          ':input[name="math_captcha_enabled_challenges[subtraction]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['math_captcha_subtraction']['math_captcha_subtraction_allow_negative'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Allow negative values.'),
      '#default_value' => $config
        ->get('math_captcha_subtraction_allow_negative'),
    ];

    // Multiplication challenge.
    $form['math_captcha_multiplication'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Multiplication challenge: x * y = z'),
      '#states' => [
        'invisible' => [
          ':input[name="math_captcha_enabled_challenges[multiplication]"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    $form['math_captcha_multiplication']['math_captcha_multiplication_argmax'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Maximum value for x and y'),
      '#default_value' => $config
        ->get('math_captcha_multiplication_argmax'),
      '#maxlength' => 3,
      '#size' => 3,
      '#states' => [
        'required' => [
          ':input[name="math_captcha_enabled_challenges[multiplication]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['math_captcha_multiplication']['math_captcha_multiplication_allow_negative'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Allow negative values.'),
      '#default_value' => $config
        ->get('math_captcha_multiplication_allow_negative'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $enabled_challenges = $form_state
      ->getValue('math_captcha_enabled_challenges');
    if (count(array_filter($enabled_challenges)) < 1) {
      $form_state
        ->setErrorByName('math_captcha_enabled_challenges', $this
        ->t('You should select at least one type of math challenges.'));
    }
    $challenges = array_keys($enabled_challenges);
    foreach ($challenges as $challenge) {
      if (empty($enabled_challenges[$challenge])) {
        continue;
      }
      $argmax = "math_captcha_{$challenge}_argmax";
      if (!ctype_digit($form_state
        ->getValue($argmax))) {
        $form_state
          ->setErrorByName($argmax, $this
          ->t('Maximum value should be an integer.'));
      }
      else {
        $form_state
          ->setValue($argmax, intval($form_state
          ->getValue($argmax)));
        if ($form_state
          ->getValue($argmax) < 2) {
          $form_state
            ->setErrorByName($argmax, $this
            ->t('Maximum value should be an integer and at least 2'));
        }
      }
    }
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('math_captcha.settings');
    $config
      ->set('math_captcha_enabled_challenges', $form_state
      ->getValue('math_captcha_enabled_challenges'));
    $config
      ->set('math_captcha_textual_numbers', $form_state
      ->getValue('math_captcha_textual_numbers'));
    $config
      ->set('math_captcha_textual_operators', $form_state
      ->getValue('math_captcha_textual_operators'));
    $config
      ->set('math_captcha_addition_argmax', $form_state
      ->getValue('math_captcha_addition_argmax'));
    $config
      ->set('math_captcha_addition_allow_negative', $form_state
      ->getValue('math_captcha_addition_allow_negative'));
    $config
      ->set('math_captcha_subtraction_argmax', $form_state
      ->getValue('math_captcha_subtraction_argmax'));
    $config
      ->set('math_captcha_subtraction_allow_negative', $form_state
      ->getValue('math_captcha_subtraction_allow_negative'));
    $config
      ->set('math_captcha_multiplication_argmax', $form_state
      ->getValue('math_captcha_multiplication_argmax'));
    $config
      ->set('math_captcha_multiplication_allow_negative', $form_state
      ->getValue('math_captcha_multiplication_allow_negative'));
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 13
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 11
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
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
FormBase::$configFactory protected property The config factory. 1
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. 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.
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.
MathCaptchaSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
MathCaptchaSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
MathCaptchaSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
MathCaptchaSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
MathCaptchaSettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
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.