You are here

Home » API reference » reCAPTCHA 8 » RecaptchaSettingsForm.php

class RecaptchaSettingsForm in reCAPTCHA 8

Provides the reCAPTCHA administration settings.

Hierarchy

Expanded class hierarchy of RecaptchaSettingsForm

1 string reference to 'RecaptchaSettingsForm'
recaptcha.routing.yml in ./recaptcha.routing.yml
recaptcha.routing.yml

File

lib/Drupal/recaptcha/Form/RecaptchaSettingsForm.php, line 16
Contains \Drupal\recaptcha\Form\RecaptchaSettingsForm.

Namespace

Drupal\recaptcha\Form
View source 
class RecaptchaSettingsForm extends ConfigFormBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, array &$form_state) {

    // Load the recaptcha library. Error if library does not load.
    if (!_recaptcha_load_library()) {
      drupal_set_message($this
        ->t('Error loading recaptchalib.'), 'error');
      return FALSE;
    }
    $config = $this->configFactory
      ->get('recaptcha.settings');
    $form = array();
    $form['recaptcha_public_key'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Public Key'),
      '#default_value' => $config
        ->get('recaptcha_public_key'),
      '#maxlength' => 40,
      '#description' => $this
        ->t('The public key given to you when you <a href="@url" target="_blank">register for reCAPTCHA</a>.', array(
        '@url' => recaptcha_get_signup_url(\Drupal::request()->server
          ->get('SERVER_NAME'), $this->configFactory
          ->get('system.site')
          ->get('name')),
      )),
      '#required' => TRUE,
    );
    $form['recaptcha_private_key'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Private Key'),
      '#default_value' => $config
        ->get('recaptcha_private_key'),
      '#maxlength' => 40,
      '#description' => $this
        ->t('The private key given to you when you <a href="@url" target="_blank">register for reCAPTCHA</a>.', array(
        '@url' => recaptcha_get_signup_url(\Drupal::request()->server
          ->get('SERVER_NAME'), $this->configFactory
          ->get('system.site')
          ->get('name')),
      )),
      '#required' => TRUE,
    );
    $form['recaptcha_ajax_api'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('AJAX API'),
      '#default_value' => $config
        ->get('recaptcha_ajax_api'),
      '#description' => $this
        ->t('Use the AJAX API to display reCAPTCHA.'),
    );
    $form['recaptcha_nocookies'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Disable Client-Side Cookies'),
      '#default_value' => $config
        ->get('recaptcha_nocookies'),
      '#description' => $this
        ->t('Add flag to disable third-party cookies set by reCAPTCHA.'),
    );
    $form['recaptcha_theme_settings'] = array(
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Theme Settings'),
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
    );
    $form['recaptcha_theme_settings']['recaptcha_theme'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Theme'),
      '#description' => $this
        ->t('Defines which theme to use for reCAPTCHA.'),
      '#options' => array(
        'red' => $this
          ->t('Red'),
        'white' => $this
          ->t('White'),
        'blackglass' => $this
          ->t('Black Glass'),
        'clean' => $this
          ->t('Clean'),
        'custom' => $this
          ->t('Custom'),
      ),
      '#default_value' => $config
        ->get('recaptcha_theme'),
      '#required' => TRUE,
    );
    $form['recaptcha_theme_settings']['recaptcha_tabindex'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Tab Index'),
      '#description' => $this
        ->t('Sets a <a href="@tabindex" target="_blank">tabindex</a> for the reCAPTCHA text box.
                                  If other elements in the form use a tabindex, this should be set so that navigation is easier for the user.', array(
        '@tabindex' => 'http://www.w3.org/TR/html4/interact/forms.html#adef-tabindex',
      )),
      '#default_value' => $config
        ->get('recaptcha_tabindex'),
      '#size' => 4,
    );
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, array &$form_state) {
    $tabindex = $form_state['values']['recaptcha_tabindex'];
    if (!empty($tabindex) && !is_numeric($tabindex)) {
      form_set_error('recaptcha_tabindex', $form_state, $this
        ->t('The Tab Index must be an integer.'));
    }
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, array &$form_state) {
    $this->configFactory
      ->get('recaptcha.settings')
      ->set('recaptcha_public_key', $form_state['values']['recaptcha_public_key'])
      ->set('recaptcha_private_key', $form_state['values']['recaptcha_private_key'])
      ->set('recaptcha_ajax_api', $form_state['values']['recaptcha_ajax_api'])
      ->set('recaptcha_nocookies', $form_state['values']['recaptcha_nocookies'])
      ->set('recaptcha_theme', $form_state['values']['recaptcha_theme'])
      ->set('recaptcha_tabindex', $form_state['values']['recaptcha_tabindex'])
      ->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.
ConfigFormBaseTrait::getEditableConfigNames abstract protected function Gets the configuration names that will be editable. 32
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.
RecaptchaSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
RecaptchaSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
RecaptchaSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
RecaptchaSettingsForm::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.