You are here

Home » API reference » SAML SP 2.0 Single Sign On (SSO) - SAML Service Provider 8 » MiniorangeSamlCustomerSetup.php

class MiniorangeSamlCustomerSetup in SAML SP 2.0 Single Sign On (SSO) - SAML Service Provider 8

Hierarchy

Expanded class hierarchy of MiniorangeSamlCustomerSetup

1 string reference to 'MiniorangeSamlCustomerSetup'
miniorange_saml.routing.yml in ./miniorange_saml.routing.yml
miniorange_saml.routing.yml

File

src/Form/MiniorangeSamlCustomerSetup.php, line 15
Contains \Drupal\miniorange_saml\Form\MiniorangeSamlCustomerSetup.

Namespace

Drupal\miniorange_saml\Form
View source 
class MiniorangeSamlCustomerSetup extends FormBase {
  public function getFormId() {
    return 'miniorange_saml_customer_setup';
  }
  public function buildForm(array $form, FormStateInterface $form_state) {
    global $base_url;
    $current_status = \Drupal::config('miniorange_saml.settings')
      ->get('miniorange_saml_status');
    $form['miniorange_saml_markup_library'] = array(
      '#attached' => array(
        'library' => array(
          'miniorange_saml/miniorange_saml.admin',
        ),
      ),
    );
    if ($current_status == 'VALIDATE_OTP') {

      /**
       * Create container to hold @moVlidateOTPTab form elements.
       */
      $form['mo_saml_validate_OTP_tab'] = array(
        '#type' => 'fieldset',
        '#title' => t('Validate OTP'),
        '#attributes' => array(
          'style' => 'padding:2% 2% 40%; margin-bottom:2%',
        ),
        '#prefix' => '<div class="mo_saml_sp_table_layout_1"><div class="mo_saml_table_layout mo_saml_sp_container">',
      );
      $form['mo_saml_validate_OTP_tab']['miniorange_saml_customer_otp_token'] = array(
        '#type' => 'textfield',
        '#title' => t('Enter OTP <span style="color: #FF0000">*</span>'),
        '#attributes' => array(
          'style' => 'width:80%',
        ),
        '#description' => t('<strong>Note:</strong> We have sent an OTP. Please enter the OTP to verify your email.'),
        '#prefix' => '<br><hr><br>',
      );
      $form['mo_saml_validate_OTP_tab']['miniorange_saml_customer_validate_otp_button'] = array(
        '#type' => 'submit',
        '#button_type' => 'primary',
        '#value' => t('Validate OTP'),
        '#submit' => array(
          '::miniorange_saml_validate_otp_submit',
        ),
      );
      $form['mo_saml_validate_OTP_tab']['miniorange_saml_customer_setup_resendotp'] = array(
        '#type' => 'submit',
        '#value' => t('Resend OTP'),
        '#submit' => array(
          '::miniorange_saml_resend_otp',
        ),
      );
      $form['mo_saml_validate_OTP_tab']['miniorange_saml_customer_setup_back'] = array(
        '#type' => 'submit',
        '#button_type' => 'danger',
        '#value' => t('Back'),
        '#submit' => array(
          '::miniorange_saml_back',
        ),
        '#suffix' => '<br></div>',
      );
      Utilities::advertiseNetworkSecurity($form, $form_state);
      return $form;
    }
    elseif ($current_status == 'PLUGIN_CONFIGURATION') {
      $form['markup_top'] = array(
        '#markup' => t('<div class="mo_saml_sp_table_layout_1"><div class="mo_saml_table_layout mo_saml_sp_container">
                                  <div class="mo_saml_welcome_message">Thank you for registering with miniOrange</div>'),
      );

      /**
       * Create container to hold @moProfileDetails form elements.
       */
      $form['mo_saml_profile_details_tab'] = array(
        '#type' => 'fieldset',
        '#title' => t('Profile Details:'),
        '#attributes' => array(
          'style' => 'padding:2% 2% 6%; margin-bottom:2%',
        ),
      );
      $header = array(
        t('Customer Email'),
        t('Customer ID'),
        t('Token Key'),
        t('API Key'),
      );
      $options = array(
        array(
          \Drupal::config('miniorange_saml.settings')
            ->get('miniorange_saml_customer_admin_email'),
          \Drupal::config('miniorange_saml.settings')
            ->get('miniorange_saml_customer_id'),
          \Drupal::config('miniorange_saml.settings')
            ->get('miniorange_saml_customer_admin_token'),
          \Drupal::config('miniorange_saml.settings')
            ->get('miniorange_saml_customer_api_key'),
        ),
      );
      $form['mo_saml_profile_details_tab']['fieldset']['customerinfo'] = array(
        '#theme' => 'table',
        '#header' => $header,
        '#rows' => $options,
        '#prefix' => '<br>',
        '#attributes' => array(
          'style' => 'margin:1% 0% 7%;',
        ),
      );
      $form['mo_saml_profile_details_tab']['miniorange_saml_customer_Remove_Account_info'] = array(
        '#markup' => t('<br><br><br><br><br><br/><h4>Remove Account:</h4><p>This section will help you to remove your current
                        logged in account without losing your current configurations.</p>'),
      );
      $form['mo_saml_profile_details_tab']['miniorange_saml_customer_Remove_Account'] = array(
        '#type' => 'link',
        '#title' => $this
          ->t('Remove Account'),
        '#url' => Url::fromRoute('miniorange_saml.modal_form'),
        '#attributes' => [
          'class' => [
            'use-ajax',
            'button',
          ],
        ],
        '#suffix' => '</div>',
      );
      $form['#attached']['library'][] = 'core/drupal.dialog.ajax';
      Utilities::advertiseNetworkSecurity($form, $form_state);
      return $form;
    }
    $url = $base_url . '/admin/config/people/miniorange_saml/customer_setup';
    $tab = isset($_GET['tab']) && $_GET['tab'] == 'login' ? $_GET['tab'] : 'register';
    $form['div_for_start'] = array(
      '#markup' => t('<div class="mo_saml_sp_table_layout_1"><div class="mo_saml_table_layout mo_saml_sp_container"'),
    );
    if ($tab == 'register') {
      $form['markup_14'] = array(
        '#markup' => t('<div><div class="mo_saml_font_for_heading">Register with mini<span class="mo_orange"><b>O</b></span>range</div><p style="clear: both"></p><hr>'),
      );

      /**
       * Create container to hold @moSAMLRegistrationTab form elements.
       */
      $form['mo_saml_registration_tab'] = array(
        '#type' => 'fieldset',
        '#title' => t('Why should I register?'),
        '#attributes' => array(
          'style' => 'padding:2% 2% 5%; margin-bottom:2%',
        ),
      );
      $form['mo_saml_registration_tab']['markup_msg_1'] = array(
        '#markup' => t('<br><div class="mo_saml_highlight_background_note_1">You should register so that in case you need help, we can help you with step by step instructions.
                    <b>You will also need a miniOrange account to upgrade to the premium version of the module.</b>
                    We do not store any information except the email that you will use to register with us.Please enter a valid email id that you have access to. We will send OTP to this email for verification.</div><br>'),
      );
      $form['mo_saml_registration_tab']['mo_register'] = array(
        '#markup' => t('<div class="mo_saml_highlight_background_note_1" style="width: auto">If you face any issues during registration then you can <b><a href="https://www.miniorange.com/businessfreetrial" target="_blank">click here</a></b> to register and use the same credentials below to login into the module.</div><br><div id="Register_Section">'),
      );
      $form['mo_saml_registration_tab']['miniorange_saml_customer_register_username'] = array(
        '#type' => 'email',
        '#title' => t('Email<span style="color: #FF0000">*</span>'),
        '#description' => t('<b>Note:</b> Use valid EmailId. (We discourage the use of disposable emails)'),
        '#attributes' => array(
          'style' => 'width:73%',
        ),
      );
      $form['mo_saml_registration_tab']['miniorange_saml_customer_register_phone'] = array(
        '#type' => 'textfield',
        '#title' => t('Phone'),
        '#description' => t('<b>Note:</b> We will only call if you need support.'),
        '#attributes' => array(
          'style' => 'width:73%',
        ),
      );
      $form['mo_saml_registration_tab']['miniorange_saml_customer_register_password'] = array(
        '#type' => 'password_confirm',
      );
      $form['mo_saml_registration_tab']['miniorange_saml_customer_register_button'] = array(
        '#type' => 'submit',
        '#value' => t('Register'),
        '#prefix' => '<br><div class="ns_row"><div class="ns_name">',
        '#suffix' => '</div>',
      );
      $form['mo_saml_registration_tab']['already_account_link'] = array(
        '#markup' => t('<a href="' . $url . '/?tab=login" class="mo_btn mo_btn-sm mo_btn-danger"><b>Already have an account?</b></a>'),
        '#prefix' => '<div class="ns_value">',
        '#suffix' => '</div></div></div></div><br>',
      );
    }
    else {
      $form['markup_15'] = array(
        '#markup' => t('<div>'),
      );

      /**
       * Create container to hold @moSAMLloginTab form elements.
       */
      $form['mo_saml_login_tab'] = array(
        '#type' => 'fieldset',
        '#title' => t('Login with mini<span class="mo_orange"><b>O</b></span>range'),
        '#attributes' => array(
          'style' => 'padding:2% 2% 5%; margin-bottom:2%',
        ),
      );
      $form['mo_saml_login_tab']['markup_16'] = array(
        '#markup' => t('<br><hr><br><div class="mo_saml_highlight_background_note_1" style="width:35% !important">Please login with your miniorange account.</br></div><br>'),
      );
      $form['mo_saml_login_tab']['miniorange_saml_customer_login_username'] = array(
        '#type' => 'email',
        '#title' => t('Email <span style="color: red">*</span>'),
        '#attributes' => array(
          'style' => 'width:50%',
        ),
      );
      $form['mo_saml_login_tab']['miniorange_saml_customer_login_password'] = array(
        '#type' => 'password',
        '#title' => t('Password <span style="color: red">*</span>'),
        '#attributes' => array(
          'style' => 'width:50%',
        ),
      );
      $form['mo_saml_login_tab']['miniorange_saml_customer_login_button'] = array(
        '#type' => 'submit',
        '#value' => t('Login'),
        '#prefix' => '<div class="ns_row"><div class="ns_name">',
        '#suffix' => '</div>',
      );
      $form['mo_saml_login_tab']['register_link'] = array(
        '#markup' => t('<a href="' . $url . '" class="mo_btn mo_btn-sm mo_btn-danger"><b>Create an account?</b></a>'),
        '#prefix' => '<div class="ns_value">',
        '#suffix' => '</div></div><br></div>',
      );
    }
    Utilities::advertiseNetworkSecurity($form, $form_state);
    return $form;
  }
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $form_values = $form_state
      ->getValues();
    $tab = isset($_GET['tab']) ? $_GET['tab'] : 'register';
    $phone = '';
    if ($tab == 'register') {
      $username = trim($form_values['miniorange_saml_customer_register_username']);
      $phone = trim($form_values['miniorange_saml_customer_register_phone']);
      $password = trim($form_values['miniorange_saml_customer_register_password']);
    }
    else {
      $username = trim($form_values['miniorange_saml_customer_login_username']);
      $password = trim($form_values['miniorange_saml_customer_login_password']);
    }
    if (empty($username) || empty($password)) {
      \Drupal::messenger()
        ->addMessage(t('The <b><u>Email Address</u></b> and <b><u>Password</u></b> fields are mandatory.'), 'error');
      return;
    }
    if ($tab == 'register') {
      Utilities::customer_setup_submit($username, $phone, $password);
    }
    else {
      Utilities::customer_setup_submit($username, $phone, $password, true);
    }
  }

  /**
   * Handle back button submit for customer setup.
   */
  function miniorange_saml_back(&$form, $form_state) {
    Utilities::saml_back();
  }

  /**
   * Resend OTP.
   */
  public function miniorange_saml_resend_otp(&$form, $form_state) {
    Utilities::saml_resend_otp();
  }

  /**
   * Validate OTP.
   */
  public function miniorange_saml_validate_otp_submit(&$form, FormStateInterface $form_state) {
    $form_values = $form_state
      ->getValues();
    $otp_token = trim($form_values['miniorange_saml_customer_otp_token']);
    if (empty($otp_token)) {
      \Drupal::messenger()
        ->addMessage(t('OTP field is required.'), 'error');
      return;
    }
    Utilities::validate_otp_submit($otp_token);
  }

}

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.
MiniorangeSamlCustomerSetup::buildForm public function Form constructor. Overrides FormInterface::buildForm
MiniorangeSamlCustomerSetup::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
MiniorangeSamlCustomerSetup::miniorange_saml_back function Handle back button submit for customer setup.
MiniorangeSamlCustomerSetup::miniorange_saml_resend_otp public function Resend OTP.
MiniorangeSamlCustomerSetup::miniorange_saml_validate_otp_submit public function Validate OTP.
MiniorangeSamlCustomerSetup::submitForm public function Form submission handler. Overrides FormInterface::submitForm
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.