class HttpsWwwSettingsForm in HTTPS and WWW Redirect 2.x

Class HttpsWwwSettingsForm.

@package Drupal\httpswww\Form

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
    • class \Drupal\httpswww\Form\HttpsWwwSettingsForm

1 string reference to 'HttpsWwwSettingsForm'

httpswww.routing.yml in ./httpswww.routing.yml

httpswww.routing.yml

File

src/Form/HttpsWwwSettingsForm.php, line 13

Namespace

Drupal\httpswww\Form

class HttpsWwwSettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('httpswww.settings');
    $this
      ->messenger()
      ->addWarning($this
      ->t('Please read and understand the options before making any changes.'));
    $form['fieldset_1'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Redirect status'),
      '#description' => $this
        ->t('' . '&bull; Make sure your site is accessible for the options you select before enabling redirects.<br>' . '&bull; If you don\'t have the "Bypass HTTPS and WWW Redirects" permission and are on a different domain than what you select, you will be logged out when saving.<br>' . '&bull; Once enabled, avoid making any further changes as it may affect SEO.'),
    ];
    $form['fieldset_1']['enabled'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable redirects'),
      '#default_value' => $config
        ->get('enabled'),
    ];
    $form['fieldset_2'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('URL prefix redirect'),
    ];
    $form['fieldset_2']['prefix'] = [
      '#type' => 'radios',
      '#description' => $this
        ->t('' . 'Users will be redirected corresponding to the selected option.<br>' . 'Make sure your site is accessible for the option selected.'),
      '#default_value' => $config
        ->get('prefix') ?: 'no',
      '#options' => [
        'no' => $this
          ->t('Without WWW prefix'),
        'yes' => $this
          ->t('With WWW prefix'),
      ],
    ];
    $form['fieldset_3'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('HTTP Secure (HTTPS) redirect'),
    ];
    $form['fieldset_3']['scheme'] = [
      '#type' => 'radios',
      '#description' => $this
        ->t('' . 'Before activating HTTPS support you must first configure your server with a valid SSL certificate.<br>' . 'For more information, see <a href=":url">@url</a>.', [
        ':url' => 'https://www.drupal.org/https-information',
        '@url' => 'https://www.drupal.org/https-information',
      ]),
      '#default_value' => $config
        ->get('scheme') ?: 'mixed',
      '#options' => [
        'mixed' => $this
          ->t('Enable mixed mode (both HTTP and HTTPS is allowed).'),
        'https' => $this
          ->t('Enable HTTPS and redirect all HTTP traffic (force HTTPS).'),
      ],
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('httpswww.settings');
    $config
      ->set('enabled', $form_state
      ->getValue('enabled'));
    $config
      ->set('prefix', $form_state
      ->getValue('prefix'));
    $config
      ->set('scheme', $form_state
      ->getValue('scheme'));
    $config
      ->save();
    $this
      ->messenger()
      ->addStatus($this
      ->t('The configuration options have been saved.'));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBase::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create	18
ConfigFormBase::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object.	16
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
HttpsWwwSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
HttpsWwwSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
HttpsWwwSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
HttpsWwwSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
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.
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.