class ReCaptchaAdminSettingsForm in reCAPTCHA 8.2

Same name and namespace in other branches

8.3 src/Form/ReCaptchaAdminSettingsForm.php \Drupal\recaptcha\Form\ReCaptchaAdminSettingsForm

Configure reCAPTCHA settings for this site.

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\recaptcha\Form\ReCaptchaAdminSettingsForm

Expanded class hierarchy of ReCaptchaAdminSettingsForm

1 string reference to 'ReCaptchaAdminSettingsForm'

recaptcha.routing.yml in ./recaptcha.routing.yml: recaptcha.routing.yml

File

src/Form/ReCaptchaAdminSettingsForm.php, line 12

Namespace

Drupal\recaptcha\Form

View source

class ReCaptchaAdminSettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('recaptcha.settings');
    $form['general'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('General settings'),
      '#open' => TRUE,
    ];
    $form['general']['recaptcha_site_key'] = [
      '#default_value' => $config
        ->get('site_key'),
      '#description' => $this
        ->t('The site key given to you when you <a href=":url">register for reCAPTCHA</a>.', [
        ':url' => 'https://www.google.com/recaptcha/admin',
      ]),
      '#maxlength' => 40,
      '#required' => TRUE,
      '#title' => $this
        ->t('Site key'),
      '#type' => 'textfield',
    ];
    $form['general']['recaptcha_secret_key'] = [
      '#default_value' => $config
        ->get('secret_key'),
      '#description' => $this
        ->t('The secret key given to you when you <a href=":url">register for reCAPTCHA</a>.', [
        ':url' => 'https://www.google.com/recaptcha/admin',
      ]),
      '#maxlength' => 40,
      '#required' => TRUE,
      '#title' => $this
        ->t('Secret key'),
      '#type' => 'textfield',
    ];
    $form['general']['recaptcha_verify_hostname'] = [
      '#default_value' => $config
        ->get('verify_hostname'),
      '#description' => $this
        ->t('Checks the hostname on your server when verifying a solution. Enable this validation only, if <em>Verify the origin of reCAPTCHA solutions</em> is unchecked for your key pair. Provides crucial security by verifying requests come from one of your listed domains.'),
      '#title' => $this
        ->t('Local domain name validation'),
      '#type' => 'checkbox',
    ];
    $form['general']['recaptcha_use_globally'] = [
      '#default_value' => $config
        ->get('use_globally'),
      '#description' => $this
        ->t('Enable this in circumstances when "www.google.com" is not accessible, e.g. China.'),
      '#title' => $this
        ->t('Use reCAPTCHA globally'),
      '#type' => 'checkbox',
    ];

    // Widget configurations.
    $form['widget'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Widget settings'),
      '#open' => TRUE,
    ];
    $form['widget']['recaptcha_theme'] = [
      '#default_value' => $config
        ->get('widget.theme'),
      '#description' => $this
        ->t('Defines which theme to use for reCAPTCHA.'),
      '#options' => [
        'light' => $this
          ->t('Light (default)'),
        'dark' => $this
          ->t('Dark'),
      ],
      '#title' => $this
        ->t('Theme'),
      '#type' => 'select',
    ];
    $form['widget']['recaptcha_type'] = [
      '#default_value' => $config
        ->get('widget.type'),
      '#description' => $this
        ->t('The type of CAPTCHA to serve.'),
      '#options' => [
        'image' => $this
          ->t('Image (default)'),
        'audio' => $this
          ->t('Audio'),
      ],
      '#title' => $this
        ->t('Type'),
      '#type' => 'select',
    ];
    $form['widget']['recaptcha_size'] = [
      '#default_value' => $config
        ->get('widget.size'),
      '#description' => $this
        ->t('The size of CAPTCHA to serve.'),
      '#options' => [
        '' => $this
          ->t('Normal (default)'),
        'compact' => $this
          ->t('Compact'),
      ],
      '#title' => $this
        ->t('Size'),
      '#type' => 'select',
    ];
    $form['widget']['recaptcha_tabindex'] = [
      '#default_value' => $config
        ->get('widget.tabindex'),
      '#description' => $this
        ->t('Set the <a href=":tabindex">tabindex</a> of the widget and challenge (Default = 0). If other elements in your page use tabindex, it should be set to make user navigation easier.', [
        ':tabindex' => Url::fromUri('https://www.w3.org/TR/html4/interact/forms.html', [
          'fragment' => 'adef-tabindex',
        ])
          ->toString(),
      ]),
      '#maxlength' => 4,
      '#title' => $this
        ->t('Tabindex'),
      '#type' => 'number',
      '#min' => -1,
    ];
    $form['widget']['recaptcha_noscript'] = [
      '#default_value' => $config
        ->get('widget.noscript'),
      '#description' => $this
        ->t('If JavaScript is a requirement for your site, you should <strong>not</strong> enable this feature. With this enabled, a compatibility layer will be added to the captcha to support non-js users.'),
      '#title' => $this
        ->t('Enable fallback for browsers with JavaScript disabled'),
      '#type' => 'checkbox',
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('recaptcha.settings');
    $config
      ->set('site_key', $form_state
      ->getValue('recaptcha_site_key'))
      ->set('secret_key', $form_state
      ->getValue('recaptcha_secret_key'))
      ->set('verify_hostname', $form_state
      ->getValue('recaptcha_verify_hostname'))
      ->set('use_globally', $form_state
      ->getValue('recaptcha_use_globally'))
      ->set('widget.theme', $form_state
      ->getValue('recaptcha_theme'))
      ->set('widget.type', $form_state
      ->getValue('recaptcha_type'))
      ->set('widget.size', $form_state
      ->getValue('recaptcha_size'))
      ->set('widget.tabindex', $form_state
      ->getValue('recaptcha_tabindex'))
      ->set('widget.noscript', $form_state
      ->getValue('recaptcha_noscript'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

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

Hierarchy

File

Namespace

Members

API Navigation