class LocalSettingsForm in simpleSAMLphp Authentication 8.3
Form builder for the simplesamlphp_auth local settings form.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
- class \Drupal\simplesamlphp_auth\Form\LocalSettingsForm
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
Expanded class hierarchy of LocalSettingsForm
1 string reference to 'LocalSettingsForm'
File
- src/
Form/ LocalSettingsForm.php, line 11
Namespace
Drupal\simplesamlphp_auth\FormView source
class LocalSettingsForm extends ConfigFormBase {
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'simplesamlphp_auth_local_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['authentication'] = [
'#type' => 'fieldset',
'#title' => $this
->t('Drupal authentication'),
'#collapsible' => FALSE,
];
$form['authentication']['allow_default_login'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Allow authentication with local Drupal accounts'),
'#default_value' => $config
->get('allow.default_login'),
'#description' => $this
->t('Check this box if you want to let people log in with local Drupal accounts (without using simpleSAMLphp). If this is not selected, users will be directly redirected to the external identity provider. If this is selected, you can restrict this privilege to certain users below.'),
];
$form['authentication']['allow_set_drupal_pwd'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Allow SAML users to set Drupal passwords'),
'#default_value' => $config
->get('allow.set_drupal_pwd'),
'#description' => $this
->t('Check this box if you want to let people set passwords for their local Drupal accounts. This will allow users to log in using either SAML or a local Drupal account. Disabling this removes the password change fields from the user profile form.<br/>NOTE: In order for them to login using their local Drupal password you must allow local logins with the settings below.'),
];
$form['authentication']['allow_default_login_roles'] = [
'#type' => 'checkboxes',
'#size' => 3,
'#options' => array_map('\\Drupal\\Component\\Utility\\Html::escape', user_role_names(TRUE)),
'#multiple' => TRUE,
'#title' => $this
->t('Which ROLES should be allowed to login with local accounts?'),
'#default_value' => $config
->get('allow.default_login_roles'),
'#description' => $this
->t('Roles that should be allowed to login without simpleSAMLphp. Examples are dev/admin roles or guest roles.'),
];
$form['authentication']['allow_default_login_users'] = [
'#type' => 'textfield',
'#title' => $this
->t('Which users should be allowed to login with local accounts?'),
'#default_value' => $config
->get('allow.default_login_users'),
'#description' => $this
->t('Example: <i>1,2,3</i><br />A comma-separated list of user IDs that should be allowed to login without simpleSAMLphp.'),
];
$form['authentication']['logout_goto_url'] = [
'#type' => 'textfield',
'#title' => $this
->t('Redirect URL after logging out'),
'#default_value' => $config
->get('logout_goto_url'),
'#description' => $this
->t('Optionally, specify a URL for users to go to after logging out.'),
];
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('allow.default_login', $form_state
->getValue('allow_default_login'));
$config
->set('allow.set_drupal_pwd', $form_state
->getValue('allow_set_drupal_pwd'));
$config
->set('allow.default_login_roles', array_filter($form_state
->getValue('allow_default_login_roles')));
$config
->set('allow.default_login_users', $form_state
->getValue('allow_default_login_users'));
$config
->set('logout_goto_url', $form_state
->getValue('logout_goto_url'));
$config
->save();
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConfigFormBase:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
13 |
ConfigFormBase:: |
public | function | Constructs a \Drupal\system\ConfigFormBase object. | 11 |
ConfigFormBaseTrait:: |
protected | function | Retrieves a configuration object. | |
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormBase:: |
protected | property | The config factory. | 1 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 1 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
FormBase:: |
protected | function |
Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait:: |
|
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
FormBase:: |
public | function |
Form validation handler. Overrides FormInterface:: |
62 |
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
LocalSettingsForm:: |
public | function |
Form constructor. Overrides ConfigFormBase:: |
|
LocalSettingsForm:: |
protected | function |
Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait:: |
|
LocalSettingsForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
LocalSettingsForm:: |
public | function |
Form submission handler. Overrides ConfigFormBase:: |
|
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
UrlGeneratorTrait:: |
protected | property | The url generator. | |
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |