You are here

Home » API reference » Email confirmer 8 » EmailConfirmerUserSettingsForm.php

class EmailConfirmerUserSettingsForm in Email confirmer 8

Email confirmer user settings form.

Hierarchy

Expanded class hierarchy of EmailConfirmerUserSettingsForm

1 string reference to 'EmailConfirmerUserSettingsForm'
email_confirmer_user.routing.yml in email_confirmer_user/email_confirmer_user.routing.yml
email_confirmer_user/email_confirmer_user.routing.yml

File

email_confirmer_user/src/Form/EmailConfirmerUserSettingsForm.php, line 11

Namespace

Drupal\email_confirmer_user\Form
View source 
class EmailConfirmerUserSettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);

    /** @var \Drupal\Core\Config\ImmutableConfig $config */
    $config = $this
      ->config('email_confirmer_user.settings');

    // User email address confirmation on change options.
    $subconfig = $config
      ->get('user_email_change');
    $form['email_change'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('On user email change'),
      '#open' => TRUE,
    ];
    $form['email_change']['user_email_change_confirm'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Require confirmation'),
      '#description' => $this
        ->t('This enables or disables the email address confirmation when a user updates their email address.'),
      '#default_value' => $subconfig['enabled'],
    ];
    $form['email_change']['user_email_change_notify_current'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Send notification to the current email address'),
      '#description' => $this
        ->t('An informational message will be send to the original email address when the user attempts to change their address.'),
      '#default_value' => $subconfig['notify_current'],
      '#states' => [
        'disabled' => [
          ':input[name="user_email_change_confirm"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    $form['email_change']['user_email_change_consider_existent'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Consider existent confirmations'),
      '#description' => $this
        ->t('No confirmation will be required for previously confirmed email addresses by the same user.'),
      '#default_value' => $subconfig['consider_existent'],
      '#states' => [
        'disabled' => [
          ':input[name="user_email_change_confirm"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    $form['email_change']['user_email_change_limit_realm'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Consider only user related confirmations'),
      '#description' => $this
        ->t('Leave unchecked to consider the existing confirmations launched by the same user in other situations in which the email confirmer was used.'),
      '#default_value' => $subconfig['limit_user_realm'],
      '#states' => [
        'disabled' => [
          [
            ':input[name="user_email_change_confirm"]' => [
              'checked' => FALSE,
            ],
          ],
          [
            ':input[name="user_email_change_consider_existent"]' => [
              'checked' => FALSE,
            ],
          ],
        ],
      ],
    ];

    // User log in options.
    $subconfig = $config
      ->get('user_login');
    $form['user_login'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('On user log in'),
      '#open' => TRUE,
    ];
    $form['user_login']['sync_core_onfirstlogin_confirmation'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Record email confirmation on first user log in'),
      '#description' => $this
        ->t('When a new user logs in for the first time, a confirmation will be recorded by the email confirmer to work with it onwards.'),
      '#default_value' => $subconfig['sync_core_confirmation'],
    ];
    $form['user_login']['sync_core_onetimeloginlinks'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Record email confirmation when user logs in through a one-time log in link'),
      '#description' => $this
        ->t('When a user logs in by opening a one-time log in link, as in the password reset, a confirmation will be recorded by the email confirmer to work with it onwards.'),
      '#default_value' => $subconfig['sync_core_onetimeloginlinks'],
    ];
    return $form;
  }

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

    /** @var \Drupal\Core\Config\ImmutableConfig $config */
    $config = $this
      ->config('email_confirmer_user.settings');
    $config
      ->set('user_email_change', [
      'enabled' => $form_state
        ->getValue('user_email_change_confirm') && TRUE,
      'notify_current' => $form_state
        ->getValue('user_email_change_notify_current') && TRUE,
      'consider_existent' => $form_state
        ->getValue('user_email_change_consider_existent') && TRUE,
      'limit_user_realm' => $form_state
        ->getValue('user_email_change_limit_realm') && TRUE,
    ])
      ->set('user_login', [
      'sync_core_confirmation' => $form_state
        ->getValue('sync_core_onfirstlogin_confirmation') && TRUE,
      'sync_core_onetimeloginlinks' => $form_state
        ->getValue('sync_core_onetimeloginlinks') && TRUE,
    ])
      ->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
EmailConfirmerUserSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
EmailConfirmerUserSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
EmailConfirmerUserSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
EmailConfirmerUserSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
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.
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.