class HtaccessAdminForm in Htaccess 8.2

Defines a form to configure RSVP List module settings

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\htaccess\Form\HtaccessAdminForm

1 string reference to 'HtaccessAdminForm'

htaccess.routing.yml in ./htaccess.routing.yml

htaccess.routing.yml

File

src/Form/HtaccessAdminForm.php, line 21

Administration pages.

Namespace

Drupal\htaccess\Form

class HtaccessAdminForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, Request $request = NULL) {
    $config = $this
      ->config('htaccess.settings');
    $form['htaccess_settings'] = array(
      '#type' => 'fieldset',
      '#title' => t('General'),
      '#collapsible' => FALSE,
      '#collapsed' => FALSE,
    );
    $htaccess_settings_url_prefix_redirection_options = array(
      'without_www' => t('Without WWW prefix'),
      'with_www' => t('With WWW prefix'),
    );
    $form['htaccess_settings']['htaccess_settings_url_prefix_redirection'] = array(
      '#type' => 'radios',
      '#title' => t('URL prefix redirection'),
      '#description' => t('Use one of the following options to redirect users to your preferred
      URL, either <strong>with</strong> or <strong>without</strong> the \'www.\' prefix. Default: without.'),
      '#options' => $htaccess_settings_url_prefix_redirection_options,
      '#default_value' => $config
        ->get('htaccess_settings_url_prefix_redirection'),
    );
    $htaccess_settings_symlinks_options = array(
      'FollowSymLinks' => t('+FollowSymLinks'),
      'SymLinksifOwnerMatch' => t('+SymLinksifOwnerMatch'),
    );
    $form['htaccess_settings']['htaccess_settings_symlinks'] = array(
      '#type' => 'radios',
      '#title' => t('Symbolic links'),
      '#description' => t('Define the Apache\'s right options to access to parts of the filesystem. Default: +FollowSymLinks.<br />For more informations, see <a href="@link_apache" target="_blank">http://httpd.apache.org/docs/2.2/urlmapping.html#outside</a>.', array(
        '@link_apache' => \Drupal\Core\Url::fromUri('http://httpd.apache.org/docs/2.2/urlmapping.html#outside'),
      )),
      '#options' => $htaccess_settings_symlinks_options,
      '#default_value' => $config
        ->get('htaccess_settings_symlinks'),
    );
    $htaccess_settings_ssl_options = array(
      'HTTPS_mixed_mode' => t('Enable mixed-mode HTTP/HTTPS (allow trafic from both HTTP and HTTPS'),
      'HTTPS_force_redirect' => t('Enable HTTPS and redirect all HTTP trafic (force all trafic through HTTPS protocol only)'),
    );
    $form['htaccess_settings']['htaccess_settings_ssl'] = array(
      '#type' => 'radios',
      '#title' => t('HTTP Secure (HTTPS)'),
      '#description' => t('Before activating the HTTPS support, you should first get a valid certificate, then configure your web server.<br />For more informations, see <a href="@link_ssl" target="_blank">https://www.drupal.org/https-information</a>.', array(
        '@link_ssl' => \Drupal\Core\Url::fromUri('https://www.drupal.org/https-information'),
      )),
      '#options' => $htaccess_settings_ssl_options,
      '#default_value' => $config
        ->get('htaccess_settings_ssl'),
    );
    $form['htaccess_settings_custom'] = array(
      '#type' => 'fieldset',
      '#title' => t('Custom settings'),
      '#collapsible' => FALSE,
      '#collapsed' => FALSE,
    );
    $form['htaccess_settings_custom']['htaccess_settings_custom_settings'] = array(
      '#type' => 'textarea',
      '#description' => t('Copy/paste below your custom settings (redirections, rewrite rules etc..). These will be added before the Drupal rules.'),
      '#default_value' => $config
        ->get('htaccess_settings_custom_settings'),
    );
    $form['htaccess_settings_boost_module'] = array(
      '#type' => 'fieldset',
      '#title' => t('Boost'),
      '#description' => t('The Boost module is a static file caching tool to improve performance.'),
      '#collapsible' => FALSE,
      '#collapsed' => FALSE,
    );
    $htaccess_settings_boost_module_readonly = !\Drupal::moduleHandler()
      ->moduleExists('boost') ? TRUE : FALSE;
    $htaccess_settings_boost_module_description = $htaccess_settings_boost_module_readonly ? t('Boost is currently not installed. You can download it at <a href="https://drupal.org/project/boost" target="_blank">https://drupal.org/project/boost</a>.') : t('If enabled, copy and paste the <a href="admin/config/system/boost">Boost rules</a>.');
    $form['htaccess_settings_boost_module']['htaccess_settings_boost_module_rules'] = array(
      '#type' => 'textarea',
      '#title' => t('Rules'),
      '#description' => $htaccess_settings_boost_module_description,
      '#default_value' => $config
        ->get('htaccess_settings_boost_module_rules'),
      '#disabled' => $htaccess_settings_boost_module_readonly,
    );
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $htaccess_settings_url_prefix_redirection = $form_state
      ->getValue('htaccess_settings_url_prefix_redirection');
    $htaccess_settings_symlinks = $form_state
      ->getValue('htaccess_settings_symlinks');
    $htaccess_settings_ssl = $form_state
      ->getValue('htaccess_settings_ssl');
    $htaccess_settings_custom_settings = $form_state
      ->getValue('htaccess_settings_custom_settings');
    $htaccess_settings_boost_module_rules = $form_state
      ->getValue('htaccess_settings_boost_module_rules');
    $this
      ->config('htaccess.settings')
      ->set('htaccess_settings_url_prefix_redirection', $htaccess_settings_url_prefix_redirection)
      ->set('htaccess_settings_symlinks', $htaccess_settings_symlinks)
      ->set('htaccess_settings_ssl', $htaccess_settings_ssl)
      ->set('htaccess_settings_custom_settings', $htaccess_settings_custom_settings)
      ->set('htaccess_settings_boost_module_rules', $htaccess_settings_boost_module_rules)
      ->save();
    parent::submitForm($form, $form_state);
  }

}

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
FormInterface::getFormId	public	function	Returns a unique string identifying the form.	236
HtaccessAdminForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
HtaccessAdminForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
HtaccessAdminForm::getFormID	public	function
HtaccessAdminForm::submitForm	public	function	Form submission handler. 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.