class GeofieldGoogleStaticMapFormatter in Geofield Map 8.2

Plugin implementation of the 'geofield_static_google_map' formatter.

Plugin annotation


@FieldFormatter(
  id = "geofield_static_google_map",
  label = @Translation("Geofield Google Map (static)"),
  field_types = {
    "geofield"
  }
)

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\geofield_map_extras\Plugin\Field\FieldFormatter\GeofieldGoogleStaticMapFormatter implements ContainerFactoryPluginInterface uses GeofieldMapFieldTrait

Expanded class hierarchy of GeofieldGoogleStaticMapFormatter

File

modules/geofield_map_extras/src/Plugin/Field/FieldFormatter/GeofieldGoogleStaticMapFormatter.php, line 27

Namespace

Drupal\geofield_map_extras\Plugin\Field\FieldFormatter

View source

class GeofieldGoogleStaticMapFormatter extends FormatterBase implements ContainerFactoryPluginInterface {
  use GeofieldMapFieldTrait;

  /**
   * The Link generator Service.
   *
   * @var \Drupal\Core\Utility\LinkGeneratorInterface
   */
  protected $link;

  /**
   * GeofieldStaticGoogleMapFormatter constructor.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the formatter is associated.
   * @param array $settings
   *   The formatter settings.
   * @param string $label
   *   The formatter label display setting.
   * @param string $view_mode
   *   The view mode.
   * @param array $third_party_settings
   *   Any third party settings settings.
   * @param \Drupal\Core\Utility\LinkGeneratorInterface $link_generator
   *   The Link Generator service.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, LinkGeneratorInterface $link_generator) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->link = $link_generator;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
      ->get('link_generator'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'width' => 200,
      'height' => 200,
      'scale' => 2,
      'zoom' => 13,
      'langcode' => 'en',
      'static_map_type' => 'roadmap',
      'marker_color' => '#ff0000',
      'marker_size' => 'normal',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  protected function getFormatterIntro() {
    return $this
      ->t("Renders a Google Map, according to the @map_static_api_link.<br>Note: <u>Only Points supported</u>, and not Geometries (Polylines, Polygons, etc.).", [
      '@map_static_api_link' => $this->link
        ->generate($this
        ->t('Google Maps Static API'), Url::fromUri('https://developers.google.com/maps/documentation/maps-static/dev-guide', [
        'absolute' => TRUE,
        'attributes' => [
          'target' => 'blank',
        ],
      ])),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = [];
    $settings = $this
      ->getSettings();
    $elements['intro'] = [
      '#type' => 'html_tag',
      '#tag' => 'div',
      '#value' => $this
        ->getFormatterIntro(),
    ];

    // Set Google Api Key Element.
    $elements['map_google_api_key'] = $this
      ->setMapGoogleApiKeyElement();
    $elements['gmaps_api_link_markup'] = [
      '#markup' => $this
        ->t('The following settings comply with the @gmaps_api_link.', [
        '@gmaps_api_link' => $this->link
          ->generate($this
          ->t('Google Maps Static API'), Url::fromUri('https://developers.google.com/maps/documentation/maps-static/dev-guide#introduction', [
          'absolute' => TRUE,
          'attributes' => [
            'target' => 'blank',
          ],
        ])),
      ]),
    ];
    $elements['width'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Map width'),
      '#default_value' => $settings['width'],
      '#size' => 10,
      '#min' => 1,
      '#step' => 1,
      '#description' => $this
        ->t('The width of the map, in pixels.'),
      '#required' => TRUE,
    ];
    $elements['height'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Map height'),
      '#default_value' => $settings['height'],
      '#size' => 10,
      '#min' => 1,
      '#step' => 1,
      '#description' => $this
        ->t('The height of the map, in pixels.'),
      '#required' => TRUE,
    ];
    $elements['scale'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Scale'),
      '#default_value' => $settings['scale'],
      '#options' => [
        '1' => '1',
        '2' => '2',
        '4' => '4',
      ],
      '#description' => $this
        ->t('The size of the image will be multiplied by this factor, which is useful for ensuring retina-capable displays show the correct size.<br>Note that maximum size restrictions exist in Google Static Maps API.<br>Refer to the @image_sizes_link if you are unsure what values to use here.', [
        ':doc_url' => 'https://developers.google.com/maps/documentation/maps-static/dev-guide#Imagesizes',
        '@image_sizes_link' => $this->link
          ->generate($this
          ->t('Image Sizes documentation'), Url::fromUri('https://developers.google.com/maps/documentation/maps-static/dev-guide#Imagesizes', [
          'absolute' => TRUE,
          'attributes' => [
            'target' => 'blank',
          ],
        ])),
      ]),
    ];
    $elements['zoom'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Map zoom'),
      '#default_value' => $settings['zoom'],
      '#size' => 10,
      '#min' => 1,
      '#step' => 1,
      '#max' => 20,
      '#description' => $this
        ->t("The zoom level. Must be an integer between 1 and 20.<br>Note: This will be ignored in case of multiple markers, and the map will extend to markers bounds.."),
      '#required' => TRUE,
    ];
    $elements['static_map_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Map type'),
      '#default_value' => $settings['static_map_type'],
      '#options' => $this
        ->getStaticMapOptions(),
    ];
    $elements['marker_color'] = [
      '#type' => 'color',
      '#title' => $this
        ->t('Marker Color'),
      '#default_value' => $settings['marker_color'],
      '#description' => $this
        ->t("Accepts an HEX cod color.<br>Examples: #ff0000 (red), #00ff00 (green), #0000ff (blu).<br>Leave empty for default value fallback (red).<br>The value wiil be converted to comply with Google @marker_styles_link.", [
        '@marker_styles_link' => $this->link
          ->generate($this
          ->t('Marker Styles documentation'), Url::fromUri('https://developers.google.com/maps/documentation/maps-static/dev-guide#MarkerStyles', [
          'absolute' => TRUE,
          'attributes' => [
            'target' => 'blank',
          ],
        ])),
      ]),
    ];
    $elements['marker_size'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Marker Size'),
      '#default_value' => $settings['marker_size'],
      '#options' => [
        'normal' => $this
          ->t('normal'),
        'tiny' => $this
          ->t('tiny'),
        'mid' => $this
          ->t('mid'),
        'small' => $this
          ->t('small'),
      ],
      '#description' => $this
        ->t("Refer to the @marker_styles_link if you are unsure what values to use here", [
        '@marker_styles_link' => $this->link
          ->generate($this
          ->t('Marker Styles documentation'), Url::fromUri('https://developers.google.com/maps/documentation/maps-static/dev-guide#MarkerStyles', [
          'absolute' => TRUE,
          'attributes' => [
            'target' => 'blank',
          ],
        ])),
      ]),
    ];
    return $elements;
  }

  /**
   * Retrieves options for the static map type.
   *
   * @return array
   *   An associative array of map types where keys are type machine names, and
   *   values are their labels. The types are defined in
   *   https://developers.google.com/maps/documentation/maps-static/dev-guide#MapTypes
   */
  protected function getStaticMapOptions() {
    return [
      'roadmap' => $this
        ->t('Roadmap'),
      'satellite' => $this
        ->t('Satellite'),
      'terrain' => $this
        ->t('Terrain'),
      'hybrid' => $this
        ->t('Hybrid'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $settings = $this
      ->getSettings();
    $map_types = $this
      ->getStaticMapOptions();
    $summary = [
      'formatter_intro' => $this
        ->getFormatterIntro(),
      'map_google_api_key' => $this
        ->setMapGoogleApiKeyElement(),
      'map_dimensions' => $this
        ->t('Map dimensions: @width x @height', [
        '@width' => $settings['width'],
        '@height' => $settings['height'],
      ]),
      'zoom_level' => $this
        ->t('Zoom level: @zoom', [
        '@zoom' => $settings['zoom'],
      ]),
      'map_type' => $this
        ->t('Map type: <em>@type</em>', [
        '@type' => $map_types[$settings['static_map_type']],
      ]),
      'marker_color' => $this
        ->t('Markers Size: @marker_size', [
        '@marker_size' => $settings['marker_size'],
      ]),
      'marker_size' => $this
        ->t('Markers Size: @marker_size', [
        '@marker_size' => $settings['marker_size'],
      ]),
    ];

    // Attach Geofield Map Library.
    $summary['library'] = [
      '#attached' => [
        'library' => [
          'geofield_map/geofield_map_general',
        ],
      ],
    ];
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $locations = [];
    $settings = $this
      ->getSettings();
    $language = $langcode !== Language::LANGCODE_NOT_SPECIFIED ? $langcode : 'en';
    foreach ($items as $item) {
      if ($item
        ->isEmpty()) {
        continue;
      }
      $value = $item
        ->getValue();
      if ($value['geo_type'] !== 'Point') {
        continue;
      }
      $locations[] = urlencode($value['latlon']);
    }
    $elements = [];

    // Return a single item.
    $elements[0] = [
      '#theme' => 'geofield_static_google_map',
      '#width' => $settings['width'],
      '#height' => $settings['height'],
      '#scale' => $settings['scale'],
      '#locations' => $locations,
      '#zoom' => $settings['zoom'],
      '#langcode' => $language,
      '#static_map_type' => $settings['static_map_type'],
      '#apikey' => (string) $this
        ->getGmapApiKey(),
      '#marker_color' => $settings['marker_color'],
      '#marker_size' => $settings['marker_size'],
    ];
    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::$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::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
GeofieldGoogleStaticMapFormatter::$link	protected	property	The Link generator Service. Overrides GeofieldMapFieldTrait::$link
GeofieldGoogleStaticMapFormatter::create	public static	function	Creates an instance of the plugin. Overrides FormatterBase::create
GeofieldGoogleStaticMapFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
GeofieldGoogleStaticMapFormatter::getFormatterIntro	protected	function
GeofieldGoogleStaticMapFormatter::getStaticMapOptions	protected	function	Retrieves options for the static map type.
GeofieldGoogleStaticMapFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
GeofieldGoogleStaticMapFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
GeofieldGoogleStaticMapFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
GeofieldGoogleStaticMapFormatter::__construct	public	function	GeofieldStaticGoogleMapFormatter constructor. Overrides FormatterBase::__construct
GeofieldMapFieldTrait::$controlPositionsOptions	protected	property	Geofield Map Controls Positions Options.
GeofieldMapFieldTrait::$customMapStylePlaceholder	protected	property	Custom Map Style Placeholder.
GeofieldMapFieldTrait::$fieldDefinition	protected	property	The FieldDefinition.
GeofieldMapFieldTrait::$geoPhpWrapper	protected	property	The geoPhpWrapper service.	3
GeofieldMapFieldTrait::$gMapTypesOptions	protected	property	Google Map Types Options.
GeofieldMapFieldTrait::$infowindowFieldTypesOptions	protected	property	Infowindow Field Types Options.
GeofieldMapFieldTrait::generateGmapSettingsForm	public	function	Generate the Google Map Settings Form.
GeofieldMapFieldTrait::getDefaultSettings	public static	function	Get the Default Settings.
GeofieldMapFieldTrait::getGeoJsonData	protected	function	Transform Geofield data into Geojson features.
GeofieldMapFieldTrait::getGmapApiKey	private	function	Get the GMap Api Key from the geofield_map.google_maps service.
GeofieldMapFieldTrait::getMapGeocoderTitle	private	function	Generate the Google Map Settings Form.
GeofieldMapFieldTrait::preProcessMapSettings	protected	function	Pre Process the MapSettings.
GeofieldMapFieldTrait::setCustomStyleMapElement	private	function	Set Custom Map Style Element.
GeofieldMapFieldTrait::setGeocoderMapControl	protected	function	Set Map Geocoder Control Element.
GeofieldMapFieldTrait::setGeometriesAdditionalOptionsElement	private	function	Set Map Geometries Options Element.
GeofieldMapFieldTrait::setMapAdditionalOptionsElement	private	function	Set Map Additional Options Element.
GeofieldMapFieldTrait::setMapCenterElement	private	function	Set Map Center Element.
GeofieldMapFieldTrait::setMapControlsElement	private	function	Set Map Control Element.
GeofieldMapFieldTrait::setMapDimensionsElement	private	function	Set Map Dimension Element.
GeofieldMapFieldTrait::setMapEmptyElement	private	function	Set Map Empty Options Element.
GeofieldMapFieldTrait::setMapGoogleApiKeyElement	private	function	Set Map Google Api Key Element.
GeofieldMapFieldTrait::setMapLazyLoad	protected	function	Set Map Lazy Load Element.
GeofieldMapFieldTrait::setMapMarkerAndInfowindowElement	private	function	Set Map Marker and Infowindow Element.
GeofieldMapFieldTrait::setMapMarkerclusterElement	private	function	Set Map Marker Cluster Element.
GeofieldMapFieldTrait::setMapOmsElement	private	function	Set Overlapping Marker Spiderfier Element.
GeofieldMapFieldTrait::setMapZoomAndPanElement	private	function	Set Map Zoom and Pan Element.
GeofieldMapFieldTrait::validateGeocoderProviders	public static	function	Validates the Geocoder Providers element.
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 GeofieldGoogleStaticMapFormatter in Geofield Map 8.2

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation