class GeolocationGoogleMap in Geolocation Field 8

Provides a render element to display a geolocation map.

Usage example:

$form['map'] = [
  '#type' => 'geolocation_google_map',
  '#prefix' => $this
    ->t('Geolocation Google Map Render Element'),
  '#description' => $this
    ->t('Render element type "geolocation_google_map"'),
  '#longitude' => 42,
  '#latitude' => 34,
  '#width' => 100,
  '#height' => 100,
  '#zoom' => 4,
  '#controls' => FALSE,
];

Plugin annotation

@FormElement("geolocation_google_map");

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
    class \Drupal\geolocation\Element\GeolocationGoogleMap uses GoogleMapsDisplayTrait

Expanded class hierarchy of GeolocationGoogleMap

1 #type use of GeolocationGoogleMap

DemoRenderElementController::renderElementDemo in modules/geolocation_demo/src/Controller/DemoRenderElementController.php: Return the non-functional geocoding widget form.

File

src/Element/GeolocationGoogleMap.php, line 28

Namespace

Drupal\geolocation\Element

View source

class GeolocationGoogleMap extends RenderElement {
  use GoogleMapsDisplayTrait;

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    return [
      '#pre_render' => [
        [
          $this,
          'preRenderGoogleMapElement',
        ],
      ],
      '#latitude' => NULL,
      '#longitude' => NULL,
      '#locations' => NULL,
      '#height' => NULL,
      '#width' => NULL,
      '#zoom' => NULL,
      '#controls' => FALSE,
    ];
  }

  /**
   * Map element.
   *
   * @param array $element
   *   Element.
   *
   * @return array
   *   Renderable map.
   */
  public function preRenderGoogleMapElement(array $element) {
    $render_array = [
      '#theme' => 'geolocation_map_formatter',
      '#attached' => [
        'library' => [
          'geolocation/geolocation.formatter.googlemap',
        ],
        'drupalSettings' => [
          'geolocation' => [
            'google_map_url' => $this
              ->getGoogleMapsApiUrl(),
          ],
        ],
      ],
    ];
    if (!empty($element['#prefix'])) {
      $render_array['#prefix'] = $element['#prefix'];
    }
    if (!empty($element['#suffix'])) {
      $render_array['#suffix'] = $element['#suffix'];
    }
    $settings = $this
      ->getGoogleMapDefaultSettings();
    if (!empty($element['#settings'])) {
      $settings = array_replace_recursive($settings, $element['#settings']);
    }
    $settings['google_map_settings']['info_auto_display'] = FALSE;
    if (!empty($element['#height'])) {
      $settings['google_map_settings']['height'] = (int) $element['#height'] . 'px';
    }
    if (!empty($element['#width'])) {
      $settings['google_map_settings']['width'] = (int) $element['#width'] . 'px';
    }
    if (!empty($element['#zoom'])) {
      $settings['google_map_settings']['zoom'] = (int) $element['#zoom'];
    }
    if (empty($element['#controls'])) {
      $settings['google_map_settings']['streetViewControl'] = FALSE;
      $settings['google_map_settings']['mapTypeControl'] = FALSE;
      $settings['google_map_settings']['rotateControl'] = FALSE;
      $settings['google_map_settings']['fullscreenControl'] = FALSE;
      $settings['google_map_settings']['zoomControl'] = FALSE;
    }
    $unique_id = uniqid("map-canvas-");
    if (empty($element['#locations'])) {
      $render_array['#latitude'] = $element['#latitude'];
      $render_array['#longitude'] = $element['#longitude'];
      $render_array['#uniqueid'] = $unique_id;
      $render_array['#attached']['drupalSettings']['geolocation']['maps'][$unique_id] = [
        'settings' => $settings,
      ];
    }
    else {
      $locations = [];
      foreach ($element['#locations'] as $delta => $item) {
        $fallback = $item['latitude'] . ' ' . $item['longitude'];
        $locations[] = [
          '#theme' => 'geolocation_common_map_location',
          '#content' => empty($item['content']) ? $fallback : $item['content'],
          '#title' => empty($item['title']) ? $fallback : $item['title'],
          '#position' => [
            'lat' => $item['latitude'],
            'lng' => $item['longitude'],
          ],
        ];
      }
      $render_array['#locations'] = $locations;
      $render_array['#uniqueid'] = $unique_id;
      $render_array['#attached']['drupalSettings']['geolocation']['maps'][$unique_id] = [
        'settings' => $settings,
      ];
    }
    return $render_array;
  }

}

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
GeolocationGoogleMap::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo	1
GeolocationGoogleMap::preRenderGoogleMapElement	public	function	Map 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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
RenderElement::preRenderAjaxForm	public static	function	Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup	public static	function	Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm	public static	function	Form element processing handler for the #ajax form property.	1
RenderElement::processGroup	public static	function	Arranges elements into groups.
RenderElement::setAttributes	public static	function	Sets a form element's class attribute. Overrides ElementInterface::setAttributes
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 GeolocationGoogleMap in Geolocation Field 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation