You are here

Home » API reference » User email verification 8 » UserEmailVerificationRequestForm.php

class UserEmailVerificationRequestForm in User email verification 8

Class UserEmailVerificationRequestForm.

Hierarchy

Expanded class hierarchy of UserEmailVerificationRequestForm

1 string reference to 'UserEmailVerificationRequestForm'
user_email_verification.routing.yml in ./user_email_verification.routing.yml
user_email_verification.routing.yml

File

src/Form/UserEmailVerificationRequestForm.php, line 18

Namespace

Drupal\user_email_verification\Form
View source 
class UserEmailVerificationRequestForm extends FormBase {

  /**
   * User email verification helper service.
   *
   * @var \Drupal\user_email_verification\UserEmailVerificationInterface
   */
  protected $userEmailVerification;

  /**
   * The current active user.
   *
   * @var \Drupal\Core\Session\AccountProxyInterface
   */
  protected $currentUser;

  /**
   * The currently active request object.
   *
   * @var \Symfony\Component\HttpFoundation\Request
   */
  protected $request;

  /**
   * The user.settings config object.
   *
   * @var \Drupal\Core\Config\Config
   */
  protected $configUserSettings;

  /**
   * Constructs a new UserEmailVerificationRequestForm object.
   *
   * @param \Drupal\user_email_verification\UserEmailVerificationInterface $user_email_verification_service
   *   User email verification helper service.
   * @param \Drupal\Core\Session\AccountProxyInterface $current_user
   *   The current active user.
   * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
   *   The request stack.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   */
  public function __construct(UserEmailVerificationInterface $user_email_verification_service, AccountProxyInterface $current_user, RequestStack $request_stack, ConfigFactoryInterface $config_factory) {
    $this->userEmailVerification = $user_email_verification_service;
    $this->currentUser = $current_user;
    $this->request = $request_stack
      ->getCurrentRequest();
    $this->configUserSettings = $config_factory
      ->get('user.settings');
  }

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

  /**
   * Returns a unique string identifying the form.
   *
   * @return string
   *   The unique string identifying the form.
   */
  public function getFormId() {
    return 'user_email_verification_request_form';
  }

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

    // Prevent form usage with users who already verified email.
    if ($this->currentUser
      ->isAuthenticated() && !$this->userEmailVerification
      ->isVerificationNeeded()) {
      return [
        'notification' => [
          '#markup' => $this
            ->t('Your Email %email was already verified.', [
            '%email' => $this->currentUser
              ->getEmail(),
          ]),
          '#prefix' => '<p>',
          '#suffix' => '</p>',
        ],
      ];
    }
    if ($this->currentUser
      ->isAnonymous()) {
      $form['name'] = [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Username or Email address'),
        '#size' => 40,
        '#maxlength' => max(UserInterface::USERNAME_MAX_LENGTH, Email::EMAIL_MAX_LENGTH),
        '#required' => TRUE,
        '#default_value' => $this->request->query
          ->get('name', ''),
      ];
    }
    else {
      $form['name'] = [
        '#type' => 'value',
        '#value' => $this->currentUser
          ->getEmail(),
      ];
      $form['mail'] = [
        '#markup' => $this
          ->t('Verify email message will be send to %email.', [
          '%email' => $this->currentUser
            ->getEmail(),
        ]),
        '#prefix' => '<p>',
        '#suffix' => '</p>',
      ];
    }
    $form['uid'] = [
      '#type' => 'value',
      '#value' => 0,
    ];
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Send verify mail'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $name_or_email = trim($form_state
      ->getValue('name', ''));
    if ($name_or_email) {
      $active_users_only = $this->configUserSettings
        ->get('register') != UserInterface::REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL;
      $user = $this->userEmailVerification
        ->getUserByNameOrEmail($name_or_email, $active_users_only);
      if ($user instanceof UserInterface) {
        $form_state
          ->setValue('uid', $user
          ->id());
      }
      else {
        $form_state
          ->setErrorByName('name', $this
          ->t('Sorry, %name is not recognized as a user name or an Email address.', [
          '%name' => $name_or_email,
        ]));
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $uid = trim($form_state
      ->getValue('uid', 0));
    if ($uid) {
      $this->userEmailVerification
        ->sendVerifyMailById($uid);
      $this
        ->messenger()
        ->addStatus($this
        ->t('Further instructions have been sent to the Email address of a requested user.'));
      if ($this->currentUser
        ->isAuthenticated()) {
        $form_state
          ->setRedirect('entity.user.canonical', [
          'user' => $uid,
        ]);
      }
      else {
        $form_state
          ->setRedirect('<front>');
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::config protected function Retrieves a configuration object.
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.
UserEmailVerificationRequestForm::$configUserSettings protected property The user.settings config object.
UserEmailVerificationRequestForm::$currentUser protected property The current active user.
UserEmailVerificationRequestForm::$request protected property The currently active request object.
UserEmailVerificationRequestForm::$userEmailVerification protected property User email verification helper service.
UserEmailVerificationRequestForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
UserEmailVerificationRequestForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
UserEmailVerificationRequestForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
UserEmailVerificationRequestForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
UserEmailVerificationRequestForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
UserEmailVerificationRequestForm::__construct public function Constructs a new UserEmailVerificationRequestForm object.