You are here

Home » API reference » Environment Indicator 8.3 » EnvironmentIndicatorUISettingsForm.php

class EnvironmentIndicatorUISettingsForm in Environment Indicator 8.3

Same name and namespace in other branches
  1. 4.x modules/environment_indicator_ui/src/Form/EnvironmentIndicatorUISettingsForm.php \Drupal\environment_indicator_ui\Form\EnvironmentIndicatorUISettingsForm

Configuration form for Environment Indicator.

Hierarchy

Expanded class hierarchy of EnvironmentIndicatorUISettingsForm

1 string reference to 'EnvironmentIndicatorUISettingsForm'
environment_indicator_ui.routing.yml in modules/environment_indicator_ui/environment_indicator_ui.routing.yml
modules/environment_indicator_ui/environment_indicator_ui.routing.yml

File

modules/environment_indicator_ui/src/Form/EnvironmentIndicatorUISettingsForm.php, line 12

Namespace

Drupal\environment_indicator_ui\Form
View source 
class EnvironmentIndicatorUISettingsForm extends ConfigFormBase implements FormInterface {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('environment_indicator.indicator');
    $form = parent::buildForm($form, $form_state);
    $form['name'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Environment Name'),
      '#description' => $this
        ->t('Enter a name for this environment to be displayed in the admin toolbar.'),
      '#default_value' => $config
        ->get('name'),
    ];
    $form['fg_color'] = [
      '#type' => 'color',
      '#title' => $this
        ->t('Foreground Color'),
      '#description' => $this
        ->t('Foreground color for the admin toolbar. Ex: #0D0D0D.'),
      '#default_value' => $config
        ->get('fg_color'),
    ];
    $form['bg_color'] = [
      '#type' => 'color',
      '#title' => $this
        ->t('Background Color'),
      '#description' => $this
        ->t('Background color for the admin toolbar. Example: #4298f4.'),
      '#default_value' => $config
        ->get('bg_color'),
    ];
    return $form;
  }

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

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $colors = [
      'fg_color' => $form_state
        ->getValue('fg_color'),
      'bg_color' => $form_state
        ->getValue('bg_color'),
    ];
    foreach ($colors as $property_name => $color) {
      if (!preg_match('/^#[a-f0-9]{6}$/i', $color)) {
        $form_state
          ->setErrorByName($property_name, $this
          ->t('Please enter a valid hex value.'));
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('environment_indicator.indicator');
    $properties = [
      'name',
      'fg_color',
      'bg_color',
    ];
    array_walk($properties, function ($property) use ($config, $form_state) {
      $config
        ->set($property, $form_state
        ->getValue($property));
    });
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

}

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