You are here

Home » API reference » urllogin 8 » UrlloginForm.php

class UrlloginForm in urllogin 8

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

Implements an urllgoin admin form.

Hierarchy

Expanded class hierarchy of UrlloginForm

1 string reference to 'UrlloginForm'
urllogin.routing.yml in ./urllogin.routing.yml
urllogin.routing.yml

File

src/Form/UrlloginForm.php, line 13

Namespace

Drupal\urllogin\Form
View source 
class UrlloginForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('urllogin.settings');
    $form['encryption'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Encryption settings'),
      '#description' => $this
        ->t('This page contains all the settings
      for urllogin. However you will also need to add the "login via url"
      permission to the roles of all users who will use this module for logging
      in. <br /> For testing purposes, individual url login strings can be
      generated from the status page - @statusPage for details.', [
        '@statusPage' => Link::fromTextAndUrl(t('see this page'), Url::fromRoute('urllogin.status'))
          ->toString(),
      ]),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
    ];
    $form['encryption']['urllogin_passphrase'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Pass phrase'),
      '#description' => $this
        ->t('The passphrase for encoding URL access'),
      '#default_value' => $config
        ->get('passphrase'),
      '#size' => 40,
    ];

    /*  Disable Add DB Password to passphrase
        $form['encryption']['urllogin_add_dbpass'] = array(
        '#type' => 'checkbox',
        '#title' => $this->t('Append database access string to passphrase'),
        '#description' => $this->t('Increase security by appending the database
        access string to the passphrase.
        The only disadvantage is that changing your database password will
        invalidate all currently
        issued URL access strings. The best solution is to set the password in
        settings.php.'),
        '#default_value' => $config->get('add_dbpass'),
        );
         */

    // @TODO Check if this is neccasrry with D8 config overried system
    // disable if passphrase set in settings.php
    if (isset($GLOBALS['urllogin_passphrase'])) {
      $form['encryption']['urllogin_add_dbpass']['#disabled'] = TRUE;
      $form['encryption']['urllogin_passphrase']['#disabled'] = TRUE;
      $form['encryption']['urllogin_passphrase']['#title'] = 'Passphrase (not currently used)';
      $form['encryption']['urllogin_passphrase']['#description'] = 'Passphrase has been set in settings.php and overrides this value';
    }
    $form['encryption']['urllogin_codekey'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Validation number for generating new URL login strings'),
      '#description' => $this
        ->t('A value between 0 and 2,000,000,000. Suggestion: use current date in yyyymmdd format.'),
      '#default_value' => $config
        ->get('codekey'),
      '#size' => 10,
    ];
    $form['encryption']['urllogin_codemin'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Minimum validation number allowed for valid login'),
      '#description' => $this
        ->t('A value between 0 and 2,000,000,000. Suggestion: use oldest valid date in yyyymmdd format.'),
      '#default_value' => $config
        ->get('codemin'),
      '#size' => 10,
    ];
    $form['userlist'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Bulk generation of access URLs'),
      '#description' => $this
        ->t('A bulk download of all user logon strings as a tab-separated csv file can be downloaded
      by clicking and saving @link. But first set the following options (if required) and <strong><em>save the form</em></strong>.', [
        '@link' => Link::fromTextAndUrl(t('this link.'), Url::fromRoute('urllogin.user_list'))
          ->toString(),
      ]),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
    ];
    $form['userlist']['urllogin_destination'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Optional destination for bulk generated links'),
      '#description' => $this
        ->t('No leading "/" e.g. blog/my_latest_article'),
      '#default_value' => $config
        ->get('destination'),
      '#size' => 50,
    ];

    // @TODO see if this applies to D8
    $form['userlist']['urllogin_useprofile'] = [
      '#type' => 'hidden',
      /* marked hidden until profiles are supported properly in D7 (see end of file) */
      '#title' => $this
        ->t('use "firstname" and "lastname" fields from profile when creating downloaded user list'),
      '#description' => $this
        ->t('Requires the profile module and the creation of fields with the exact names:
       <em>profile_firstname, profile_lastname</em>.'),
      '#default_value' => $config
        ->get('useprofile'),
    ];
    $form['actions']['#type'] = 'actions';
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save'),
      '#button_type' => 'primary',
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $entry = $form_state
      ->getValue('urllogin_codekey');

    // Test for digits.
    if (preg_match('@^[0-9]+$@', trim($entry)) != 1) {
      $form_state
        ->setErrorByName('urllogin_codekey', $this
        ->t('Please enter a positive integer for Validation number.'));
    }
    $entry = $form_state
      ->getValue('urllogin_codemin');

    // Test for digits.
    if (preg_match('@^[0-9]+$@', trim($entry)) != 1) {
      $form_state
        ->setErrorByName('urllogin_codemin', $this
        ->t('Please enter a positive integer for Minimum validation number.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Retrieve the configuration.
    $this->configFactory
      ->getEditable('urllogin.settings')
      ->set('passphrase', $form_state
      ->getValue('urllogin_passphrase'))
      ->set('add_dbpass', $form_state
      ->getValue('urllogin_add_dbpass'))
      ->set('codekey', $form_state
      ->getValue('urllogin_codekey'))
      ->set('codemin', $form_state
      ->getValue('urllogin_codemin'))
      ->set('destination', $form_state
      ->getValue('urllogin_destination'))
      ->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.
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.
UrlloginForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
UrlloginForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
UrlloginForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
UrlloginForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
UrlloginForm::validateForm public function Form validation handler. Overrides FormBase::validateForm