You are here

Home » API reference » Restrict Login or Role Access by IP Address 8.4 » LoginSettingsForm.php

class LoginSettingsForm in Restrict Login or Role Access by IP Address 8.4

Class LoginSettingsForm.

@package Drupal\restrict_by_ip\Form

Hierarchy

Expanded class hierarchy of LoginSettingsForm

1 string reference to 'LoginSettingsForm'
restrict_by_ip.routing.yml in ./restrict_by_ip.routing.yml
restrict_by_ip.routing.yml

File

src/Form/LoginSettingsForm.php, line 16

Namespace

Drupal\restrict_by_ip\Form
View source 
class LoginSettingsForm extends ConfigFormBase {
  protected $ip_tools;
  public function __construct(IPToolsInterface $ip_tools) {
    $this->ip_tools = $ip_tools;
  }
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('restrict_by_ip.ip_tools'));
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('restrict_by_ip.settings');
    $form['current_ip'] = [
      '#markup' => t('Your current IP address is %ipaddress. If this is wrong, make sure you have the correct header configured in general settings.', [
        '%ipaddress' => $this->ip_tools
          ->getUserIP(),
      ]),
      '#prefix' => '<p>',
      '#suffix' => '</p>',
    ];
    $form['restrict_by_ip_error_page'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Login denied error page'),
      '#description' => $this
        ->t("This the address of the page to which the user will be redirected if they are not allowed to login. If you don't set this the user will not know why they couldn't login."),
      '#default_value' => $config
        ->get('error_page'),
    ];
    $form['restrict_by_ip_login_range'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Restrict global login to allowed IP range'),
      '#description' => $this
        ->t('To restrict login for ALL users, enter global IP Address Ranges in CIDR Notation separated with semi-colons, with no trailing semi-colon. E.G. 10.20.30.0/24;192.168.199.1/32;1.0.0.0/8<br />For more information on CIDR notation click <a href="http://www.brassy.net/2007/mar/cidr_basic_subnetting">here</a>.<br />Leave field blank to disable IP restrictions for user login.'),
      '#default_value' => $config
        ->get('login_range'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   *
   * @todo Add validation that error page is an internal path.
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
    if (strlen($form_state
      ->getValue('restrict_by_ip_login_range')) > 0) {
      $ip_addresses = explode(";", $form_state
        ->getValue('restrict_by_ip_login_range'));
      foreach ($ip_addresses as $ip) {
        try {
          $this->ip_tools
            ->validateIP($ip);
        } catch (InvalidIPException $e) {
          $form_state
            ->setErrorByName('restrict_by_ip_login_range', $this
            ->t($e
            ->getMessage() . ' @ip.', [
            '@ip' => $ip,
          ]));
        }
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $this
      ->config('restrict_by_ip.settings')
      ->set('error_page', $form_state
      ->getValue('restrict_by_ip_error_page'))
      ->set('login_range', $form_state
      ->getValue('restrict_by_ip_login_range'))
      ->save();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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.
LoginSettingsForm::$ip_tools protected property
LoginSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
LoginSettingsForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
LoginSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
LoginSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
LoginSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
LoginSettingsForm::validateForm public function @todo Add validation that error page is an internal path. Overrides FormBase::validateForm
LoginSettingsForm::__construct public function Constructs a \Drupal\system\ConfigFormBase object. Overrides ConfigFormBase::__construct
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.