class BasicSettingsForm in Auth0 Single Sign On 8

This forms handles the basic module configurations.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\auth0\Form\BasicSettingsForm

1 string reference to 'BasicSettingsForm'

auth0.routing.yml in ./auth0.routing.yml

auth0.routing.yml

File

src/Form/BasicSettingsForm.php, line 15

Contains \Drupal\auth0\Form\BasicSettingsForm.

Namespace

Drupal\auth0\Form

class BasicSettingsForm extends FormBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = \Drupal::service('config.factory')
      ->get('auth0.settings');
    $form['auth0_client_id'] = array(
      '#type' => 'textfield',
      '#title' => t('Client id'),
      '#default_value' => $config
        ->get('auth0_client_id', ''),
      '#description' => t('Application id, copy from the auth0 dashboard.'),
      '#required' => TRUE,
    );
    $form['auth0_client_secret'] = array(
      '#type' => 'textfield',
      '#title' => t('Client secret'),
      '#default_value' => $config
        ->get('auth0_client_secret', ''),
      '#description' => t('Application secret, copy from the auth0 dashboard.'),
      '#required' => TRUE,
    );
    $form['auth0_secret_base64_encoded'] = array(
      '#type' => 'checkbox',
      '#title' => t('Client Secret is Base64 Encoded'),
      '#default_value' => $config
        ->get('auth0_secret_base64_encoded'),
      '#description' => t('This is stated below the client secret in your Auth0 Dashboard for the client.  If your client was created after September 2016, this should be false.'),
    );
    $form['auth0_domain'] = array(
      '#type' => 'textfield',
      '#title' => t('Domain'),
      '#default_value' => $config
        ->get('auth0_domain', ''),
      '#description' => t('Your Auth0 domain, you can see it in the auth0 dashboard.'),
      '#required' => TRUE,
    );
    $form['auth0_jwt_signature_alg'] = array(
      '#type' => 'select',
      '#title' => t('JWT Signature Algorithm'),
      '#options' => [
        'HS256' => $this
          ->t('HS256'),
        'RS256' => $this
          ->t('RS256'),
      ],
      '#default_value' => $config
        ->get('auth0_jwt_signature_alg', 'HS256'),
      '#description' => t('Your JWT Signing Algorithm for the ID token.  RS256 is recommended, but must be set in the advanced settings under oauth for this client.'),
      '#required' => TRUE,
    );
    $form['actions']['#type'] = 'actions';
    $form['actions']['submit'] = array(
      '#type' => 'submit',
      '#value' => $this
        ->t('Save'),
      '#button_type' => 'primary',
    );
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    if (empty($form_state
      ->getValue('auth0_client_id'))) {
      $form_state
        ->setErrorByName('auth0_client_id', $this
        ->t('Please complete the application Client ID'));
    }
    if (empty($form_state
      ->getValue('auth0_client_secret'))) {
      $form_state
        ->setErrorByName('auth0_client_secret', $this
        ->t('Please complete the application Client Secret'));
    }
    if (empty($form_state
      ->getValue('auth0_domain'))) {
      $form_state
        ->setErrorByName('auth0_domain', $this
        ->t('Please complete your Auth0 domain'));
    }
    if (empty($form_state
      ->getValue('auth0_jwt_signature_alg'))) {
      $form_state
        ->setErrorByName('auth0_jwt_signature_alg', $this
        ->t('Please complete your Auth0 Signature Algorithm'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = \Drupal::service('config.factory')
      ->getEditable('auth0.settings');
    $config
      ->set('auth0_client_id', $form_state
      ->getValue('auth0_client_id'))
      ->set('auth0_client_secret', $form_state
      ->getValue('auth0_client_secret'))
      ->set('auth0_domain', $form_state
      ->getValue('auth0_domain'))
      ->set('auth0_jwt_signature_alg', $form_state
      ->getValue('auth0_jwt_signature_alg'))
      ->set('auth0_secret_base64_encoded', $form_state
      ->getValue('auth0_secret_base64_encoded'))
      ->save();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BasicSettingsForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
BasicSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
BasicSettingsForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
BasicSettingsForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
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.
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.