class SettingsForm in Session Limit 2.x

Same name and namespace in other branches

8 src/Form/SettingsForm.php \Drupal\session_limit\Form\SettingsForm

Class SettingsForm.

@package Drupal\session_limit\Form

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\session_limit\Form\SettingsForm

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 17

Namespace

Drupal\session_limit\Form

View source

class SettingsForm extends ConfigFormBase {

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * Constructs a \Drupal\system\ConfigFormBase object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler instance to use.
   */
  public function __construct(ConfigFactoryInterface $config_factory, ModuleHandlerInterface $module_handler) {
    parent::__construct($config_factory);
    $this->moduleHandler = $module_handler;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('module_handler'));
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('session_limit.settings');
    $form['session_limit_max'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Default maximum number of active sessions'),
      '#default_value' => $config
        ->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' => $config
        ->get('session_limit_behaviour'),
      '#options' => SessionLimit::getActions(),
    ];
    if ($this->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' => $config
          ->get('session_limit_masquerade_ignore'),
      ];
    }
    $form['session_limit_logged_out_message_severity'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Logged out message severity'),
      '#default_value' => $config
        ->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 = $config
      ->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 => 1,
          2 => 2,
          3 => 3,
          4 => 4,
          5 => 5,
        ],
        '#title' => $role
          ->label(),
        '#default_value' => empty($role_limits[$rid]) ? 0 : $role_limits[$rid],
      ];
    }
    $form['session_limit_admin_inclusion'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Apply session limit for (ADMIN) also'),
      '#description' => $this
        ->t("Bydefsult session limit is not working for ADMIN , but if eneble this checkbox then it will work for admin also"),
      '#default_value' => \Drupal::config('session_limit.settings')
        ->get('session_limit_admin_inclusion'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$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']));
    $config
      ->set('session_limit_admin_inclusion', $form_state
      ->getValue($form['session_limit_admin_inclusion']['#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

Name	Modifiers	Type	Description	Overrides
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	3
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.	3
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.
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.
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.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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::$moduleHandler	protected	property	The module handler.
SettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
SettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
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
SettingsForm::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object. Overrides ConfigFormBase::__construct
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.

You are here

class SettingsForm in Session Limit 2.x

Hierarchy

File

Namespace

Members

API Navigation