class PhraseCaptchaSettingsForm in CAPTCHA Pack 8

Administration form.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\phrase_captcha\Form\PhraseCaptchaSettingsForm

Expanded class hierarchy of PhraseCaptchaSettingsForm

1 string reference to 'PhraseCaptchaSettingsForm'

phrase_captcha.routing.yml in text_captcha/modules/phrase_captcha/phrase_captcha.routing.yml: text_captcha/modules/phrase_captcha/phrase_captcha.routing.yml

File

text_captcha/modules/phrase_captcha/src/Form/PhraseCaptchaSettingsForm.php, line 12

Namespace

Drupal\phrase_captcha\Form

View source

class PhraseCaptchaSettingsForm extends ConfigFormBase {

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('phrase_captcha.settings');
    drupal_set_message($this
      ->t('WARNING: this module is not completely ported to Drupal 8 and does not work yet.'), 'warning');

    // Radio buttons for selecting the kind of words to use.
    $form['phrase_captcha_words'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Kind of words to use in the CAPTCHA phrase'),
      '#options' => [
        PHRASE_CAPTCHA_GENERATE_NONSENSE_WORDS => $this
          ->t('Generate nonsense words'),
        PHRASE_CAPTCHA_USER_DEFINED_WORDS => $this
          ->t('Use user defined words'),
      ],
      '#default_value' => $config
        ->get('phrase_captcha_words'),
      '#required' => TRUE,
    ];

    // Form elements for the word pools.
    _text_captcha_word_pool_form_items($form, 'phrase_captcha_userdefined_word_pool', 'User defined word pool', 'Enter the words to use in the CAPTCHA phrase (space separated, no punctuation).', '');

    // Select form element for the number of words in the CAPTCHA phrase.
    $form['phrase_captcha_word_quantity'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Number of words in the CAPTCHA phrase'),
      '#default_value' => $config
        ->get('phrase_captcha_word_quantity'),
      '#options' => array_combine([
        4,
        5,
        6,
        7,
        8,
        9,
        10,
      ], [
        4,
        5,
        6,
        7,
        8,
        9,
        10,
      ]),
      '#required' => TRUE,
    ];

    // Select form element for the number of additional words.
    $form['phrase_captcha_additional_word_quantity'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Maximum number of additional words to let the user choose from'),
      '#default_value' => $config
        ->get('phrase_captcha_additional_word_quantity'),
      '#options' => array_combine([
        0,
        1,
        2,
        3,
        4,
        5,
      ], [
        0,
        1,
        2,
        3,
        4,
        5,
      ]),
      '#required' => TRUE,
    ];
    $form['phrase_captcha_word_selection_challenges'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Word selection challenges'),
      '#options' => _phrase_captcha_available_word_challenges(),
      '#default_value' => _phrase_captcha_enabled_word_challenges(),
    ];
    return parent::buildForm($form, $form_state);
  }

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

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    if ($form_state
      ->getValue('phrase_captcha_words') == PHRASE_CAPTCHA_USER_DEFINED_WORDS) {
      $word_count_minimum = $form_state
        ->getValue('phrase_captcha_word_quantity') + $form_state
        ->getValue('phrase_captcha_additional_word_quantity') + 2;
      _text_captcha_word_pool_validate('phrase_captcha_userdefined_word_pool', $form_state, $word_count_minimum, NULL, NULL);
    }

    // Check word selection.
    if (count(array_filter($form_state
      ->getValue('phrase_captcha_word_selection_challenges'))) < 1) {
      $form_state
        ->setErrorByName('phrase_captcha_word_selection_challenges', $this
        ->t('You need to select at least one word selection criterium'));
    }
    parent::validateForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PhraseCaptchaSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
PhraseCaptchaSettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
PhraseCaptchaSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
PhraseCaptchaSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
PhraseCaptchaSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
PhraseCaptchaSettingsForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
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.

You are here

class PhraseCaptchaSettingsForm in CAPTCHA Pack 8

Hierarchy

File

Namespace

Members

API Navigation