class GeolocationGoogleMapFormatter in Geolocation Field 8

Plugin implementation of the 'geolocation_googlemap' formatter.

Plugin annotation


@FieldFormatter(
  id = "geolocation_map",
  module = "geolocation",
  label = @Translation("Geolocation Google Maps API - Map"),
  field_types = {
    "geolocation"
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
    class \Drupal\geolocation\Plugin\Field\FieldFormatter\GeolocationGoogleMapFormatter uses GeolocationItemTokenTrait, GoogleMapsDisplayTrait

Expanded class hierarchy of GeolocationGoogleMapFormatter

File

src/Plugin/Field/FieldFormatter/GeolocationGoogleMapFormatter.php, line 25

Namespace

Drupal\geolocation\Plugin\Field\FieldFormatter

View source

class GeolocationGoogleMapFormatter extends FormatterBase {
  use GoogleMapsDisplayTrait;
  use GeolocationItemTokenTrait;

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    $settings = [];
    $settings['title'] = '';
    $settings['set_marker'] = TRUE;
    $settings['common_map'] = FALSE;
    $settings['info_text'] = '';
    $settings += parent::defaultSettings();
    $settings['use_overridden_map_settings'] = FALSE;
    $settings += self::getGoogleMapDefaultSettings();
    return $settings;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $settings = $this
      ->getSettings();
    $element['set_marker'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Set map marker'),
      '#description' => $this
        ->t('The map will be centered on the stored location. Additionally a marker can be set at the exact location.'),
      '#default_value' => $settings['set_marker'],
    ];
    $cardinality = $this->fieldDefinition
      ->getFieldStorageDefinition()
      ->getCardinality();
    if ($cardinality == FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED || $cardinality > 1) {
      $element['common_map'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Display multiple values on a common map'),
        '#description' => $this
          ->t('By default, each value will be displayed in a separate map. Settings this option displays all values on a common map instead. This settings is only useful on multi-value fields.'),
        '#default_value' => $settings['common_map'],
        '#states' => [
          'visible' => [
            ':input[name="fields[' . $this->fieldDefinition
              ->getName() . '][settings_edit_form][settings][set_marker]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ];
    }
    $element['title'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Marker title'),
      '#description' => $this
        ->t('When the cursor hovers on the marker, this title will be shown as description.'),
      '#default_value' => $settings['title'],
      '#states' => [
        'visible' => [
          ':input[name="fields[' . $this->fieldDefinition
            ->getName() . '][settings_edit_form][settings][set_marker]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $element['info_text'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Marker info text'),
      '#description' => $this
        ->t('When the marker is clicked, this text will be shown in a popup above it. Leave blank to not display. Token replacement supported.'),
      '#default_value' => $settings['info_text'],
      '#states' => [
        'visible' => [
          ':input[name="fields[' . $this->fieldDefinition
            ->getName() . '][settings_edit_form][settings][set_marker]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $element['replacement_patterns'] = [
      '#type' => 'details',
      '#title' => 'Replacement patterns',
      '#description' => $this
        ->t('The following replacement patterns are available for the "Info text" and the "Hover title" settings.'),
      '#states' => [
        'visible' => [
          ':input[name="fields[' . $this->fieldDefinition
            ->getName() . '][settings_edit_form][settings][set_marker]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $element['replacement_patterns']['token_geolocation'] = $this
      ->getTokenHelp();
    $element += $this
      ->getGoogleMapsSettingsForm($settings, 'fields][' . $this->fieldDefinition
      ->getName() . '][settings_edit_form][settings][');
    $element['use_overridden_map_settings'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Use custom map settings if provided'),
      '#description' => $this
        ->t('The Geolocation GoogleGeocoder widget optionally allows to define custom map settings to use here.'),
      '#default_value' => $settings['use_overridden_map_settings'],
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $settings = $this
      ->getSettings();
    $summary = [];
    $summary[] = $this
      ->t('Marker set: @marker', [
      '@marker' => $settings['set_marker'] ? $this
        ->t('Yes') : $this
        ->t('No'),
    ]);
    if ($settings['set_marker']) {
      $summary[] = $this
        ->t('Marker Title: @type', [
        '@type' => $settings['title'],
      ]);
      $summary[] = $this
        ->t('Marker Info Text: @type', [
        '@type' => current(explode(chr(10), wordwrap($settings['info_text'], 30))),
      ]);
      if (!empty($settings['common_map'])) {
        $summary[] = $this
          ->t('Common Map Display: Yes');
      }
    }
    $summary = array_merge($summary, $this
      ->getGoogleMapsSettingsSummary($settings));
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    if ($items
      ->count() == 0) {
      return [];
    }
    $settings = $this
      ->getSettings();
    $map_settings = $this
      ->getGoogleMapsSettings($this
      ->getSettings());
    if ($settings['use_overridden_map_settings'] && !empty($items
      ->get(0)
      ->getValue()['data']['google_map_settings']) && is_array($items
      ->get(0)
      ->getValue()['data']['google_map_settings'])) {
      $map_settings = $this
        ->getGoogleMapsSettings($items
        ->get(0)
        ->getValue()['data']);
    }
    $render_array = [
      '#theme' => 'geolocation_map_formatter',
      '#attached' => [
        'library' => [
          'geolocation/geolocation.formatter.googlemap',
        ],
        'drupalSettings' => [
          'geolocation' => [
            'google_map_url' => $this
              ->getGoogleMapsApiUrl(),
          ],
        ],
      ],
    ];
    if (empty($settings['set_marker'])) {
      $single_map = $render_array;
      $unique_id = uniqid("map-canvas-");
      if ($single_center = $items
        ->get(0)) {
        $single_map['#latitude'] = $items
          ->get(0)
          ->getValue()['lat'];
        $single_map['#longitude'] = $items
          ->get(0)
          ->getValue()['lng'];
      }
      $single_map['#uniqueid'] = $unique_id;
      $single_map['#attached']['drupalSettings']['geolocation']['maps'][$unique_id] = [
        'settings' => $map_settings,
      ];
      return $single_map;
    }
    $elements = [];
    $token_context = [
      $this->fieldDefinition
        ->getTargetEntityTypeId() => $items
        ->getEntity(),
    ];
    $locations = [];
    foreach ($items as $delta => $item) {
      $token_context['geolocation_current_item'] = $item;
      $title = \Drupal::token()
        ->replace($settings['title'], $token_context, [
        'callback' => [
          $this,
          'geolocationItemTokens',
        ],
        'clear' => TRUE,
      ]);
      $title = PlainTextOutput::renderFromHtml($title);
      if (empty($title)) {
        $title = $item->lat . ', ' . $item->lng;
      }
      $content = \Drupal::token()
        ->replace($settings['info_text'], $token_context, [
        'callback' => [
          $this,
          'geolocationItemTokens',
        ],
        'clear' => TRUE,
      ]);
      $content = PlainTextOutput::renderFromHtml($content);
      $location = [
        '#theme' => 'geolocation_common_map_location',
        '#content' => $content,
        '#title' => $title,
        '#position' => [
          'lat' => $item->lat,
          'lng' => $item->lng,
        ],
      ];
      if (!empty($settings['common_map'])) {
        $locations[] = $location;
      }
      else {
        $unique_id = uniqid("map-canvas-");
        $elements[$delta] = $render_array;
        $elements[$delta]['#locations'] = [
          $location,
        ];
        $elements[$delta]['#uniqueid'] = $unique_id;
        $elements[$delta]['#attached']['drupalSettings']['geolocation']['maps'][$unique_id] = [
          'settings' => $map_settings,
        ];
      }
    }
    if (!empty($settings['common_map'])) {
      $unique_id = uniqid("map-canvas-");
      $elements = $render_array;
      $elements['#locations'] = $locations;
      $elements['#uniqueid'] = $unique_id;
      $elements['#attached']['drupalSettings']['geolocation']['maps'][$unique_id] = [
        'settings' => $map_settings,
      ];
    }
    return $elements;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
FormatterBase::$fieldDefinition	protected	property	The field definition.
FormatterBase::$label	protected	property	The label display setting.
FormatterBase::$settings	protected	property	The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode	protected	property	The view mode.
FormatterBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	11
FormatterBase::getFieldSetting	protected	function	Returns the value of a field setting.
FormatterBase::getFieldSettings	protected	function	Returns the array of field settings.
FormatterBase::isApplicable	public static	function	Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable	14
FormatterBase::prepareView	public	function	Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView	2
FormatterBase::view	public	function	Builds a renderable array for a fully themed field. Overrides FormatterInterface::view	1
FormatterBase::__construct	public	function	Constructs a FormatterBase object. Overrides PluginBase::__construct	11
GeolocationGoogleMapFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
GeolocationGoogleMapFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
GeolocationGoogleMapFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
GeolocationGoogleMapFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
GeolocationItemTokenTrait::geolocationItemTokens	public	function	Token replacement support function, callback to token replacement function.
GeolocationItemTokenTrait::getTokenHelp	public	function	Return token form element.
GoogleMapsDisplayTrait::$GOOGLEMAPSAPIURL	public static	property	Google maps url with default parameters.
GoogleMapsDisplayTrait::$HYBRID	public static	property	Google map style - Hybrid.
GoogleMapsDisplayTrait::$MAXZOOMLEVEL	public static	property	Google map max zoom level.
GoogleMapsDisplayTrait::$MINZOOMLEVEL	public static	property	Google map min zoom level.
GoogleMapsDisplayTrait::$ROADMAP	public static	property	Google map style - Roadmap.
GoogleMapsDisplayTrait::$SATELLITE	public static	property	Google map style - Satellite.
GoogleMapsDisplayTrait::$TERRAIN	public static	property	Google map style - Terrain.
GoogleMapsDisplayTrait::getGoogleMapDefaultSettings	public static	function	Provide a populated settings array.
GoogleMapsDisplayTrait::getGoogleMapsApiParameters	public	function	Return all module and custom defined parameters.
GoogleMapsDisplayTrait::getGoogleMapsApiUrl	public	function	Return the fully build URL to load Google Maps API.
GoogleMapsDisplayTrait::getGoogleMapsSettings	public	function	Provide settings ready to handover to JS to feed to Google Maps.
GoogleMapsDisplayTrait::getGoogleMapsSettingsForm	public	function	Provide a generic map settings form array.
GoogleMapsDisplayTrait::getGoogleMapsSettingsSummary	public	function	Provide a summary array to use in field formatters.
GoogleMapsDisplayTrait::getMapTypes	private	function	An array of all available map types.
GoogleMapsDisplayTrait::validateGoogleMapsSettingsForm	public	function	Validate the form elements defined above.
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::getSetting	public	function	Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings	public	function	Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
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.

You are here

class GeolocationGoogleMapFormatter in Geolocation Field 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation