class OutdatedbrowserSettingsForm in Outdated Browser 8

General configuration form for controlling the outdatedbrowser behaviour..

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\outdatedbrowser\Form\OutdatedbrowserSettingsForm

Expanded class hierarchy of OutdatedbrowserSettingsForm

1 string reference to 'OutdatedbrowserSettingsForm'

outdatedbrowser.routing.yml in ./outdatedbrowser.routing.yml: outdatedbrowser.routing.yml

File

src/Form/OutdatedbrowserSettingsForm.php, line 18: Administrative class form for the outdatedbrowser module.

Namespace

Drupal\outdatedbrowser\Form

View source

class OutdatedbrowserSettingsForm extends ConfigFormBase {

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return array(
      'outdatedbrowser.settings',
    );
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {

    // Load all settings.
    $config = $this
      ->config('outdatedbrowser.settings');
    $form['outdatedbrowser_compression_type'] = array(
      '#title' => t('Outdated Browser library compression type'),
      '#type' => 'select',
      '#options' => array(
        'minified' => t('Minified (production)'),
        'source' => t('Uncompressed (development version)'),
      ),
      '#default_value' => $config
        ->get('compression_type'),
      '#required' => TRUE,
    );
    $form['outdatedbrowser_bgcolor'] = array(
      '#title' => t('Outdated Browser message: background color'),
      '#description' => t('The background color of the displayed browser upgrade advice. Must be a valid hexadecimal CSS color string, such as @hex.', array(
        '@hex' => '#f25648',
      )),
      '#type' => 'color',
      '#default_value' => $config
        ->get('bgcolor'),
      '#required' => TRUE,
    );
    $form['outdatedbrowser_color'] = array(
      '#title' => t('Outdated Browser message: font color'),
      '#description' => t('The font color of the displayed browser upgrade advice. Must be a valid hexadecimal CSS color string, such as @hex.', array(
        '@hex' => '#ffffff',
      )),
      '#type' => 'color',
      '#default_value' => $config
        ->get('color'),
      '#required' => TRUE,
    );
    $form['outdatedbrowser_lowerthan'] = array(
      '#title' => t('Outdated Browser message: targeting browser'),
      '#description' => t('The targeting browser of the displayed browser upgrade advice, either a CSS property or an Internet Explorer version.'),
      '#type' => 'textfield',
      '#default_value' => $config
        ->get('lowerthan'),
      '#required' => TRUE,
    );
    $form['outdatedbrowser_lang_files_path'] = array(
      '#title' => t('Outdated Browser message files'),
      '#description' => t('Language files location - you can use the outdatedbrowser library path or your own path with additional language files added and HTML/css adapted.'),
      '#type' => 'textfield',
      '#default_value' => $config
        ->get('lang_files_path', 'libraries/outdated-browser/outdatedbrowser/lang'),
      '#required' => TRUE,
    );
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Get config factory and load all settings.
    $config = $this->configFactory
      ->getEditable('outdatedbrowser.settings');
    $compression_type_changed = $config
      ->get('compression_type') != $form_state
      ->getValue('outdatedbrowser_compression_type');
    if ($compression_type_changed) {

      // Invalidate the library_info cache.
      \Drupal::cache('discovery')
        ->invalidate('library_info');
    }
    $config
      ->set('compression_type', $form_state
      ->getValue('outdatedbrowser_compression_type'))
      ->set('bgcolor', $form_state
      ->getValue('outdatedbrowser_bgcolor'))
      ->set('color', $form_state
      ->getValue('outdatedbrowser_color'))
      ->set('lowerthan', $form_state
      ->getValue('outdatedbrowser_lowerthan'))
      ->set('lang_files_path', $form_state
      ->getValue('outdatedbrowser_lang_files_path'));
    $config
      ->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
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.
OutdatedbrowserSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
OutdatedbrowserSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
OutdatedbrowserSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
OutdatedbrowserSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
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 OutdatedbrowserSettingsForm in Outdated Browser 8

Hierarchy

File

Namespace

Members

API Navigation