You are here

Home » API reference » Disable Login Page 1.0.x » SettingsForm.php

class SettingsForm in Disable Login Page 1.0.x

Class SettingsForm.

Hierarchy

Expanded class hierarchy of SettingsForm

1 string reference to 'SettingsForm'
disable_login.routing.yml in ./disable_login.routing.yml
disable_login.routing.yml

File

src/Form/SettingsForm.php, line 14

Namespace

Drupal\disable_login\Form
View source 
class SettingsForm extends ConfigFormBase {

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

  /**
   * Constructs the settings form.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The request stack.
   */
  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}
   */
  protected function getEditableConfigNames() {
    return [
      'disable_login.settings',
    ];
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('disable_login.settings');
    $form['disable_login'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Disable public access to login page without secret key'),
      '#description' => $this
        ->t('Use this to turn on/off protection on the login page'),
      '#default_value' => $config
        ->get('disable_login'),
    ];
    $default_qs = $config
      ->get('querystring');
    if (empty($default_qs)) {
      $default_qs = 'key';
    }
    $form['querystring'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Querystring name'),
      '#maxlength' => 255,
      '#size' => 128,
      '#description' => $this
        ->t('The name of the querystring to look for the secret key'),
      '#default_value' => $default_qs,
    ];
    $form['secret'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Secret key'),
      '#maxlength' => 255,
      '#size' => 128,
      '#description' => $this
        ->t('The value of the secret key to access the login page'),
      '#default_value' => $config
        ->get('secret'),
    ];
    $secret_key = $config
      ->get('secret');

    // Allow other modules to alter the key with custom logic
    // for example cycle through keys or based on month etc.
    $this->moduleHandler
      ->alter('disable_login_key', $secret_key);
    if ($secret_key != $config
      ->get('secret')) {
      $form['current_secret'] = [
        '#type' => 'item',
        '#title' => $this
          ->t('Altered secret key'),
        '#markup' => $secret_key,
        '#description' => $this
          ->t('The secret key is altered by another module on this site'),
      ];
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $settings = $this
      ->config('disable_login.settings');
    $settings
      ->set('disable_login', $form_state
      ->getValue('disable_login'))
      ->set('querystring', $form_state
      ->getValue('querystring'))
      ->set('secret', $form_state
      ->getValue('secret'));
    $settings
      ->save();
  }

}

Members

Namesort descending 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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 72
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::__construct public function Constructs the settings form. 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.