class AsciiArtCaptchaSettingsForm in CAPTCHA Pack 8

Displays the pants settings 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\ascii_art_captcha\Form\AsciiArtCaptchaSettingsForm

Expanded class hierarchy of AsciiArtCaptchaSettingsForm

1 string reference to 'AsciiArtCaptchaSettingsForm'

ascii_art_captcha.routing.yml in ascii_art_captcha/ascii_art_captcha.routing.yml: ascii_art_captcha/ascii_art_captcha.routing.yml

File

ascii_art_captcha/src/Form/AsciiArtCaptchaSettingsForm.php, line 11

Namespace

Drupal\ascii_art_captcha\Form

View source

class AsciiArtCaptchaSettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('ascii_art_captcha.settings');
    $available_fonts = _ascii_art_captcha_available_fonts();
    $code_length_options = [
      4,
      5,
      6,
      7,
      8,
      9,
      10,
    ];
    $form['ascii_art_captcha_code_length'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Code length'),
      '#options' => array_combine($code_length_options, $code_length_options),
      '#default_value' => $config
        ->get('ascii_art_captcha_code_length'),
    ];
    $form['ascii_art_captcha_font'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Font'),
      '#options' => $available_fonts,
      '#default_value' => $config
        ->get('ascii_art_captcha_font'),
      '#description' => $this
        ->t('Define the ASCII art font to use. Note that some characters are not very recognizable in some (small/weird) fonts. Make sure to disable the right character sets in these cases.'),
    ];

    // Font size.
    $font_sizes = [
      0 => $this
        ->t('default'),
    ];
    foreach ([
      4,
      6,
      8,
      9,
      10,
      11,
      12,
    ] as $pt) {
      $font_sizes[$pt] = $pt . 'pt';
    }
    $form['ascii_art_captcha_font_size'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Font size'),
      '#options' => $font_sizes,
      '#default_value' => $config
        ->get('ascii_art_captcha_font_size'),
      '#description' => $this
        ->t('Set the font size for the ASCII art.'),
    ];
    $form['ascii_art_captcha_allowed_characters'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Character sets to use'),
      '#options' => [
        'upper' => $this
          ->t('upper case characters'),
        'lower' => $this
          ->t('lower case characters'),
        'digit' => $this
          ->t('digits'),
      ],
      '#default_value' => $config
        ->get('ascii_art_captcha_allowed_characters'),
      '#description' => $this
        ->t('Enable the character sets to use in the code. Choose wisely by taking the recognizability of the used font into account.'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    if (count(array_filter($form_state
      ->getValue('ascii_art_captcha_allowed_characters'))) < 1) {
      $form_state
        ->setErrorByName('ascii_art_captcha_allowed_characters', $this
        ->t('You should select at least one type of characters to use.'));
    }
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('ascii_art_captcha.settings');
    $config
      ->set('ascii_art_captcha_code_length', $form_state
      ->getValue('ascii_art_captcha_code_length'));
    $config
      ->set('ascii_art_captcha_font', $form_state
      ->getValue('ascii_art_captcha_font'));
    $config
      ->set('ascii_art_captcha_font_size', $form_state
      ->getValue('ascii_art_captcha_font_size'));
    $config
      ->set('ascii_art_captcha_allowed_characters', $form_state
      ->getValue('ascii_art_captcha_allowed_characters'));
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AsciiArtCaptchaSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
AsciiArtCaptchaSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
AsciiArtCaptchaSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
AsciiArtCaptchaSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
AsciiArtCaptchaSettingsForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
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.
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.

You are here

class AsciiArtCaptchaSettingsForm in CAPTCHA Pack 8

Hierarchy

File

Namespace

Members

API Navigation