class GeolocationZoomGoogleMapFormatter in Geolocation Address Link 8

Plugin implementation of the 'geolocation_zoom_map' formatter.

Identical to the Google Maps formatter except it uses the specific zoom value stored in the field, if any. The normal Geolocation field does not compute or store a zoom value for individual elements. The zoom value can be added by the AddressToGeo service when the entity is saved.

Plugin annotation


@FieldFormatter(
  id = "geolocation_zoom_map",
  module = "geolocation_address_link",
  label = @Translation("Geolocation Google Maps API - Map with dynamic zoom"),
  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
    class \Drupal\geolocation_address_link\Plugin\Field\FieldFormatter\GeolocationZoomGoogleMapFormatter

Expanded class hierarchy of GeolocationZoomGoogleMapFormatter

File

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

Namespace

Drupal\geolocation_address_link\Plugin\Field\FieldFormatter

View source

class GeolocationZoomGoogleMapFormatter extends GeolocationGoogleMapFormatter {

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = parent::viewElements($items, $langcode);
    if (empty($elements)) {
      return $elements;
    }

    // See if there is a zoom value stored in the field's data. If so, swap it into
    // the map settings.
    if (array_key_exists('#attached', $elements)) {
      $data = $items
        ->get(0)
        ->getValue()['data'];
      if (array_key_exists('zoom', $data)) {
        $unique_id = $elements['#uniqueid'];
        $elements['#attached']['drupalSettings']['geolocation']['maps'][$unique_id]['settings']['google_map_settings']['zoom'] = $data['zoom'];
      }
    }
    else {
      foreach ($elements as $delta => $element) {
        $data = $items
          ->get($delta)
          ->getValue()['data'];
        if (array_key_exists('zoom', $data)) {
          $unique_id = $element['#uniqueid'];
          $elements[$delta]['#attached']['drupalSettings']['geolocation']['maps'][$unique_id]['settings']['google_map_settings']['zoom'] = $data['zoom'];
        }
      }
    }
    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
GeolocationItemTokenTrait::geolocationItemTokens	public	function	Token replacement support function, callback to token replacement function.
GeolocationItemTokenTrait::getTokenHelp	public	function	Return token form element.
GeolocationZoomGoogleMapFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides GeolocationGoogleMapFormatter::viewElements
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