You are here

Home » API reference » HTTP Strict Transport Security 8 » HstsConfigForm.php

class HstsConfigForm in HTTP Strict Transport Security 8

Implements a Hsts Config form.

Hierarchy

Expanded class hierarchy of HstsConfigForm

1 string reference to 'HstsConfigForm'
hsts.routing.yml in ./hsts.routing.yml
hsts.routing.yml

File

src/Form/HstsConfigForm.php, line 19
Contains \Drupal\hsts\Form\HstsConfigForm.

Namespace

Drupal\hsts\Form
View source 
class HstsConfigForm extends ConfigFormBase {

  /**
   * The date formatter service.
   *
   * @var \Drupal\Core\Datetime\DateFormatter
   */
  protected $dateFormatter;

  /**
   * Constructs a HstsConfigForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Datetime\DateFormatter $date_formatter
   *   The date formatter service.
   */
  public function __construct(ConfigFactoryInterface $config_factory, DateFormatter $date_formatter) {
    parent::__construct($config_factory);
    $this->dateFormatter = $date_formatter;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('date.formatter'));
  }

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

  /**
   * {@inheritdoc}.
   */
  public function getFormID() {
    return 'hsts_config_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('hsts.settings');
    $form['enabled'] = [
      '#type' => 'checkbox',
      '#title' => t('Enable HSTS'),
      '#description' => t('Whether to start adding the HSTS header information or not.'),
      '#default_value' => $config
        ->get('enabled'),
    ];
    $options = [
      0,
      300,
      31536000,
      63072000,
      94608000,
    ];
    $form['max_age'] = [
      '#type' => 'select',
      '#title' => t('Max age'),
      '#description' => t('The maximum age value for the header. See the <a href="https://tools.ietf.org/html/rfc6797">Strict Transport Security Definition</a> for more information.'),
      '#options' => array_map([
        $this->dateFormatter,
        'formatInterval',
      ], array_combine($options, $options)),
      '#default_value' => $config
        ->get('max_age'),
    ];
    $form['subdomains'] = [
      '#type' => 'checkbox',
      '#title' => t('Include subdomains'),
      '#description' => t('Whether to include the subdomains as part of the HSTS implementation.'),
      '#default_value' => $config
        ->get('subdomains'),
    ];
    $form['preload'] = [
      '#type' => 'checkbox',
      '#title' => t('Preload'),
      '#description' => t('The preload directive allows your domain to be submitted for inclusion by browsers at <a href="https://hstspreload.appspot.com/">hstspreload.appspot.com</a>. Do not enable preload unless you are sure you want all sites on your domain to be HTTPS-only for the long term.'),
      '#default_value' => $config
        ->get('preload'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}.
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('hsts.settings')
      ->set('enabled', $form_state
      ->getValue('enabled'))
      ->set('max_age', $form_state
      ->getValue('max_age'))
      ->set('subdomains', $form_state
      ->getValue('subdomains'))
      ->set('preload', $form_state
      ->getValue('preload'))
      ->save();
    parent::submitForm($form, $form_state);
  }

  /**
   * {@inheritdoc}.
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    if (!is_numeric($form_state
      ->getValue('max_age')) || $form_state
      ->getValue('max_age') < 0) {
      $form_state
        ->setErrorByName('max_age', t('Value is not a number or out of bounds.'));
    }
    parent::validateForm($form, $form_state);
  }

}

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.
FormInterface::getFormId public function Returns a unique string identifying the form. 236
HstsConfigForm::$dateFormatter protected property The date formatter service.
HstsConfigForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
HstsConfigForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
HstsConfigForm::getEditableConfigNames protected function . Overrides ConfigFormBaseTrait::getEditableConfigNames
HstsConfigForm::getFormID public function .
HstsConfigForm::submitForm public function . Overrides ConfigFormBase::submitForm
HstsConfigForm::validateForm public function . Overrides FormBase::validateForm
HstsConfigForm::__construct public function Constructs a HstsConfigForm object. Overrides ConfigFormBase::__construct
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.