You are here

Home » API reference » Geolocation Field 8.3 » GeolocationGeometryWidgetGoogleMaps.php

class GeolocationGeometryWidgetGoogleMaps in Geolocation Field 8.3

Plugin implementation of 'geolocation_geometry_widget_google_maps' widget.

Plugin annotation


@FieldWidget(
  id = "geolocation_geometry_widget_google_maps",
  label = @Translation("Geolocation Geometry Google Maps API - GeoJSON"),
  field_types = {
    "geolocation_geometry_point",
    "geolocation_geometry_multi_point",
    "geolocation_geometry_linestring",
    "geolocation_geometry_multi_linestring",
    "geolocation_geometry_polygon",
    "geolocation_geometry_multi_polygon",
    "geolocation_geometry_geometry",
    "geolocation_geometry_multi_geometry"
  }
)

Hierarchy

Expanded class hierarchy of GeolocationGeometryWidgetGoogleMaps

File

modules/geolocation_google_maps/src/Plugin/Field/FieldWidget/GeolocationGeometryWidgetGoogleMaps.php, line 28

Namespace

Drupal\geolocation_google_maps\Plugin\Field\FieldWidget
View source 
class GeolocationGeometryWidgetGoogleMaps extends WidgetBase {

  /**
   * {@inheritdoc}
   */
  protected $mapProviderId = 'google_maps';

  /**
   * {@inheritdoc}
   */
  protected $mapProviderSettingsFormId = 'google_map_settings';

  /**
   * The entity field manager.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $entityFieldManager;

  /**
   * Map Provider.
   *
   * @var \Drupal\geolocation\MapProviderInterface
   */
  protected $mapProvider = NULL;

  /**
   * {@inheritdoc}
   */
  public function getSettings() {
    $settings = parent::getSettings();
    $map_settings = [];
    if (!empty($settings[$this->mapProviderSettingsFormId])) {
      $map_settings = $settings[$this->mapProviderSettingsFormId];
    }
    if (!empty($this->mapProviderId)) {
      $this->mapProvider = \Drupal::service('plugin.manager.geolocation.mapprovider')
        ->getMapProvider($this->mapProviderId);
    }
    $settings = NestedArray::mergeDeep($settings, [
      $this->mapProviderSettingsFormId => $this->mapProvider
        ->getSettings($map_settings),
    ]);
    return $settings;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $settings = $this
      ->getSettings();
    $element = [];
    if ($this->mapProvider) {
      $element[$this->mapProviderSettingsFormId] = $this->mapProvider
        ->getSettingsForm($settings[$this->mapProviderSettingsFormId], [
        'fields',
        $this->fieldDefinition
          ->getName(),
        'settings_edit_form',
        'settings',
        $this->mapProviderSettingsFormId,
      ]);
    }
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $settings = $this
      ->getSettings();
    $map_provider_settings = empty($settings[$this->mapProviderSettingsFormId]) ? [] : $settings[$this->mapProviderSettingsFormId];
    $summary = array_replace_recursive($summary, $this->mapProvider
      ->getSettingsSummary($map_provider_settings));
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $element['#type'] = 'container';
    $element['#attached'] = [
      'library' => [
        'geolocation_google_maps/widget.google_maps.geojson',
      ],
    ];
    $element['#attributes'] = [
      'class' => [
        'geolocation-geometry-widget-google-maps-geojson',
      ],
    ];
    $element['geojson'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('GeoJSON'),
      '#default_value' => isset($items[$delta]->geojson) ? $items[$delta]->geojson : NULL,
      '#empty_value' => '',
      '#required' => $element['#required'],
      '#attributes' => [
        'class' => [
          'geolocation-geometry-widget-google-maps-geojson-input',
        ],
      ],
    ];
    $settings = $this
      ->getSettings();
    $element['map'] = [
      '#type' => 'geolocation_map',
      '#maptype' => 'google_maps',
      '#weight' => -10,
      '#settings' => $settings[$this->mapProviderSettingsFormId],
      '#context' => [
        'widget' => $this,
      ],
      '#attributes' => [
        'class' => [
          'geolocation-geometry-widget-google-maps-geojson-map',
        ],
      ],
    ];
    return $element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AllowedTagsXssTrait::allowedTags public function Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss().
AllowedTagsXssTrait::displayAllowedTags public function Returns a human-readable list of allowed tags for display in help texts.
AllowedTagsXssTrait::fieldFilterXss public function Filters an HTML string to prevent XSS vulnerabilities.
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
GeolocationGeometryWidgetGoogleMaps::$entityFieldManager protected property The entity field manager.
GeolocationGeometryWidgetGoogleMaps::$mapProvider protected property Map Provider.
GeolocationGeometryWidgetGoogleMaps::$mapProviderId protected property
GeolocationGeometryWidgetGoogleMaps::$mapProviderSettingsFormId protected property
GeolocationGeometryWidgetGoogleMaps::formElement public function Returns the form for a single field widget. Overrides WidgetInterface::formElement
GeolocationGeometryWidgetGoogleMaps::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsBase::getSettings
GeolocationGeometryWidgetGoogleMaps::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetBase::settingsForm
GeolocationGeometryWidgetGoogleMaps::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetBase::settingsSummary
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings 42
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
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.
WidgetBase::$fieldDefinition protected property The field definition.
WidgetBase::$settings protected property The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::addMoreAjax public static function Ajax callback for the "Add another item" button.
WidgetBase::addMoreSubmit public static function Submission handler for the "Add another item" button.
WidgetBase::afterBuild public static function After-build handler for field elements in a form.
WidgetBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 5
WidgetBase::errorElement public function Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement 8
WidgetBase::extractFormValues public function Extracts field values from submitted form values. Overrides WidgetBaseInterface::extractFormValues 2
WidgetBase::flagErrors public function Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors 2
WidgetBase::form public function Creates a form element for a field. Overrides WidgetBaseInterface::form 3
WidgetBase::formMultipleElements protected function Special handling to create form elements for multiple values. 1
WidgetBase::formSingleElement protected function Generates the form element for a single copy of the widget.
WidgetBase::getFieldSetting protected function Returns the value of a field setting.
WidgetBase::getFieldSettings protected function Returns the array of field settings.
WidgetBase::getFilteredDescription protected function Returns the filtered field description.
WidgetBase::getWidgetState public static function Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface::getWidgetState
WidgetBase::getWidgetStateParents protected static function Returns the location of processing information within $form_state.
WidgetBase::handlesMultipleValues protected function Returns whether the widget handles multiple values.
WidgetBase::isApplicable public static function Returns if the widget can be used for the provided field. Overrides WidgetInterface::isApplicable 4
WidgetBase::isDefaultValueWidget protected function Returns whether the widget used for default value form.
WidgetBase::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetInterface::massageFormValues 7
WidgetBase::setWidgetState public static function Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState
WidgetBase::__construct public function Constructs a WidgetBase object. Overrides PluginBase::__construct 5