You are here

Home » API reference » Dashboards with Layout Builder 8 » DashboardsSettingsForm.php

class DashboardsSettingsForm in Dashboards with Layout Builder 8

Same name and namespace in other branches
  1. 2.0.x src/Form/DashboardsSettingsForm.php \Drupal\dashboards\Form\DashboardsSettingsForm

Class DashboardsSettingsForm.

Hierarchy

Expanded class hierarchy of DashboardsSettingsForm

2 string references to 'DashboardsSettingsForm'
dashboards.routing.yml in ./dashboards.routing.yml
dashboards.routing.yml
dashboards.routing.yml in ./dashboards.routing.yml
dashboards.routing.yml

File

src/Form/DashboardsSettingsForm.php, line 11

Namespace

Drupal\dashboards\Form
View source 
class DashboardsSettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('dashboards.settings');
    $form['colormap'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Choose a colormap'),
      '#description' => $this
        ->t('Colormap'),
      '#options' => [
        'jet' => $this
          ->t('jet'),
        'hsv' => $this
          ->t('hsv'),
        'hot' => $this
          ->t('hot'),
        'cool' => $this
          ->t('cool'),
        'spring' => $this
          ->t('spring'),
        'summer' => $this
          ->t('summer'),
        'autumn' => $this
          ->t('autumn'),
        'winter' => $this
          ->t('winter'),
        'bone' => $this
          ->t('bone'),
        'copper' => $this
          ->t('copper'),
        'greys' => $this
          ->t('greys'),
        'YlGnBu' => $this
          ->t('YlGnBu'),
        'greens' => $this
          ->t('greens'),
        'YlOrRd' => $this
          ->t('YlOrRd'),
        'bluered' => $this
          ->t('bluered'),
        'RdBu' => $this
          ->t('RdBu'),
        'picnic' => $this
          ->t('picnic'),
        'rainbow' => $this
          ->t('rainbow'),
        'portland' => $this
          ->t('portland'),
        'blackbody' => $this
          ->t('blackbody'),
        'earth' => $this
          ->t('earth'),
        'electric' => $this
          ->t('electric'),
        'viridis' => $this
          ->t('viridis'),
        'inferno' => $this
          ->t('inferno'),
        'magma' => $this
          ->t('magma'),
        'plasma' => $this
          ->t('plasma'),
        'warm' => $this
          ->t('warm'),
        'cool' => $this
          ->t('cool'),
        'rainbow-soft' => $this
          ->t('rainbow-soft'),
        'bathymetry' => $this
          ->t('bathymetry'),
        'cdom' => $this
          ->t('cdom'),
        'chlorophyll' => $this
          ->t('chlorophyll'),
        'density' => $this
          ->t('density'),
        'freesurface-blue' => $this
          ->t('freesurface-blue'),
        'freesurface-red' => $this
          ->t('freesurface-red'),
        'oxygen' => $this
          ->t('oxygen'),
        'par' => $this
          ->t('par'),
        'phase' => $this
          ->t('phase'),
        'salinity' => $this
          ->t('salinity'),
        'turbidity' => $this
          ->t('turbidity'),
        'velocity-blue' => $this
          ->t('velocity-blue'),
        'velocity-green' => $this
          ->t('velocity-green'),
        'cubehelix' => $this
          ->t('cubehelix'),
      ],
      '#size' => 1,
      '#default_value' => $config
        ->get('colormap'),
      '#description' => $this
        ->t('See colormaps <a href="@url">here</a>.', [
        '@url' => 'https://github.com/bpostlethwaite/colormap#readme',
      ]),
    ];
    $form['alpha'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Transparency'),
      '#default_value' => $config
        ->get('alpha') ? $config
        ->get('alpha') : 100,
      '#description' => $this
        ->t('Transparency in percent.'),
      '#min' => 20,
      '#max' => 100,
    ];
    $form['shades'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Number of colors in map'),
      '#default_value' => $config
        ->get('shades') ? $config
        ->get('shades') : 20,
      '#min' => 15,
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $this
      ->config('dashboards.settings')
      ->set('colormap', $form_state
      ->getValue('colormap'))
      ->set('alpha', $form_state
      ->getValue('alpha'))
      ->set('shades', $form_state
      ->getValue('shades'))
      ->save();
  }

}

Members

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