You are here

Home » API reference » Google Authenticator / 2 Factor Authentication - 2FA 8.2 » UserMfaSetup.php

class UserMfaSetup in Google Authenticator / 2 Factor Authentication - 2FA 8.2

Hierarchy

Expanded class hierarchy of UserMfaSetup

File

src/Form/UserMfaSetup.php, line 9

Namespace

Drupal\miniorange_2fa\form
View source 
class UserMfaSetup extends FormBase {
  private $entityId;
  private $savedFields;
  private $isAdmin;
  private $tfaRequired;
  public function __construct() {
    $url_parts = MoAuthUtilities::mo_auth_get_url_parts();
    end($url_parts);
    $this->entityId = prev($url_parts);
    $this->savedFields = MoAuthUtilities::get_users_custom_attribute($this->entityId);
    $account = $this
      ->currentUser();
    $this->isAdmin = $account
      ->isAuthenticated() && $account
      ->hasPermission('administer users');
    $user = User::load(intval($this->entityId));
    $this->tfaRequired = MoAuthUtilities::isTFARequired($user
      ->getRoles(), $user
      ->getEmail());
  }

  /**
   * Returns a unique string identifying the form.
   *
   * The returned ID should be a unique string that can be a valid PHP function
   * name, since it's used in hook implementation names such as
   * hook_form_FORM_ID_alter().
   *
   * @return string
   *   The unique string identifying the form.
   */
  public function getFormId() {
    return "mo_mfa_form";
  }

  /**
   * Form constructor.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return array
   *   The form structure.
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $variables_and_values = array(
      'mo_auth_enable_two_factor',
    );
    $mo_db_values = MoAuthUtilities::miniOrange_set_get_configurations($variables_and_values, 'GET');
    \Drupal::service('page_cache_kill_switch')
      ->trigger();
    $account = $this
      ->currentUser();

    // We can't let you see the settings if you are not admin and trying to edit 2FA for some other user
    if (!$mo_db_values['mo_auth_enable_two_factor'] || !MoAuthUtilities::isUserCanSee2FASettings() || !$this->isAdmin && $account
      ->id() !== $this->entityId) {
      return $form;
    }
    $form['mo_mfa_enable'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable MFA for your account'),
      '#default_value' => empty($this->savedFields) || !array_key_exists("enabled", (array) $this->savedFields[0]) ? 0 : $this->savedFields[0]->enabled,
      '#description' => $this
        ->t('Note: You will not be prompted for 2FA if you disable this'),
    );
    $form['mo_mfa_form_save'] = array(
      '#type' => 'submit',
      '#value' => $this
        ->t('Submit'),
    );
    return $form;
  }

  /**
   * Form submission handler.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $formValues = $form_state
      ->getValues();
    if (!$this->isAdmin && $formValues["mo_mfa_enable"] === 0) {

      // TFA required means you are secured users and skipNotAllowed for you the
      if (MoAuthUtilities::isSkipNotAllowed($this->entityId)) {
        $this
          ->messenger()
          ->addError($this
          ->t("You are not allowed to disable 2FA. Please ask the site administrator"));
        return;
      }
    }
    MoAuthUtilities::updateMfaSettingsForUser($this->entityId, $formValues["mo_mfa_enable"]);
    $this
      ->messenger()
      ->addStatus($this
      ->t('2FA settings are updated for your account'));
  }

}

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::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 87
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.
UserMfaSetup::$entityId private property
UserMfaSetup::$isAdmin private property
UserMfaSetup::$savedFields private property
UserMfaSetup::$tfaRequired private property
UserMfaSetup::buildForm public function Form constructor. Overrides FormInterface::buildForm
UserMfaSetup::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
UserMfaSetup::submitForm public function Form submission handler. Overrides FormInterface::submitForm
UserMfaSetup::__construct public function