PersistentLoginSettingsForm.php in Persistent Login 8

Namespace

Drupal\persistent_login\Form

File

src/Form/PersistentLoginSettingsForm.php

<?php

namespace Drupal\persistent_login\Form;

use Drupal\Core\Form\ConfigFormBase;
use Drupal\Core\Form\FormStateInterface;

/**
 * Form for editing Persistent Login module settings.
 */
class PersistentLoginSettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('persistent_login.settings');
    $form['lifetime'] = [
      '#type' => 'number',
      '#min' => 0,
      '#step' => 1,
      '#title' => $this
        ->t('Lifetime'),
      '#description' => $this
        ->t('The maximum number of days for which a persistent login session is valid.  Enter <em>0</em> for no expiration.'),
      '#default_value' => $config
        ->get('lifetime'),
    ];
    $form['max_tokens'] = [
      '#type' => 'number',
      '#min' => 0,
      '#step' => 1,
      '#title' => $this
        ->t('Maximum Tokens'),
      '#description' => $this
        ->t('The maximum number of tokens per user.  Enter <em>0</em> for no limit.'),
      '#default_value' => $config
        ->get('max_tokens'),
    ];
    $form['field_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Form Label'),
      '#description' => $this
        ->t('The login form field label.'),
      '#default_value' => $config
        ->get('login_form.field_label'),
      '#required' => TRUE,
    ];
    $form['cookie_prefix'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Cookie Prefix'),
      '#description' => $this
        ->t('A prefix for the persistent login cookie name. <br>Allowed characters are: ASCII letters ([A-Z], [a-z]), digits ([0-9]), hyphens ("-") or underscores ("_"). <br>This value will be prepended with \'S\' when the site is accessed over HTTPS to prevent a cookie collision. <br>All users will be required to login if this value is changed.'),
      '#default_value' => $config
        ->get('cookie_prefix'),
      '#required' => TRUE,
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    if (!preg_match('/^[-_a-z0-9]+$/i', $form_state
      ->getValue('cookie_prefix'))) {
      $form_state
        ->setErrorByName('cookie_prefix', $this
        ->t('Invalid characters in cookie prefix'));
    }
    elseif (preg_match('/^S?SESS$/', $form_state
      ->getValue('cookie_prefix'))) {
      $form_state
        ->setErrorByName('cookie_prefix', $this
        ->t('Cookie prefix cannot be "SESS" because it is used by the Drupal session cookie.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('persistent_login.settings')
      ->set('lifetime', $form_state
      ->getValue('lifetime'))
      ->set('max_tokens', $form_state
      ->getValue('max_tokens'))
      ->set('login_form.field_label', $form_state
      ->getValue('field_label'))
      ->set('cookie_prefix', $form_state
      ->getValue('cookie_prefix'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Classes

Name	Description
PersistentLoginSettingsForm	Form for editing Persistent Login module settings.