class MiniorangeMapping in Drupal OAuth & OpenID Connect Login - OAuth2 Client SSO Login 8

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\miniorange_oauth_client\Form\MiniorangeMapping

Expanded class hierarchy of MiniorangeMapping

1 string reference to 'MiniorangeMapping'

miniorange_oauth_client.routing.yml in ./miniorange_oauth_client.routing.yml: miniorange_oauth_client.routing.yml

File

src/Form/MiniorangeMapping.php, line 16: Contains \Drupal\miniorange_oauth_client\Form\MiniorangeGeneralSettings.

Namespace

Drupal\miniorange_oauth_client\Form

View source

class MiniorangeMapping extends FormBase {

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'miniorange_mapping';
  }
  public function buildForm(array $form, FormStateInterface $form_state) {
    global $base_url;
    $moTour = mo_saml_visualTour::genArray();
    $form['tourArray'] = array(
      '#type' => 'hidden',
      '#value' => $moTour,
    );
    $form['markup_library'] = array(
      '#attached' => array(
        'library' => array(
          "miniorange_oauth_client/miniorange_oauth_client.admin",
          "miniorange_oauth_client/miniorange_oauth_client.style_settings",
          "miniorange_oauth_client/miniorange_oauth_client.Vtour",
          "miniorange_oauth_client/miniorange_oauth_client.slide_support_button",
        ),
      ),
    );
    $form['header_top_style_1'] = array(
      '#markup' => '<div class="mo_oauth_table_layout_1">',
    );
    $form['markup_top'] = array(
      '#markup' => '<div class="mo_oauth_table_layout mo_oauth_container">',
    );
    $form['markup_top_vt_start'] = array(
      '#type' => 'fieldset',
      '#title' => t('ATTRIBUTE MAPPING'),
      '#attributes' => array(
        'style' => 'padding:2% 2% 5%; margin-bottom:2%',
      ),
      '#markup' => '<a id="Restart_moTour" class="mo_oauth_btn mo_oauth_btn-primary-color mo_oauth_btn-large mo_oauth_btn_restart_tour">Take a Tour</a><br>',
    );
    $module_path = \Drupal::service('extension.list.module')
      ->getPath('miniorange_oauth_client');
    $email_attr = \Drupal::config('miniorange_oauth_client.settings')
      ->get('miniorange_oauth_client_email_attr_val');
    $name_attr = \Drupal::config('miniorange_oauth_client.settings')
      ->get('miniorange_oauth_client_name_attr_val');
    $form['markup_top_vt_start']['mo_vt_id_start1'] = array(
      '#markup' => '<br><hr><br><div id = "mo_oauth_vt_attrn" class="container-inline"> <b>Note: </b>Please copy the attribute name with <b>email</b> and <b>username</b> from the <b>Test Configuration</b> window for successful SSO.<br><br>',
    );
    $form['markup_top_vt_start']['miniorange_oauth_client_email_attr_title'] = array(
      '#markup' => '<div class="mo_oauth_attr_mapping_label"><b>Email Attribute: </b> <div class="mo_oauth_tooltip"><img src="' . $base_url . '/' . $module_path . '/includes/images/info.png" alt="info icon" height="15px" width="15px"></div><div class="mo_oauth_tooltiptext">This field is mandatory for login</div></div>',
    );
    $attrs = \Drupal::config('miniorange_oauth_client.settings')
      ->get('miniorange_oauth_client_attr_list_from_server');
    $attrs = json_decode($attrs, TRUE);
    $options = array();
    if (is_array($attrs)) {
      foreach ($attrs as $key => $value) {
        if (is_array($value)) {
          foreach ($value as $key1 => $value1) {
            $options[$key1] = $key1;
          }
          continue;
        }
        $options[$key] = $key;
      }
    }
    $options['other'] = 'other';
    $form['markup_top_vt_start']['miniorange_oauth_client_email_attr'] = array(
      '#type' => 'select',
      '#id' => 'mo_oauth_email_attribute',
      '#default_value' => $email_attr,
      '#options' => $options,
      '#attributes' => array(
        'style' => 'max-width: 130% !important; width:130%; padding: 5px; border-radius: 4px;',
        'placeholder' => 'Enter Email Attribute',
      ),
    );
    if ($email_attr == 'other') {
      $other_email_attr = \Drupal::config('miniorange_oauth_client.settings')
        ->get('miniorange_oauth_client_other_field_for_email');
    }
    else {
      $other_email_attr = '';
    }
    $form['markup_top_vt_start']['miniorange_oauth_client_other_field_for_email'] = array(
      '#type' => 'textfield',
      '#default_value' => $other_email_attr,
      '#id' => 'miniorange_oauth_client_other_field_for_email',
      '#attributes' => array(
        'style' => 'display:none; max-width:220px; margin-left: 20%',
        'placeholder' => 'Enter Email Attribute',
      ),
      '#prefix' => '<div class="mo_oauth_attr_mapping_select_element">',
      '#suffix' => '</div>',
    );
    $form['markup_top_vt_start']['mo_vt_id_end1'] = array(
      '#markup' => '</div>',
    );
    $form['markup_top_vt_start']['mo_vt_id_start2'] = array(
      '#markup' => '<div id = "mo_oauth_vt_attre" class="container-inline">',
    );
    $form['markup_top_vt_start']['miniorange_oauth_client_name_attr_title'] = array(
      '#markup' => '<div class="mo_oauth_attr_mapping_label"><b>Username Attribute: </b> <div class="mo_oauth_tooltip"><img src="' . $base_url . '/' . $module_path . '/includes/images/info.png" alt="info icon" height="15px" width="15px"></div><div class="mo_oauth_tooltiptext"><b>Note:</b> If this text field is empty, then by default email id will be the user\'s username</div></div>',
    );
    $form['markup_top_vt_start']['miniorange_oauth_client_name_attr'] = array(
      '#type' => 'select',
      '#default_value' => isset($name_attr) ? $name_attr : 'other',
      '#id' => 'mo_oauth_name_attribute',
      '#options' => $options,
      '#attributes' => array(
        'style' => 'max-width: 130% !important; width:130%; padding: 5px; border-radius: 4px;',
        'placeholder' => 'Enter Username Attribute',
      ),
    );
    if ($name_attr == 'other') {
      $other_name_attr = \Drupal::config('miniorange_oauth_client.settings')
        ->get('miniorange_oauth_client_other_field_for_name');
    }
    else {
      $other_name_attr = '';
    }
    $form['markup_top_vt_start']['miniorange_oauth_client_other_field_for_name'] = array(
      '#type' => 'textfield',
      '#default_value' => $other_name_attr,
      '#id' => 'miniorange_oauth_client_other_field_for_name',
      '#attributes' => array(
        'style' => 'display:none; max-width:220px; margin-left: 20%;',
        'placeholder' => 'Enter Username Attribute',
      ),
      '#prefix' => '<div class="mo_oauth_attr_mapping_select_element">',
      '#suffix' => '</div>',
    );
    $form['markup_top_vt_start']['mo_vt_id_end2'] = array(
      '#markup' => '</div>',
    );
    $form['markup_top_vt_start']['miniorange_oauth_client_attr_setup_button_2'] = array(
      '#type' => 'submit',
      '#button_type' => 'primary',
      '#value' => t('Save Configuration'),
      '#prefix' => '<br>',
      '#attributes' => array(
        'style' => '	margin: auto; display:block; ',
      ),
      '#submit' => array(
        '::miniorange_oauth_client_attr_setup_submit',
      ),
    );
    $form['markup_custom_attribute'] = array(
      '#type' => 'fieldset',
      '#title' => t('CUSTOM ATTRIBUTE MAPPING <a href="' . $base_url . '/admin/config/people/miniorange_oauth_client/licensing"> [STANDARD, PREMIUM, ENTERPRISE]</a>'),
      '#attributes' => array(
        'style' => 'padding:2% 2% 5%; margin-bottom:2%',
      ),
    );
    $form['markup_custom_attribute']['markup_cam'] = array(
      '#markup' => '<br><hr><br><div class="mo_oauth_highlight_background_note_1">Add the Drupal field attributes in the Attribute Name textfield and add the OAuth Server attributes that you need to map with the drupal attributes in the OAuth Server Attribute Name textfield.
                       Drupal Field Attributes will be of type text. Add the machine name of the attribute in the Drupal Attribute textfield.
                      <b>For example: </b>If the attribute name in the drupal is name then its machine name will be field_name.</div><br>',
    );
    $form['markup_custom_attribute']['miniorange_oauth_attr_name'] = array(
      '#type' => 'textfield',
      '#prefix' => '<div><table><tr><td>',
      '#suffix' => '</td>',
      '#id' => 'text_field1',
      '#title' => t('OAuth Server Attribute Name 1'),
      '#attributes' => array(
        'style' => 'width:73%;background-color: hsla(0,0%,0%,0.08) !important;',
        'placeholder' => 'OAuth Server Attribute Name',
      ),
      '#required' => FALSE,
      '#disabled' => TRUE,
    );
    $form['markup_custom_attribute']['miniorange_oauth_server_name'] = array(
      '#type' => 'textfield',
      '#id' => 'text_field2',
      '#prefix' => '<td>',
      '#suffix' => '</td>',
      '#title' => t('Attribute Name 1'),
      '#attributes' => array(
        'style' => 'width:73%;background-color: hsla(0,0%,0%,0.08) !important;',
        'placeholder' => 'Enter Attribute Name',
      ),
      '#required' => FALSE,
      '#disabled' => TRUE,
    );
    $form['markup_custom_attribute']['miniorange_oauth_add_name'] = array(
      '#prefix' => '<td>',
      '#suffix' => '</td>',
      '#type' => 'button',
      '#disabled' => 'true',
      '#attributes' => array(
        'style' => 'background-color: lightgreen;color:white',
      ),
      '#value' => '+',
    );
    $form['markup_custom_attribute']['miniorange_oauth_sub_name'] = array(
      '#prefix' => '<td>',
      '#suffix' => '</td></tr></table></div>',
      '#type' => 'button',
      '#disabled' => 'true',
      '#attributes' => array(
        'style' => 'background-color: red;color:white',
      ),
      '#value' => '-',
    );
    $form['markup_custom_role_mapping'] = array(
      '#type' => 'fieldset',
      '#title' => t('CUSTOM ROLE MAPPING <a href="' . $base_url . '/admin/config/people/miniorange_oauth_client/licensing"> [PREMIUM, ENTERPRISE]</a>'),
      '#attributes' => array(
        'style' => 'padding:2% 2% 5%; margin-bottom:2%',
      ),
    );
    $form['markup_custom_role_mapping']['miniorange_disable_attribute'] = array(
      '#type' => 'checkbox',
      '#title' => t('Do not update existing user&#39;s role.'),
      '#disabled' => TRUE,
      '#prefix' => '<br><hr><br>',
    );
    $form['markup_custom_role_mapping']['miniorange_oauth_disable_role_update'] = array(
      '#type' => 'checkbox',
      '#title' => t('Check this option if you do not want to update user role if roles not mapped.'),
      '#disabled' => TRUE,
    );
    $mrole = user_role_names($membersonly = TRUE);
    $drole = array_values($mrole);
    $form['markup_custom_role_mapping']['miniorange_oauth_default_mapping'] = array(
      '#type' => 'select',
      '#id' => 'miniorange_oauth_client_app',
      '#title' => t('Select default group for the new users'),
      '#options' => $mrole,
      '#default_value' => $drole,
      '#attributes' => array(
        'style' => 'width:73%;',
      ),
      '#disabled' => TRUE,
    );
    foreach ($mrole as $roles) {
      $rolelabel = str_replace(' ', '', $roles);
      $form['markup_custom_role_mapping']['miniorange_oauth_role_' . $rolelabel] = array(
        '#type' => 'textfield',
        '#title' => t($roles),
        '#default_value' => \Drupal::config('miniorange_oauth_client.settings')
          ->get('miniorange_oauth_role_' . $rolelabel, ''),
        '#attributes' => array(
          'style' => 'width:73%;background-color: hsla(0,0%,0%,0.08) !important;',
          'placeholder' => 'Semi-colon(;) separated Group/Role value for ' . $roles,
        ),
        '#disabled' => TRUE,
      );
    }
    $form['markup_custom_role_mapping']['markup_role_signin'] = array(
      '#markup' => '<div class="custom-login-logout mo_oauth_custom_login_logout"><br><strong>Custom Login/Logout (Optional)</strong><hr></div>',
    );
    $form['markup_custom_role_mapping']['miniorange_oauth_client_login_url'] = array(
      '#type' => 'textfield',
      '#id' => 'text_field3',
      '#required' => FALSE,
      '#disabled' => TRUE,
      '#attributes' => array(
        'style' => 'width:73%;background-color: hsla(0,0%,0%,0.08) !important;',
        'placeholder' => 'Enter Login URL',
      ),
    );
    $form['markup_custom_role_mapping']['miniorange_oauth_client_logout_url'] = array(
      '#type' => 'textfield',
      '#id' => 'text_field4',
      '#required' => FALSE,
      '#disabled' => TRUE,
      '#attributes' => array(
        'style' => 'width:73%;background-color: hsla(0,0%,0%,0.08) !important;',
        'placeholder' => 'Enter Logout URL',
      ),
    );
    $form['markup_custom_role_mapping']['markup_role_break'] = array(
      '#markup' => '<br>',
    );
    $form['markup_custom_role_mapping']['miniorange_oauth_client_attr_setup_button'] = array(
      '#type' => 'submit',
      '#button_type' => 'primary',
      '#value' => t('Save Configuration'),
      '#attributes' => array(
        'style' => '	margin: auto; display:block; ',
      ),
      '#disabled' => TRUE,
    );
    $form['markup_custom_role_mapping']['mo_header_style_end'] = array(
      '#markup' => '</div>',
    );
    Utilities::show_attr_list_from_idp($form, $form_state);
    $form['miniorange_idp_guide_link_end'] = array(
      '#markup' => '</div>',
    );
    Utilities::AddSupportButton($form, $form_state);
    return $form;
  }
  public function submitForm(array &$form, FormStateInterface $form_state) {
  }
  function miniorange_oauth_client_attr_setup_submit($form, $form_state) {
    $email_attr = trim($form['markup_top_vt_start']['miniorange_oauth_client_email_attr']['#value']);
    $name_attr = trim($form['markup_top_vt_start']['miniorange_oauth_client_name_attr']['#value']);
    $app_name = \Drupal::config('miniorange_oauth_client.settings')
      ->get('miniorange_auth_client_app_name');
    $app_values = \Drupal::config('miniorange_oauth_client.settings')
      ->get('miniorange_oauth_client_appval');
    if ($email_attr == 'other') {
      $other_email_attr = trim($form['markup_top_vt_start']['miniorange_oauth_client_other_field_for_email']['#value']);
      $app_values['miniorange_oauth_client_email_attr'] = $other_email_attr;
      \Drupal::configFactory()
        ->getEditable('miniorange_oauth_client.settings')
        ->set('miniorange_oauth_client_other_field_for_email', $other_email_attr)
        ->save();
    }
    else {
      $app_values['miniorange_oauth_client_email_attr'] = $email_attr;
    }
    if ($name_attr == 'other') {
      $other_name_attr = trim($form['markup_top_vt_start']['miniorange_oauth_client_other_field_for_name']['#value']);
      $app_values['miniorange_oauth_client_name_attr'] = $other_name_attr;
      \Drupal::configFactory()
        ->getEditable('miniorange_oauth_client.settings')
        ->set('miniorange_oauth_client_other_field_for_name', $other_name_attr)
        ->save();
    }
    else {
      $app_values['miniorange_oauth_client_name_attr'] = $name_attr;
    }
    \Drupal::configFactory()
      ->getEditable('miniorange_oauth_client.settings')
      ->set('miniorange_oauth_client_email_attr_val', $email_attr)
      ->save();
    \Drupal::configFactory()
      ->getEditable('miniorange_oauth_client.settings')
      ->set('miniorange_oauth_client_name_attr_val', $name_attr)
      ->save();
    \Drupal::configFactory()
      ->getEditable('miniorange_oauth_client.settings')
      ->set('miniorange_oauth_client_appval', $app_values)
      ->save();
    \Drupal::messenger()
      ->addMessage(t('Attribute Mapping saved successfully. Please logout and go to your Drupal site’s login page, you will automatically find a <b>Login with ' . $app_name . '</b> link there.'), 'status');
  }

  /**
   * Send support query.
   */
  public function saved_support(array &$form, FormStateInterface $form_state) {
    $email = trim($form['miniorange_oauth_client_email_address']['#value']);
    $phone = $form['miniorange_oauth_client_phone_number']['#value'];
    $query = trim($form['miniorange_oauth_client_support_query']['#value']);
    Utilities::send_support_query($email, $phone, $query);
  }
  function clear_attr_list(&$form, $form_state) {
    \Drupal::configFactory()
      ->getEditable('miniorange_oauth_client.settings')
      ->clear('miniorange_oauth_client_attr_list_from_server')
      ->save();
    Utilities::show_attr_list_from_idp($form, $form_state);
  }
  public function rfd(array &$form, FormStateInterface $form_state) {
    global $base_url;
    $response = new RedirectResponse($base_url . "/admin/config/people/miniorange_oauth_client/request_for_demo");
    $response
      ->send();
  }

}

Members

Name	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.
MiniorangeMapping::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
MiniorangeMapping::clear_attr_list		function
MiniorangeMapping::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
MiniorangeMapping::miniorange_oauth_client_attr_setup_submit		function
MiniorangeMapping::rfd	public	function
MiniorangeMapping::saved_support	public	function	Send support query.
MiniorangeMapping::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.

You are here

class MiniorangeMapping in Drupal OAuth & OpenID Connect Login - OAuth2 Client SSO Login 8

Hierarchy

File

Namespace

Members

API Navigation