You are here

Home » API reference » SMS Framework 8 » VerifyPhoneNumberForm.php

class VerifyPhoneNumberForm in SMS Framework 8

Form to accept a verification code.

Hierarchy

Expanded class hierarchy of VerifyPhoneNumberForm

File

src/Form/VerifyPhoneNumberForm.php, line 14

Namespace

Drupal\sms\Form
View source 
class VerifyPhoneNumberForm extends FormBase {

  /**
   * The flood control mechanism.
   *
   * @var \Drupal\Core\Flood\FloodInterface
   */
  protected $flood;

  /**
   * The phone number verification service.
   *
   * @var \Drupal\sms\Provider\PhoneNumberVerificationInterface
   */
  protected $phoneNumberVerification;

  /**
   * Constructs a VerifyPhoneNumberForm object.
   *
   * @param \Drupal\Core\Flood\FloodInterface $flood
   *   The flood control mechanism.
   * @param \Drupal\sms\Provider\PhoneNumberVerificationInterface $phone_number_verification
   *   The phone number verification service.
   */
  public function __construct(FloodInterface $flood, PhoneNumberVerificationInterface $phone_number_verification) {
    $this->flood = $flood;
    $this->phoneNumberVerification = $phone_number_verification;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('flood'), $container
      ->get('sms.phone_number.verification'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['code'] = [
      '#title' => $this
        ->t('Verification code'),
      '#description' => $this
        ->t('Enter the code you received from a SMS message.'),
      '#type' => 'textfield',
      '#required' => TRUE,
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => t('Verify code'),
      '#button_type' => 'primary',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $flood_window = $this
      ->config('sms.settings')
      ->get('flood.verify_window');
    $flood_limit = $this
      ->config('sms.settings')
      ->get('flood.verify_limit');
    if (!$this->flood
      ->isAllowed('sms.verify_phone_number', $flood_limit, $flood_window)) {
      $form_state
        ->setError($form, $this
        ->t('There has been too many failed verification attempts. Try again later.'));
      return;
    }
    $current_time = $this
      ->getRequest()->server
      ->get('REQUEST_TIME');
    $code = $form_state
      ->getValue('code');
    $phone_verification = $this->phoneNumberVerification
      ->getPhoneVerificationByCode($code);
    if ($phone_verification && !$phone_verification
      ->getStatus()) {
      $entity = $phone_verification
        ->getEntity();
      $phone_number_settings = $this->phoneNumberVerification
        ->getPhoneNumberSettingsForEntity($entity);
      $lifetime = $phone_number_settings
        ->getVerificationCodeLifetime() ?: 0;
      if ($current_time > $phone_verification
        ->getCreatedTime() + $lifetime) {
        $form_state
          ->setError($form['code'], $this
          ->t('Verification code is expired.'));
      }
    }
    else {
      $form_state
        ->setError($form['code'], $this
        ->t('Invalid verification code.'));
    }
    $this->flood
      ->register('sms.verify_phone_number', $flood_window);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $code = $form_state
      ->getValue('code');
    $phone_verification = $this->phoneNumberVerification
      ->getPhoneVerificationByCode($code);
    $phone_verification
      ->setStatus(TRUE)
      ->setCode('')
      ->save();
    drupal_set_message($this
      ->t('Phone number is now verified.'));
  }

}

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.
VerifyPhoneNumberForm::$flood protected property The flood control mechanism.
VerifyPhoneNumberForm::$phoneNumberVerification protected property The phone number verification service.
VerifyPhoneNumberForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
VerifyPhoneNumberForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
VerifyPhoneNumberForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
VerifyPhoneNumberForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
VerifyPhoneNumberForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
VerifyPhoneNumberForm::__construct public function Constructs a VerifyPhoneNumberForm object.