You are here

Home » API reference » Session Limit 8 » SettingsForm.php

class SettingsForm in Session Limit 8

Same name and namespace in other branches
  1. 2.x src/Form/SettingsForm.php \Drupal\session_limit\Form\SettingsForm

Hierarchy

Expanded class hierarchy of SettingsForm

1 string reference to 'SettingsForm'
session_limit.routing.yml in ./session_limit.routing.yml
session_limit.routing.yml

File

src/Form/SettingsForm.php, line 10

Namespace

Drupal\session_limit\Form
View source 
class SettingsForm extends ConfigFormBase {

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'session_limit.settings',
    ];
  }
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['session_limit_max'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Default maximum number of active sessions'),
      '#default_value' => \Drupal::config('session_limit.settings')
        ->get('session_limit_max'),
      '#size' => 2,
      '#maxlength' => 3,
      '#description' => $this
        ->t('The maximum number of active sessions a user can have. 0 implies unlimited sessions.'),
    ];
    $form['session_limit_behaviour'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('When the session limit is exceeded'),
      '#default_value' => \Drupal::config('session_limit.settings')
        ->get('session_limit_behaviour'),
      '#options' => SessionLimit::getActions(),
    ];
    if (\Drupal::moduleHandler()
      ->moduleExists('masquerade')) {
      $form['session_limit_masquerade_ignore'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Ignore masqueraded sessions.'),
        '#description' => $this
          ->t("When a user administrator uses the masquerade module to impersonate a different user, it won't count against the session limit counter"),
        '#default_value' => \Drupal::config('session_limit.settings')
          ->get('session_limit_masquerade_ignore'),
      ];
    }
    $form['session_limit_logged_out_message_severity'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Logged out message severity'),
      '#default_value' => \Drupal::config('session_limit.settings')
        ->get('session_limit_logged_out_message_severity'),
      '#options' => [
        'error' => $this
          ->t('Error'),
        'warning' => $this
          ->t('Warning'),
        'status' => $this
          ->t('Status'),
        '_none' => $this
          ->t('No Message'),
      ],
      '#description' => $this
        ->t('The severity of the message the user receives when they are logged out by session limit.'),
    ];
    $role_limits = \Drupal::config('session_limit.settings')
      ->get('session_limit_roles');
    $form['session_limit_roles'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Role limits'),
      '#description' => $this
        ->t('Optionally, specify session limits by role.'),
    ];
    foreach (user_roles(TRUE) as $rid => $role) {
      $form['session_limit_roles'][$rid] = [
        '#type' => 'select',
        '#options' => [
          0 => $this
            ->t('Uses default'),
          SessionLimit::USER_UNLIMITED_SESSIONS => $this
            ->t('No limits'),
          1,
          2,
          3,
          4,
          5,
        ],
        '#title' => $role
          ->label(),
        '#default_value' => empty($role_limits[$rid]) ? 0 : $role_limits[$rid],
      ];
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, \Drupal\Core\Form\FormStateInterface $form_state) {
    $maxsessions = $form_state
      ->getValue([
      'session_limit_max',
    ]);
    if (!is_numeric($maxsessions)) {
      $form_state
        ->setErrorByName('session_limit_max', $this
        ->t('You must enter a number for the maximum number of active sessions'));
    }
    elseif ($maxsessions < 0) {
      $form_state
        ->setErrorByName('session_limit_max', $this
        ->t('Maximum number of active sessions must be positive'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('session_limit.settings');
    $config
      ->set('session_limit_max', $form_state
      ->getValue($form['session_limit_max']['#parents']));
    $config
      ->set('session_limit_behaviour', $form_state
      ->getValue($form['session_limit_behaviour']['#parents']));
    $config
      ->set('session_limit_logged_out_message_severity', $form_state
      ->getValue($form['session_limit_logged_out_message_severity']['#parents']));
    $role_limits = [];
    foreach (user_roles(TRUE) as $rid => $role) {
      $role_limits[$rid] = $form_state
        ->getValue($form['session_limit_roles'][$rid]['#parents']);
    }
    $config
      ->set('session_limit_roles', $role_limits);
    if (!empty($form['session_limit_masquerade_ignore'])) {
      $config
        ->set('session_limit_masquerade_ignore', $form_state
        ->getValue($form['session_limit_masquerade_ignore']['#parents']));
    }
    $config
      ->save();
    if (method_exists($this, '_submitForm')) {
      $this
        ->_submitForm($form, $form_state);
    }
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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.
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.
SettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
SettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
SettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
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.