class MarkerInfoBubble in Geolocation Field 8.3

Same name and namespace in other branches

8.2 modules/geolocation_google_maps/src/Plugin/geolocation/MapFeature/MarkerInfoBubble.php \Drupal\geolocation_google_maps\Plugin\geolocation\MapFeature\MarkerInfoBubble

Provides marker infobubble.

Plugin annotation


@MapFeature(
  id = "marker_infobubble",
  name = @Translation("Marker InfoBubble"),
  description = @Translation("Open InfoBubble on Marker click."),
  type = "google_maps",
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\geolocation\MapFeatureBase implements ContainerFactoryPluginInterface, MapFeatureInterface
    class \Drupal\geolocation_google_maps\Plugin\geolocation\MapFeature\MarkerInfoBubble

Expanded class hierarchy of MarkerInfoBubble

File

modules/geolocation_google_maps/src/Plugin/geolocation/MapFeature/MarkerInfoBubble.php, line 18

Namespace

Drupal\geolocation_google_maps\Plugin\geolocation\MapFeature

View source

class MarkerInfoBubble extends MapFeatureBase {

  /**
   * {@inheritdoc}
   */
  public static function getDefaultSettings() {
    return [
      'close_button' => FALSE,
      'close_other' => TRUE,
      'close_button_src' => '',
      'shadow_style' => 0,
      'padding' => 10,
      'border_radius' => 8,
      'border_width' => 2,
      'border_color' => '#039be5',
      'background_color' => '#fff',
      'min_width' => '',
      'max_width' => '550',
      'min_height' => '',
      'max_height' => '',
      'arrow_style' => 2,
      'arrow_position' => 30,
      'arrow_size' => 10,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getSettingsForm(array $settings, array $parents) {
    $form['close_button'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show a close button in the right upper corner of the infobubble'),
      '#description' => $this
        ->t('This button closes the tooltip.'),
      '#default_value' => $settings['close_button'],
    ];
    $form['close_other'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Close other infobubbles when opening this one'),
      '#description' => $this
        ->t('Before opening this infobubble closes the others'),
      '#default_value' => $settings['close_other'],
    ];
    $form['close_button_src'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('URL for the close button'),
      '#description' => $this
        ->t('A 12x12 pixel image'),
      '#default_value' => $settings['close_button_src'],
    ];
    $form['shadow_style'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Change shadow style'),
      '#description' => $this
        ->t('Allow the user to switch the shadow style'),
      '#default_value' => $settings['shadow_style'],
    ];
    $form['padding'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Padding'),
      '#description' => $this
        ->t('Change padding.'),
      '#default_value' => $settings['padding'],
    ];
    $form['border_radius'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Border radius'),
      '#description' => $this
        ->t('Change border radius'),
      '#default_value' => $settings['border_radius'],
    ];
    $form['border_width'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Border width'),
      '#description' => $this
        ->t('Change border width.'),
      '#default_value' => $settings['border_width'],
    ];
    $form['border_color'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Border color'),
      '#description' => $this
        ->t('Change border color.'),
      '#default_value' => $settings['border_color'],
    ];
    $form['background_color'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Background color'),
      '#description' => $this
        ->t('Change background color.'),
      '#default_value' => $settings['background_color'],
    ];
    $form['min_width'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Minimum width'),
      '#description' => $this
        ->t('Change Minimum width.'),
      '#default_value' => $settings['min_width'],
    ];
    $form['max_width'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Maximum width'),
      '#description' => $this
        ->t('Change maximum width.'),
      '#default_value' => $settings['max_width'],
    ];
    $form['min_height'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Minimum height'),
      '#description' => $this
        ->t('Change minimum height.'),
      '#default_value' => $settings['min_height'],
    ];
    $form['max_height'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Maximum height'),
      '#description' => $this
        ->t('Change maximum height.'),
      '#default_value' => $settings['max_height'],
    ];
    $form['arrow_style'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Arrow style'),
      '#options' => [
        '0' => $this
          ->t('0 - middle'),
        '1' => $this
          ->t('1 - left'),
        '2' => $this
          ->t('2 - right'),
      ],
      '#default_value' => $settings['arrow_style'],
      '#description' => $this
        ->t('Select the arrow style of the infobubble.'),
    ];
    $form['arrow_position'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Arrow position'),
      '#description' => $this
        ->t('Horizontal position in %.'),
      '#default_value' => $settings['arrow_position'],
      '#field_suffix' => '%',
    ];
    $form['arrow_size'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Arrow height'),
      '#description' => $this
        ->t('Change arrow height in px.'),
      '#default_value' => $settings['arrow_size'],
      '#field_suffix' => 'px',
    ];
    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_google_maps/mapfeature.' . $this
          ->getPluginId(),
      ],
      'drupalSettings' => [
        'geolocation' => [
          'maps' => [
            $render_array['#id'] => [
              $this
                ->getPluginId() => [
                'enable' => TRUE,
                'closeButton' => $feature_settings['close_button'],
                'closeOther' => $feature_settings['close_other'],
                'closeButtonSrc' => $feature_settings['close_button_src'],
                'shadowStyle' => $feature_settings['shadow_style'],
                'padding' => $feature_settings['padding'],
                'borderRadius' => $feature_settings['border_radius'],
                'borderWidth' => $feature_settings['border_width'],
                'borderColor' => $feature_settings['border_color'],
                'backgroundColor' => $feature_settings['background_color'],
                'minWidth' => $feature_settings['min_width'],
                'maxWidth' => $feature_settings['max_width'],
                'minHeight' => $feature_settings['min_height'],
                'maxHeight' => $feature_settings['max_height'],
                'arrowStyle' => $feature_settings['arrow_style'],
                'arrowPosition' => $feature_settings['arrow_position'],
                'arrowSize' => $feature_settings['arrow_size'],
              ],
            ],
          ],
        ],
      ],
    ]);
    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
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
MarkerInfoBubble::alterMap	public	function	Alter render array. Overrides MapFeatureBase::alterMap
MarkerInfoBubble::getDefaultSettings	public static	function	Provide a populated settings array. Overrides MapFeatureBase::getDefaultSettings
MarkerInfoBubble::getSettingsForm	public	function	Provide a generic map settings form array. Overrides MapFeatureBase::getSettingsForm
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.

You are here

class MarkerInfoBubble in Geolocation Field 8.3

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation