You are here

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

class LeafletMarkerPopup in Geolocation Field 8.3

Same name and namespace in other branches
  1. 8.2 modules/geolocation_leaflet/src/Plugin/geolocation/MapFeature/LeafletMarkerPopup.php \Drupal\geolocation_leaflet\Plugin\geolocation\MapFeature\LeafletMarkerPopup

Provides marker popup.

Plugin annotation


@MapFeature(
  id = "leaflet_marker_popup",
  name = @Translation("Marker Popup"),
  description = @Translation("Open Popup on Marker click."),
  type = "leaflet",
)

Hierarchy

Expanded class hierarchy of LeafletMarkerPopup

File

modules/geolocation_leaflet/src/Plugin/geolocation/MapFeature/LeafletMarkerPopup.php, line 18

Namespace

Drupal\geolocation_leaflet\Plugin\geolocation\MapFeature
View source 
class LeafletMarkerPopup extends MapFeatureBase {

  /**
   * {@inheritdoc}
   */
  public static function getDefaultSettings() {
    return [
      'info_auto_display' => FALSE,
      'max_width' => 300,
      'min_width' => 50,
      'max_height' => 0,
      'auto_pan' => TRUE,
      'keep_in_view' => FALSE,
      'close_button' => TRUE,
      'auto_close' => TRUE,
      'close_on_escape_key' => TRUE,
      'class_name' => '',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getSettingsForm(array $settings, array $parents) {
    $form['info_auto_display'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Automatically show info text.'),
      '#default_value' => $settings['info_auto_display'],
    ];
    $form['max_width'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Max width of the popup, in pixels. 0 will skip setting.'),
      '#default_value' => $settings['max_width'],
    ];
    $form['min_width'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Min width of the popup, in pixels. 0 will skip setting.'),
      '#default_value' => $settings['min_width'],
    ];
    $form['max_height'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('If set, creates a scrollable container of the given height inside a popup if its content exceeds it. 0 will skip setting.'),
      '#default_value' => $settings['max_height'],
    ];
    $form['auto_pan'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t("Set it to false if you don't want the map to do panning animation to fit the opened popup."),
      '#default_value' => $settings['auto_pan'],
    ];
    $form['keep_in_view'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Set it to true if you want to prevent users from panning the popup off of the screen while it is open.'),
      '#default_value' => $settings['keep_in_view'],
    ];
    $form['close_button'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Controls the presence of a close button in the popup.'),
      '#default_value' => $settings['close_button'],
    ];
    $form['auto_close'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Set it to false if you want to override the default behavior of the popup closing when another popup is opened.'),
      '#default_value' => $settings['auto_close'],
    ];
    $form['close_on_escape_key'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Set it to false if you want to override the default behavior of the ESC key for closing of the popup.'),
      '#default_value' => $settings['close_on_escape_key'],
    ];
    $form['class_name'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('A custom CSS class name to assign to the popup.'),
      '#default_value' => $settings['class_name'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function alterMap(array $render_array, array $feature_settings, array $context = []) {
    $render_array = parent::alterMap($render_array, $feature_settings, $context);
    $render_array['#attached'] = BubbleableMetadata::mergeAttachments(empty($render_array['#attached']) ? [] : $render_array['#attached'], [
      'library' => [
        'geolocation_leaflet/mapfeature.' . $this
          ->getPluginId(),
      ],
      'drupalSettings' => [
        'geolocation' => [
          'maps' => [
            $render_array['#id'] => [
              $this
                ->getPluginId() => [
                'enable' => TRUE,
                'infoAutoDisplay' => $feature_settings['info_auto_display'],
                'maxWidth' => $feature_settings['max_width'],
                'minWidth' => $feature_settings['min_width'],
                'maxHeight' => $feature_settings['max_height'],
                'autoPan' => $feature_settings['auto_pan'],
                'keepInView' => $feature_settings['keep_in_view'],
                'closeButton' => $feature_settings['close_button'],
                'autoClose' => $feature_settings['auto_close'],
                'closeOnEscapeKey' => $feature_settings['close_on_escape_key'],
                'className' => $feature_settings['class_name'],
              ],
            ],
          ],
        ],
      ],
    ]);
    return $render_array;
  }

}

Members

Namesort descending 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
LeafletMarkerPopup::alterMap public function Alter render array. Overrides MapFeatureBase::alterMap
LeafletMarkerPopup::getDefaultSettings public static function Provide a populated settings array. Overrides MapFeatureBase::getDefaultSettings
LeafletMarkerPopup::getSettingsForm public function Provide a generic map settings form array. Overrides MapFeatureBase::getSettingsForm
MapFeatureBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 2
MapFeatureBase::getSettings public function Provide map feature specific settings ready to handover to JS. Overrides MapFeatureInterface::getSettings
MapFeatureBase::getSettingsSummary public function Provide a summary array to use in field formatters. Overrides MapFeatureInterface::getSettingsSummary 2
MapFeatureBase::validateSettingsForm public function Validate Feature Form. Overrides MapFeatureInterface::validateSettingsForm 5
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
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.