class HttpAuthSettings in HTTP Auth 8

Provide settings page for applying Http Auth on your site.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\http_auth\Form\HttpAuthSettings

Expanded class hierarchy of HttpAuthSettings

1 string reference to 'HttpAuthSettings'

http_auth.routing.yml in ./http_auth.routing.yml: http_auth.routing.yml

File

src/Form/HttpAuthSettings.php, line 12

Namespace

Drupal\http_auth\Form

View source

class HttpAuthSettings extends ConfigFormBase {

  /**
   * Implements FormBuilder::getFormId.
   */
  public function getFormId() {
    return 'http_auth';
  }

  /**
   * Implements ConfigFormBase::getEditableConfigNames.
   */
  protected function getEditableConfigNames() {
    return [
      'http_auth.settings',
    ];
  }

  /**
   * Implements FormBuilder::buildForm.
   */
  public function buildForm(array $form, FormStateInterface $form_state, Request $request = NULL) {
    $http_auth_section = $this
      ->config('http_auth.settings')
      ->get();
    $applicable = [
      'complete' => $this
        ->t('Complete Site'),
      'admin' => $this
        ->t('Admin and User Pages'),
    ];
    $form['http_auth'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Add HTTP Auth on your site'),
      '#description' => $this
        ->t('By activating, your site or admin pages would be <strong>locked</strong> for unauthenticated users.'),
    ];
    $form['http_auth']['username'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('HTTP Auth Username'),
      '#description' => $this
        ->t('Add HTTP Auth username'),
      '#default_value' => isset($http_auth_section['username']) ? $http_auth_section['username'] : '',
      '#size' => 60,
      '#maxlength' => 64,
      '#required' => TRUE,
      '#attributes' => [
        'placeholder' => 'username',
      ],
    ];
    $form['http_auth']['password'] = [
      '#type' => 'password',
      '#title' => $this
        ->t('HTTP Auth password'),
      '#description' => $this
        ->t('Add HTTP Auth password'),
      '#size' => 60,
      '#maxlength' => 64,
      '#required' => TRUE,
      '#attributes' => [
        'placeholder' => 'password',
      ],
    ];
    $form['http_auth']['message'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('HTTP Auth Message'),
      '#description' => $this
        ->t('Add HTTP Auth message which would be shown to the unauthenticated users.'),
      '#default_value' => isset($http_auth_section['message']) ? $http_auth_section['message'] : '',
      '#attributes' => [
        'placeholder' => $this
          ->t('This page is Restricted. Please contact the administrator for access.'),
      ],
    ];
    $form['http_auth']['applicable'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Applicable on:'),
      '#default_value' => isset($http_auth_section['applicable']) ? $http_auth_section['applicable'] : 'complete',
      '#options' => $applicable,
    ];
    $form['http_auth']['activate'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Activate HTTP Authentication'),
      '#default_value' => isset($http_auth_section['activate']) ? $http_auth_section['activate'] : 0,
    ];
    $form['http_auth']['note'] = [
      '#markup' => "<div><strong>Note:</strong> Please clear the cache if the settings wouldn't work!</div>",
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * Implements FormBuilder::submitForm().
   *
   * Save the HTTP Auth Details to to the Drupal's config Table.
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $this
      ->configFactory()
      ->getEditable('http_auth.settings')
      ->set('username', $values['username'])
      ->set('password', $values['password'])
      ->set('message', $values['message'])
      ->set('applicable', $values['applicable'])
      ->set('activate', $values['activate'])
      ->save();
    drupal_set_message($this
      ->t('Your Settings have been saved.'), 'status');
  }

}

Members

Name	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.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
HttpAuthSettings::buildForm	public	function	Implements FormBuilder::buildForm. Overrides ConfigFormBase::buildForm
HttpAuthSettings::getEditableConfigNames	protected	function	Implements ConfigFormBase::getEditableConfigNames. Overrides ConfigFormBaseTrait::getEditableConfigNames
HttpAuthSettings::getFormId	public	function	Implements FormBuilder::getFormId. Overrides FormInterface::getFormId
HttpAuthSettings::submitForm	public	function	Implements FormBuilder::submitForm(). Overrides ConfigFormBase::submitForm
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.

You are here

class HttpAuthSettings in HTTP Auth 8

Hierarchy

File

Namespace

Members

API Navigation