You are here

Home » API reference » Persistent Login 8 » PersistentLoginSettingsForm.php

class PersistentLoginSettingsForm in Persistent Login 8

Form for editing Persistent Login module settings.

Hierarchy

Expanded class hierarchy of PersistentLoginSettingsForm

1 string reference to 'PersistentLoginSettingsForm'
persistent_login.routing.yml in ./persistent_login.routing.yml
persistent_login.routing.yml

File

src/Form/PersistentLoginSettingsForm.php, line 11

Namespace

Drupal\persistent_login\Form
View source 
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);
  }

}

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