You are here

Home » API reference » simpleSAMLphp Authentication 8.3 » BasicSettingsForm.php

class BasicSettingsForm in simpleSAMLphp Authentication 8.3

Form builder for the simplesamlphp_auth basic settings form.

Hierarchy

Expanded class hierarchy of BasicSettingsForm

1 string reference to 'BasicSettingsForm'
simplesamlphp_auth.routing.yml in ./simplesamlphp_auth.routing.yml
simplesamlphp_auth.routing.yml

File

src/Form/BasicSettingsForm.php, line 11

Namespace

Drupal\simplesamlphp_auth\Form
View source 
class BasicSettingsForm extends ConfigFormBase {

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'simplesamlphp_auth.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('simplesamlphp_auth.settings');
    $form['basic'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Basic settings'),
      '#collapsible' => FALSE,
    ];
    $form['basic']['activate'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Activate authentication via SimpleSAMLphp'),
      '#default_value' => $config
        ->get('activate'),
      '#description' => $this
        ->t('Checking this box before configuring the module could lock you out of Drupal.'),
    ];
    $form['basic']['auth_source'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Authentication source for this SP'),
      '#default_value' => $config
        ->get('auth_source'),
      '#description' => $this
        ->t('The name of the source to use (Usually in authsources.php).'),
    ];
    $form['basic']['login_link_display_name'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Federated Log In Link Display Name'),
      '#default_value' => $config
        ->get('login_link_display_name'),
      '#description' => $this
        ->t('Text to display as the link to the external federated login page.'),
    ];
    $form['basic']['login_link_show'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display a link to the Federated Login page on the user login form'),
      '#default_value' => $config
        ->get('login_link_show'),
    ];
    $form['basic']['header_no_cache'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Use Header with: Cache-Control: no-cache'),
      '#default_value' => $config
        ->get('header_no_cache'),
      '#description' => $this
        ->t('Use a "Cache-Control: no-cache" header in the HTTP response to avoid the redirection be cached (e.g. when using a reverse-proxy layer).'),
    ];
    $form['debugging'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Debugging'),
      '#collapsible' => FALSE,
    ];
    $form['debugging']['debug'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Turn on debugging messages'),
      '#default_value' => $config
        ->get('debug'),
      '#description' => $this
        ->t('Expand the level of Drupal logging to include debugging information.'),
    ];
    $form['user_provisioning'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('User Provisioning'),
      '#collapsible' => FALSE,
    ];
    $form['user_provisioning']['register_users'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Register users (i.e., auto-provisioning)'),
      '#default_value' => $config
        ->get('register_users'),
      '#description' => $this
        ->t('Determines whether or not the module should automatically create/register new Drupal accounts for users that authenticate using SimpleSAMLphp. Unless you\'ve done some custom work to provision Drupal accounts with the necessary authmap entries you will want this checked.<br /><br />NOTE: If unchecked each user must already have been provisioned a Drupal account correctly linked to the SAML authname attribute (e.g. by creating Drupal users with "Enable this user to leverage SAML authentication" checked). Otherwise they will receive a notice and be denied access.'),
    ];
    $form['security'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Security'),
      '#collapsible' => FALSE,
    ];
    $form['security']['secure'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Cookie only transmitted over HTTPS'),
      '#default_value' => $config
        ->get('secure'),
      '#description' => $this
        ->t('Cookie should only be transmitted over a secure HTTPS connection from the client. When set to TRUE, the cookie will only be set if a secure connection exists.'),
    ];
    $form['security']['httponly'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Cookie only accessible over HTTP protocol'),
      '#default_value' => $config
        ->get('httponly'),
      '#description' => $this
        ->t("Cookie will be made accessible only through the HTTP protocol. This means that the cookie won't be accessible by scripting languages, such as JavaScript."),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $config = $this
      ->config('simplesamlphp_auth.settings');
    $config
      ->set('activate', $form_state
      ->getValue('activate'));
    $config
      ->set('auth_source', $form_state
      ->getValue('auth_source'));
    $config
      ->set('login_link_display_name', $form_state
      ->getValue('login_link_display_name'));
    $config
      ->set('login_link_show', $form_state
      ->getValue('login_link_show'));
    $config
      ->set('debug', $form_state
      ->getValue('debug'));
    $config
      ->set('secure', $form_state
      ->getValue('secure'));
    $config
      ->set('httponly', $form_state
      ->getValue('httponly'));
    $config
      ->set('register_users', $form_state
      ->getValue('register_users'));
    $config
      ->set('header_no_cache', $form_state
      ->getValue('header_no_cache'));
    $config
      ->save();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BasicSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
BasicSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
BasicSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
BasicSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 13
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 11
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
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::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.
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.