You are here

Home » API reference » Colorized google maps block 8 » ColorizedGmapConfigurationForm.php

class ColorizedGmapConfigurationForm in Colorized google maps block 8

Defines a form that configures forms module settings.

Hierarchy

Expanded class hierarchy of ColorizedGmapConfigurationForm

1 string reference to 'ColorizedGmapConfigurationForm'
colorized_gmap.routing.yml in ./colorized_gmap.routing.yml
colorized_gmap.routing.yml

File

src/Form/ColorizedGmapConfigurationForm.php, line 14

Namespace

Drupal\colorized_gmap\Form
View source 
class ColorizedGmapConfigurationForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, Request $request = NULL) {
    $config = $this
      ->config('colorized_gmap.settings');
    $api_key_url = Url::fromUri('https://developers.google.com/maps/documentation/javascript/get-api-key', [
      'attributes' => [
        'target' => '_blank',
      ],
      'absolute' => TRUE,
    ]);
    $api_key_link = Link::fromTextAndUrl($this
      ->t('this'), $api_key_url)
      ->toString();
    $client_id_url = Url::fromUri('https://developers.google.com/maps/documentation/javascript/get-api-key#client-id', [
      'attributes' => [
        'target' => '_blank',
      ],
      'absolute' => TRUE,
    ]);
    $client_id_link = Link::fromTextAndUrl($this
      ->t('this'), $client_id_url)
      ->toString();
    $private_key_url = Url::fromUri('https://developers.google.com/maps/documentation/business/webservices/auth#how_do_i_get_my_signing_key', [
      'attributes' => [
        'target' => '_blank',
      ],
      'absolute' => TRUE,
    ]);
    $private_key_link = Link::fromTextAndUrl($this
      ->t('this'), $private_key_url)
      ->toString();
    $form['colorized_gmap_auth_method'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Google API Authentication Method'),
      '#description' => $this
        ->t('Google API Authentication Method'),
      '#default_value' => $config
        ->get('colorized_gmap_auth_method'),
      '#options' => [
        1 => $this
          ->t('API Key'),
        2 => $this
          ->t('Google Maps API for Work'),
      ],
    ];
    $form['colorized_gmap_api_key'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Google Places API Key'),
      '#default_value' => $config
        ->get('colorized_gmap_api_key'),
      '#description' => $this
        ->t('Please visit @get-key page to get API key. This module will not work without it.', [
        '@get-key' => $api_key_link,
      ]),
      '#required' => FALSE,
      '#states' => [
        'visible' => [
          ':input[name="colorized_gmap_auth_method"]' => [
            'value' => 1,
          ],
        ],
      ],
    ];
    $form['colorized_gmap_client_id'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Google Maps API for Work: Client ID'),
      '#description' => $this
        ->t('For more information, visit @client-id page', [
        '@client-id' => $client_id_link,
      ]),
      '#default_value' => $config
        ->get('colorized_gmap_client_id'),
      '#required' => FALSE,
      '#states' => [
        'visible' => [
          ':input[name="colorized_gmap_auth_method"]' => [
            'value' => 2,
          ],
        ],
      ],
    ];
    $form['colorized_gmap_private_key'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Google Maps API for Work: Private/Signing Key'),
      '#description' => $this
        ->t('For more information, visit @private-key page', [
        '@private-key' => $private_key_link,
      ]),
      '#default_value' => $config
        ->get('colorized_gmap_private_key'),
      '#required' => FALSE,
      '#states' => [
        'visible' => [
          ':input[name="colorized_gmap_auth_method"]' => [
            'value' => 2,
          ],
        ],
      ],
    ];
    $form['#attached']['library'][] = 'colorized_gmap/colorized_gmap.colorpicker';
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $auth_method = $form_state
      ->getValue('colorized_gmap_auth_method');
    if ($auth_method == 1 && empty($form_state
      ->getValue('colorized_gmap_api_key'))) {
      $form_state
        ->setErrorByName('colorized_gmap_api_key', $this
        ->t('Google Places API Key is required.'));
    }
    if ($auth_method == 2 && empty($form_state
      ->getValue('colorized_gmap_client_id'))) {
      $form_state
        ->setErrorByName('colorized_gmap_client_id', $this
        ->t('Client ID is required.'));
    }
    if ($auth_method == 2 && empty($form_state
      ->getValue('colorized_gmap_private_key'))) {
      $form_state
        ->setErrorByName('colorized_gmap_private_key', $this
        ->t('Private/Signing Key is required.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $this
      ->config('colorized_gmap.settings')
      ->set('colorized_gmap_auth_method', $values['colorized_gmap_auth_method'])
      ->save();
    $this
      ->config('colorized_gmap.settings')
      ->set('colorized_gmap_api_key', $values['colorized_gmap_api_key'])
      ->save();
    $this
      ->config('colorized_gmap.settings')
      ->set('colorized_gmap_client_id', $values['colorized_gmap_client_id'])
      ->save();
    $this
      ->config('colorized_gmap.settings')
      ->set('colorized_gmap_private_key', $values['colorized_gmap_private_key'])
      ->save();
    $this
      ->messenger()
      ->addMessage('Settings are saved');
  }

}

Members

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